xref: /AOO41X/main/offapi/com/sun/star/awt/XMessageBoxFactory.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_awt_XMessageBoxFactory_idl__
29#define __com_sun_star_awt_XMessageBoxFactory_idl__
30
31#ifndef __com_sun_star_awt_XWindowPeer_idl__
32#include <com/sun/star/awt/XWindowPeer.idl>
33#endif
34
35#ifndef __com_sun_star_awt_XMessageBox_idl__
36#include <com/sun/star/awt/XMessageBox.idl>
37#endif
38
39#ifndef __com_sun_star_awt_MessageBoxButtons_idl__
40#include <com/sun/star/awt/MessageBoxButtons.idl>
41#endif
42
43#ifndef __com_sun_star_awt_Rectangle_idl__
44#include <com/sun/star/awt/Rectangle.idl>
45#endif
46
47
48//=============================================================================
49
50module com { module sun { module star { module awt {
51
52//=============================================================================
53
54/** specifies a factory interface for creating message boxes.
55 */
56published interface XMessageBoxFactory : com::sun::star::uno::XInterface
57{
58	//-------------------------------------------------------------------------
59
60	/** creates a message box.
61
62        @returns
63		the created message box or a null reference if it cannot be
64        created.
65
66		@param aParent
67		a valid XWindowPeer reference which is used as a parent. This parameter
68        must not be null.
69
70		@param aPosSize
71        a rectangle which defines the position and size of the message
72        box in pixel.
73
74        @param aType
75        a string which determines the message box type.
76        The following strings are defined.
77        <ul>
78            <li><b>infobox</b>A message box to inform the user about a certain event.
79                <b>Attention:</b><br/>This type of message box ignores the argument
80                aButton because a info box always shows a OK button.
81            </li>
82            <li><b>warningbox</b>A message to warn the user about a certain problem.</li>
83            <li><b>errorbox</b>A message box to provide an error message to the user.</li>
84            <li><b>querybox</b>A message box to query information from the user.</li>
85            <li><b>messbox</b>A normal message box.</li>
86        </ul>
87
88        @param aButtons
89		specifies which buttons should be available on the
90        message box. A combination of
91        <type scope="com::sun::star::awt">MessageBoxButtons</type>. An <b>infobox</b>
92        ignores this paramter and always use button "OK".
93
94		@param aTitle
95		specifies the title of the message box.
96
97        @param aMessage
98        specifies text which will be shown by the message box.
99        Line-breaks must be added using 'CR' or 'CR+LF'.
100	*/
101    XMessageBox createMessageBox( [in] com::sun::star::awt::XWindowPeer aParent, [in] com::sun::star::awt::Rectangle aPosSize, [in] string aType, [in] long aButtons, [in] string aTitle, [in] string aMessage );
102};
103
104//=============================================================================
105
106}; }; }; };
107
108#endif
109