offapi/com/sun/star/awt/XMessageBoxFactory.idl

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