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