summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XMessageBoxFactory.idl
blob: 1bef4766f8a3a720d7ba19b610ed31355a42a64d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_awt_XMessageBoxFactory_idl__
#define __com_sun_star_awt_XMessageBoxFactory_idl__

#include <com/sun/star/awt/XWindowPeer.idl>
#include <com/sun/star/awt/XMessageBox.idl>
#include <com/sun/star/awt/MessageBoxButtons.idl>
#include <com/sun/star/awt/Rectangle.idl>



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
        com::sun::star::awt::MessageBoxButtons. An <b>infobox</b>
        ignores this parameter 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */