offapi/com/sun/star/awt/UnoControlListBoxModel.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_UnoControlListBoxModel_idl__
  29 #define __com_sun_star_awt_UnoControlListBoxModel_idl__
  30
  31 #include <com/sun/star/awt/FontDescriptor.idl>
  32 #include <com/sun/star/awt/UnoControlModel.idl>
  33 #include <com/sun/star/util/Color.idl>
  34 #include <com/sun/star/awt/XItemList.idl>
  35
  36 //=============================================================================
  37
  38  module com {  module sun {  module star {  module awt {
  39
  40 //=============================================================================
  41
  42 /** specifies the standard model of an <type>UnoControlListBox</type>.
  43  */
  44 published service UnoControlListBoxModel
  45 {
  46     service com::sun::star::awt::UnoControlModel;
  47
  48     //-------------------------------------------------------------------------
  49
  50     /** specifies the horizontal alignment of the text in the control.
  51
  52         <pre>
  53         0: left
  54         1: center
  55         2: right
  56         </pre>
  57      */
  58     [optional, property] short Align;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** specifies the background color (RGB) of the control.
  63      */
  64     [property] com::sun::star::util::Color BackgroundColor;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** specifies the border style of the control.
  69
  70         <pre>
  71         0: No border
  72         1: 3D border
  73         2: simple border
  74         </pre>
  75      */
  76     [property] short Border;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies the color of the border, if present
  81
  82         <p>Not every border style (see <member>Border</member>) may support coloring.
  83         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  84
  85         @since OOo 2.0
  86      */
  87     [optional, property] long BorderColor;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies if the control has a drop down button.
  92      */
  93     [property] boolean Dropdown;
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** determines whether the control is enabled or disabled.
  98      */
  99     [property] boolean Enabled;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** specifies the font attributes of the text in the control.
 104      */
 105     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 110         value of the text in the control.
 111      */
 112     [property] short FontEmphasisMark;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 117         value of the text in the control.
 118      */
 119     [property] short FontRelief;
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** specifies the help text of the control.
 124      */
 125     [property] string HelpText;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** specifies the help URL of the control.
 130      */
 131     [property] string HelpURL;
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** specifies the maximum line count displayed in the drop down box.
 136      */
 137     [property] short LineCount;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** specifies if more than one entry can be selected.
 142      */
 143     [property] boolean MultiSelection;
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** specifies that the control will be printed with the document.
 148      */
 149     [property] boolean Printable;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** specifies that the content of the control cannot be modified by the user.
 154      */
 155     [property] boolean ReadOnly;
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** specifies the sequence of selected items, identified by the position.
 160      */
 161     [property] sequence<short> SelectedItems;
 162
 163     //-------------------------------------------------------------------------
 164
 165     /** specifies the list of items.
 166      */
 167     [property] sequence<string> StringItemList;
 168
 169     //-------------------------------------------------------------------------
 170
 171     /** specifies that the control can be reached with the TAB key.
 172      */
 173     [property] boolean Tabstop;
 174
 175     //-------------------------------------------------------------------------
 176
 177     /** specifies the text color (RGB) of the control.
 178      */
 179     [property] com::sun::star::util::Color TextColor;
 180
 181     //-------------------------------------------------------------------------
 182
 183     /** specifies the text line color (RGB) of the control.
 184      */
 185     [property] com::sun::star::util::Color TextLineColor;
 186
 187     /** denotes the writing mode used in the control, as specified in the
 188         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 189
 190         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 191         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 192
 193         @since OOo 3.1
 194     */
 195     [optional, property] short WritingMode;
 196
 197     /** defines how the mouse wheel can be used to scroll through the control's content.
 198
 199         <p>Usually, the mouse wheel scroll through the control's entry list. Using this property,
 200         and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
 201         this is possible.</p>
 202     */
 203     [optional, property] short MouseWheelBehavior;
 204
 205     /** allows manipulating the list of items in the list box more fine-grained than the
 206         <member>StringItemList</member> property.
 207
 208         @since OOo 3.3
 209     */
 210     [optional] interface XItemList;
 211
 212     /** specifies where an item separator - a horizontal line - is drawn.
 213
 214         <p>If this is not <NULL/>, then a horizontal line will be drawn between the item at the given position,
 215         and the following item.</p>
 216
 217         @since OOo 3.3
 218     */
 219     [optional, property, maybevoid] short ItemSeparatorPos;
 220 };
 221
 222 //=============================================================================
 223
 224 }; }; }; };
 225
 226 #endif
 227
 228 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */