xref: /trunk/main/offapi/com/sun/star/awt/XMessageBoxFactory.idl (revision a893be29343ee97512d484e6e8fefa91df2b44cb)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22cdf0e10cSrcweir#ifndef __com_sun_star_awt_XMessageBoxFactory_idl__
23cdf0e10cSrcweir#define __com_sun_star_awt_XMessageBoxFactory_idl__
24cdf0e10cSrcweir
25cdf0e10cSrcweir#include <com/sun/star/awt/XWindowPeer.idl>
26cdf0e10cSrcweir#include <com/sun/star/awt/XMessageBox.idl>
27cdf0e10cSrcweir#include <com/sun/star/awt/MessageBoxButtons.idl>
2861161268SAriel Constenla-Haile#include <com/sun/star/awt/MessageBoxType.idl>
29cdf0e10cSrcweir
30cdf0e10cSrcweirmodule com { module sun { module star { module awt {
31cdf0e10cSrcweir
32cdf0e10cSrcweir/** specifies a factory interface for creating message boxes.
33cdf0e10cSrcweir */
34cdf0e10cSrcweirpublished interface XMessageBoxFactory : com::sun::star::uno::XInterface
35cdf0e10cSrcweir{
36cdf0e10cSrcweir    /** creates a message box.
37cdf0e10cSrcweir
38cdf0e10cSrcweir        @returns
39cdf0e10cSrcweir            the created message box or a null reference if it cannot be
40cdf0e10cSrcweir            created.
41cdf0e10cSrcweir
42cdf0e10cSrcweir        @param aParent
4361161268SAriel Constenla-Haile            a valid XWindowPeer reference which is used as a parent.
44cdf0e10cSrcweir
4561161268SAriel Constenla-Haile            <p>This parameter must not be null.</p>
46cdf0e10cSrcweir
47cdf0e10cSrcweir        @param aType
4861161268SAriel Constenla-Haile            the message box type.
49cdf0e10cSrcweir
50cdf0e10cSrcweir        @param aButtons
5161161268SAriel Constenla-Haile            specifies which buttons should be available on the message box.
5261161268SAriel Constenla-Haile
5361161268SAriel Constenla-Haile            <p>A combination of <type>MessageBoxButtons</type>.</p>
5461161268SAriel Constenla-Haile            <p>A <member scope="com::sun::star::awt">MessageBoxType::INFOBOX</member>
55*a893be29SPedro Giffuni            ignores this parameter, instead it uses a
5661161268SAriel Constenla-Haile            <member scope="com::sun::star::awt">MessageBoxButtons::BUTTONS_OK</member>.</p>
57cdf0e10cSrcweir
58cdf0e10cSrcweir        @param aTitle
59cdf0e10cSrcweir                specifies the title of the message box.
60cdf0e10cSrcweir
61cdf0e10cSrcweir        @param aMessage
62cdf0e10cSrcweir            specifies text which will be shown by the message box.
63cdf0e10cSrcweir            Line-breaks must be added using 'CR' or 'CR+LF'.
64cdf0e10cSrcweir    */
6561161268SAriel Constenla-Haile    XMessageBox createMessageBox( [in] com::sun::star::awt::XWindowPeer aParent,
6661161268SAriel Constenla-Haile                                  [in] MessageBoxType eType,
6761161268SAriel Constenla-Haile                                  [in] long nButtons,
6861161268SAriel Constenla-Haile                                  [in] string sTitle,
6961161268SAriel Constenla-Haile                                  [in] string sMessage );
70cdf0e10cSrcweir};
71cdf0e10cSrcweir
72cdf0e10cSrcweir}; }; }; };
73cdf0e10cSrcweir
74cdf0e10cSrcweir#endif
75