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

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