LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XMessageBoxFactory Interface Referencepublished

specifies a factory interface for creating message boxes. More...

import"XMessageBoxFactory.idl";

Inheritance diagram for XMessageBoxFactory:
XInterface XToolkit2 Toolkit XToolkitExperimental

Public Member Functions

XMessageBox createMessageBox ([in] com::sun::star::awt::XWindowPeer aParent, [in] MessageBoxType eType, [in] long nButtons, [in] string sTitle, [in] string sMessage)
 creates a message box. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

specifies a factory interface for creating message boxes.

Member Function Documentation

XMessageBox createMessageBox ( [in] com::sun::star::awt::XWindowPeer  aParent,
[in] MessageBoxType  eType,
[in] long  nButtons,
[in] string  sTitle,
[in] string  sMessage 
)

creates a message box.

Returns
the created message box or a null reference if it cannot be created.
Parameters
aParenta valid XWindowPeer reference which is used as a parent.

This parameter must not be null.

Parameters
eTypethe message box type.
nButtonsspecifies which buttons should be available on the message box.

A combination of com::sun::star::awt::MessageBoxButtons

A com::sun::star::awt::MessageBoxType::INFOBOX ignores this parameter, instead it uses a com::sun::star::awt::MessageBoxButtons::BUTTONS_OK.

Parameters
sTitlespecifies the title of the message box.
sMessagespecifies text which will be shown by the message box. Line-breaks must be added using 'CR' or 'CR+LF'.

The documentation for this interface was generated from the following file: