summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XUnoControlDialogModel.idl
blob: 9032a37b582d4b2bd4b2a7c35547acc78b56dffe (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/* -*- 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_XUnoControlDialogModel_idl__
#define __com_sun_star_awt_XUnoControlDialogModel_idl__

#include <com/sun/star/awt/FontDescriptor.idl>
#include <com/sun/star/awt/XControlModel.idl>
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/container/XContainer.idl>
#include <com/sun/star/container/XNameContainer.idl>

#include <com/sun/star/lang/XMultiServiceFactory.idl>
#include <com/sun/star/util/Color.idl>
#include <com/sun/star/graphic/XGraphic.idl>


module com {  module sun {  module star {  module awt {


/**
    Unified interface for the UnoControlDialogModel service.

    @since LibreOffice 4.1
 */
published interface XUnoControlDialogModel
{
    interface com::sun::star::awt::XControlModel;

    /** allows to create control models, which support the
        <type>UnoControlDialogElement</type> service and can be inserted into
        this container.
     */
    interface com::sun::star::lang::XMultiServiceFactory;

    interface com::sun::star::beans::XPropertySet;

    interface com::sun::star::container::XNameContainer; // -> XNameReplace -> XNameAccess -> XElementAccess

    [attribute] string Name;

    [attribute] boolean Decoration;

    [attribute] long PositionX;

    [attribute] long PositionY;

    [attribute] long Width;

    [attribute] long Height;

    [attribute] string DialogSourceURL;

    /** specifies the text that is displayed in the caption bar of the dialog.
     */
    [attribute] string Title;

    /** specifies if the dialog is closeable.
     */
    [attribute] boolean Closeable;

    /** determines whether a dialog is enabled or disabled.
     */
    [attribute] boolean Enabled;

    /** specifies if the dialog is moveable.
     */
    [attribute] boolean Moveable;

    /** specifies if the dialog is sizeable.
     */
    [attribute] boolean Sizeable;

    /** If set to true the dialog will have the desktop as parent.

        @since OOo 2.3
     */
    [attribute] boolean DesktopAsParent;

    /** specifies the help URL of the dialog.
     */
    [attribute] string HelpURL;


    /** specifies the background color (RGB) of the dialog.
     */
    [attribute] com::sun::star::util::Color BackgroundColor;


    /** specifies the font attributes of the text in the caption bar of the dialog.
     */
    [attribute] com::sun::star::awt::FontDescriptor FontDescriptor;


    /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
        value of the text in the caption bar of the dialog.
     */
    [attribute] short FontEmphasisMark;


    /** specifies the <type scope="com::sun::star::text">FontRelief</type>
        value of the text in the caption bar of the dialog.
     */
    [attribute] short FontRelief;


    /** specifies the help text of the dialog.
     */
    [attribute] string HelpText;


    /** specifies the text color (RGB) of the dialog.
     */
    [attribute] com::sun::star::util::Color TextColor;


    /** specifies the text line color (RGB) of the dialog.
     */
    [attribute] com::sun::star::util::Color TextLineColor;

    /** specifies a URL that references a graphic that should be used as a
        background image.
            @see Graphic

        @since OOo 2.4
    */
    [attribute] string ImageURL;

    /** specifies a graphic to be displayed as a background image

        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
        following way:
        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
            does not point to a valid image file.</li>
            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
            to an empty string.</li>
        </ul></p>

        @since OOo 2.4
     */
    [attribute] com::sun::star::graphic::XGraphic Graphic;

};


}; }; }; };

#endif

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