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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_UnoControlComboBoxModel_idl__
  29 #define __com_sun_star_awt_UnoControlComboBoxModel_idl__
  30
  31 #include <com/sun/star/awt/FontDescriptor.idl>
  32 #include <com/sun/star/awt/UnoControlModel.idl>
  33
  34 #include <com/sun/star/util/Color.idl>
  35
  36 #include <com/sun/star/awt/XItemList.idl>
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** specifies the standard model of an <type>UnoControlComboBox</type>.
  45  */
  46 published service UnoControlComboBoxModel
  47 {
  48     service com::sun::star::awt::UnoControlModel;
  49
  50     //-------------------------------------------------------------------------
  51
  52     /** specifies the horizontal alignment of the text in the control.
  53
  54         <pre>
  55         0: left
  56         1: center
  57         2: right
  58         </pre>
  59      */
  60     [optional, property] short Align;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** specifies whether automatic completion of text is enabled.
  65      */
  66     [property] boolean Autocomplete;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** specifies the background color (RGB) of the control.
  71      */
  72     [property] com::sun::star::util::Color BackgroundColor;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** specifies the border style of the control.
  77
  78         <pre>
  79         0: No border
  80         1: 3D border
  81         2: simple border
  82         </pre>
  83      */
  84     [property] short Border;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** specifies the color of the border, if present
  89
  90         <p>Not every border style (see <member>Border</member>) may support coloring.
  91         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  92
  93         @since OOo 2.0
  94      */
  95     [optional, property] long BorderColor;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** specifies if the control has a drop down button.
 100      */
 101     [property] boolean Dropdown;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** determines whether the control is enabled or disabled.
 106      */
 107     [property] boolean Enabled;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** specifies the font attributes of the text in the control.
 112      */
 113     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 118         value of the text in the control.
 119      */
 120     [property] short FontEmphasisMark;
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 125         value of the text in the control.
 126      */
 127     [property] short FontRelief;
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** specifies the help text of the control.
 132      */
 133     [property] string HelpText;
 134
 135     //-------------------------------------------------------------------------
 136
 137     /** specifies the help URL of the control.
 138      */
 139     [property] string HelpURL;
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** specifies whether the selection in the control should be hidden when
 144         the control is not active (focused).
 145
 146         @since OOo 2.0
 147      */
 148     [optional, property] boolean HideInactiveSelection;
 149
 150     //-------------------------------------------------------------------------
 151
 152     /** specifies the maximum line count displayed in the drop down box.
 153      */
 154     [property] short LineCount;
 155
 156     //-------------------------------------------------------------------------
 157
 158     /** specifies the maximum character count.
 159
 160         <p>There's no limitation, if set to 0.</p>
 161      */
 162     [property] short MaxTextLen;
 163
 164     //-------------------------------------------------------------------------
 165
 166     /** specifies that the control will be printed with the document.
 167      */
 168     [property] boolean Printable;
 169
 170     //-------------------------------------------------------------------------
 171
 172     /** specifies that the content of the control cannot be modified by the user.
 173      */
 174     [property] boolean ReadOnly;
 175
 176     //-------------------------------------------------------------------------
 177
 178     /** specifies the list of items.
 179      */
 180     [property] sequence<string> StringItemList;
 181
 182     //-------------------------------------------------------------------------
 183
 184     /** specifies that the control can be reached with the TAB key.
 185      */
 186     [property] boolean Tabstop;
 187
 188     //-------------------------------------------------------------------------
 189
 190     /** specifies the text displayed in the control.
 191      */
 192     [property] string Text;
 193
 194     //-------------------------------------------------------------------------
 195
 196     /** specifies the text color (RGB) of the control.
 197      */
 198     [property] com::sun::star::util::Color TextColor;
 199
 200     //-------------------------------------------------------------------------
 201
 202     /** specifies the text line color (RGB) of the control.
 203      */
 204     [property] com::sun::star::util::Color TextLineColor;
 205
 206     /** denotes the writing mode used in the control, as specified in the
 207         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 208
 209         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 210         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 211
 212         @since OOo 3.1
 213     */
 214     [optional, property] short WritingMode;
 215
 216     /** defines how the mouse wheel can be used to scroll through the control's content.
 217
 218         <p>Usually, the mouse wheel scroll through the control's entry list. Using this property,
 219         and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
 220         this is possible.</p>
 221     */
 222     [optional, property] short MouseWheelBehavior;
 223
 224     /** allows manipulating the list of items in the combo box more fine-grained than the
 225         <member>StringItemList</member> property.
 226     */
 227     [optional] interface XItemList;
 228 };
 229
 230 //=============================================================================
 231
 232 }; }; }; };
 233
 234 #endif
 235
 236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */