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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module awt {
  21
  22 /** specifies a factory interface for creating message boxes.
  23  */
  24 published interface XMessageBoxFactory : com::sun::star::uno::XInterface
  25 {
  26     /** creates a message box.
  27
  28         @returns
  29             the created message box or a null reference if it cannot be
  30             created.
  31
  32         @param aParent
  33             a valid XWindowPeer reference which is used as a parent.
  34
  35             <p>This parameter must not be null.</p>
  36
  37         @param eType
  38             the message box type.
  39
  40         @param nButtons
  41             specifies which buttons should be available on the message box.
  42
  43             <p>A combination of com::sun::star::awt::MessageBoxButtons</p>
  44             <p>A com::sun::star::awt::MessageBoxType::INFOBOX
  45             ignores this parameter, instead it uses a
  46             com::sun::star::awt::MessageBoxButtons::BUTTONS_OK.</p>
  47
  48         @param sTitle
  49                 specifies the title of the message box.
  50
  51         @param sMessage
  52             specifies text which will be shown by the message box.
  53             Line-breaks must be added using 'CR' or 'CR+LF'.
  54     */
  55     XMessageBox createMessageBox( [in] com::sun::star::awt::XWindowPeer aParent,
  56                                   [in] MessageBoxType eType,
  57                                   [in] long nButtons,
  58                                   [in] string sTitle,
  59                                   [in] string sMessage );
  60 };
  61
  62 }; }; }; };
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */