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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_UnoControlComboBoxModel_idl__
  20 #define __com_sun_star_awt_UnoControlComboBoxModel_idl__
  21
  22 #include <com/sun/star/awt/FontDescriptor.idl>
  23 #include <com/sun/star/awt/UnoControlModel.idl>
  24
  25 #include <com/sun/star/util/Color.idl>
  26
  27 #include <com/sun/star/awt/XItemList.idl>
  28
  29
  30  module com {  module sun {  module star {  module awt {
  31
  32
  33 /** specifies the standard model of an <type>UnoControlComboBox</type>.
  34  */
  35 published service UnoControlComboBoxModel
  36 {
  37     service com::sun::star::awt::UnoControlModel;
  38
  39
  40     /** specifies the horizontal alignment of the text in the control.
  41
  42         <pre>
  43         0: left
  44         1: center
  45         2: right
  46         </pre>
  47      */
  48     [optional, property] short Align;
  49
  50
  51     /** specifies whether automatic completion of text is enabled.
  52      */
  53     [property] boolean Autocomplete;
  54
  55
  56     /** specifies the background color (RGB) of the control.
  57      */
  58     [property] com::sun::star::util::Color BackgroundColor;
  59
  60
  61     /** specifies the border style of the control.
  62
  63         <pre>
  64         0: No border
  65         1: 3D border
  66         2: simple border
  67         </pre>
  68      */
  69     [property] short Border;
  70
  71
  72     /** specifies the color of the border, if present
  73
  74         <p>Not every border style (see <member>Border</member>) may support coloring.
  75         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  76
  77         @since OOo 2.0
  78      */
  79     [optional, property] long BorderColor;
  80
  81
  82     /** specifies if the control has a drop down button.
  83      */
  84     [property] boolean Dropdown;
  85
  86
  87     /** determines whether the control is enabled or disabled.
  88      */
  89     [property] boolean Enabled;
  90
  91
  92     /** specifies the font attributes of the text in the control.
  93      */
  94     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  95
  96
  97     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
  98         value of the text in the control.
  99      */
 100     [property] short FontEmphasisMark;
 101
 102
 103     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 104         value of the text in the control.
 105      */
 106     [property] short FontRelief;
 107
 108
 109     /** specifies the help text of the control.
 110      */
 111     [property] string HelpText;
 112
 113
 114     /** specifies the help URL of the control.
 115      */
 116     [property] string HelpURL;
 117
 118
 119     /** specifies whether the selection in the control should be hidden when
 120         the control is not active (focused).
 121
 122         @since OOo 2.0
 123      */
 124     [optional, property] boolean HideInactiveSelection;
 125
 126
 127     /** specifies the maximum line count displayed in the drop down box.
 128      */
 129     [property] short LineCount;
 130
 131
 132     /** specifies the maximum character count.
 133
 134         <p>There's no limitation, if set to 0.</p>
 135      */
 136     [property] short MaxTextLen;
 137
 138
 139     /** specifies that the control will be printed with the document.
 140      */
 141     [property] boolean Printable;
 142
 143
 144     /** specifies that the content of the control cannot be modified by the user.
 145      */
 146     [property] boolean ReadOnly;
 147
 148
 149     /** specifies the list of items.
 150      */
 151     [property] sequence<string> StringItemList;
 152
 153
 154     /** specifies that the control can be reached with the TAB key.
 155      */
 156     [property] boolean Tabstop;
 157
 158
 159     /** specifies the text displayed in the control.
 160      */
 161     [property] string Text;
 162
 163
 164     /** specifies the text color (RGB) of the control.
 165      */
 166     [property] com::sun::star::util::Color TextColor;
 167
 168
 169     /** specifies the text line color (RGB) of the control.
 170      */
 171     [property] com::sun::star::util::Color TextLineColor;
 172
 173     /** denotes the writing mode used in the control, as specified in the
 174         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 175
 176         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 177         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 178
 179         @since OOo 3.1
 180     */
 181     [optional, property] short WritingMode;
 182
 183     /** defines how the mouse wheel can be used to scroll through the control's content.
 184
 185         <p>Usually, the mouse wheel scroll through the control's entry list. Using this property,
 186         and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
 187         this is possible.</p>
 188     */
 189     [optional, property] short MouseWheelBehavior;
 190
 191     /** allows manipulating the list of items in the combo box more fine-grained than the
 192         <member>StringItemList</member> property.
 193     */
 194     [optional] interface XItemList;
 195 };
 196
 197
 198 }; }; }; };
 199
 200 #endif
 201
 202 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */