summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/UnoControlImageControlModel.idl
blob: 310039d1a86590edb329400207ebab135bc66c8b (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
/* -*- 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_UnoControlImageControlModel_idl__
#define __com_sun_star_awt_UnoControlImageControlModel_idl__

#include <com/sun/star/awt/UnoControlModel.idl>
#include <com/sun/star/util/Color.idl>
#include <com/sun/star/graphic/XGraphic.idl>



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


/** specifies the standard model of a UnoControlImageControl.
 */
published service UnoControlImageControlModel
{
    service com::sun::star::awt::UnoControlModel;


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


    /** specifies the border style of the control.

        <pre>
        0: No border
        1: 3D border
        2: simple border
        </pre>
     */
    [property] short Border;


    /** specifies the color of the border, if present

        <p>Not every border style (see #Border) may support coloring.
        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>

        @since OOo 2.0
     */
    [optional, property] long BorderColor;


    /** determines whether the control is enabled or disabled.
     */
    [property] boolean Enabled;


    /** specifies the help text of the control.
     */
    [property] string HelpText;


    /** specifies the help URL of the control.
     */
    [property] string HelpURL;


    /** specifies a URL to an image to use for the control.
        @see Graphic
     */
    [property] string ImageURL;


    /** specifies a graphic to be displayed on the control

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

        @since OOo 2.1
     */
    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;


    /** specifies that the control will be printed with the document.
     */
    [property] boolean Printable;


    /** specifies if the image is automatically scaled to the size of the
        control.
     */
    [property] boolean ScaleImage;

    /** defines how to scale the image

        <p>If this property is present, it supersedes the #ScaleImage property.</p>

        <p>The value of this property is one of the ImageScaleMode constants.</p>

        @since OOo 3.1
    */
    [property, optional] short ScaleMode;


    /** specifies that the control can be reached with the TAB key.

        @since OOo 1.1.2
     */
    [optional, property] boolean Tabstop;

};


}; }; }; };

#endif

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