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