diff options
Diffstat (limited to 'offapi/com/sun/star/awt/XMessageBoxFactory.idl')
-rw-r--r-- | offapi/com/sun/star/awt/XMessageBoxFactory.idl | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/XMessageBoxFactory.idl b/offapi/com/sun/star/awt/XMessageBoxFactory.idl new file mode 100644 index 000000000000..67898a19f17a --- /dev/null +++ b/offapi/com/sun/star/awt/XMessageBoxFactory.idl @@ -0,0 +1,108 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_awt_XMessageBoxFactory_idl__ +#define __com_sun_star_awt_XMessageBoxFactory_idl__ + +#ifndef __com_sun_star_awt_XWindowPeer_idl__ +#include <com/sun/star/awt/XWindowPeer.idl> +#endif + +#ifndef __com_sun_star_awt_XMessageBox_idl__ +#include <com/sun/star/awt/XMessageBox.idl> +#endif + +#ifndef __com_sun_star_awt_MessageBoxButtons_idl__ +#include <com/sun/star/awt/MessageBoxButtons.idl> +#endif + +#ifndef __com_sun_star_awt_Rectangle_idl__ +#include <com/sun/star/awt/Rectangle.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module awt { + +//============================================================================= + +/** specifies a factory interface for creating message boxes. + */ +published interface XMessageBoxFactory : com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + /** creates a message box. + + @returns + the created message box or a null reference if it cannot be + created. + + @param aParent + a valid XWindowPeer reference which is used as a parent. This parameter + must not be null. + + @param aPosSize + a rectangle which defines the position and size of the message + box in pixel. + + @param aType + a string which determines the message box type. + The following strings are defined. + <ul> + <li><b>infobox</b>A message box to inform the user about a certain event. + <b>Attention:</b><br/>This type of message box ignores the argument + aButton because a info box always shows a OK button. + </li> + <li><b>warningbox</b>A message to warn the user about a certain problem.</li> + <li><b>errorbox</b>A message box to provide an error message to the user.</li> + <li><b>querybox</b>A message box to query information from the user.</li> + <li><b>messbox</b>A normal message box.</li> + </ul> + + @param aButtons + specifies which buttons should be available on the + message box. A combination of + <type scope="com::sun::star::awt">MessageBoxButtons</type>. An <b>infobox</b> + ignores this paramter and always use button "OK". + + @param aTitle + specifies the title of the message box. + + @param aMessage + specifies text which will be shown by the message box. + Line-breaks must be added using 'CR' or 'CR+LF'. + */ + 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 ); +}; + +//============================================================================= + +}; }; }; }; + +#endif |