1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_inspection_PropertyControlType_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_inspection_PropertyControlType_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski//============================================================================= 28*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module inspection { 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//----------------------------------------------------------------------------- 31*b1cdbd2cSJim Jagielski/** describes pre-defined possible control types to be used to display and enter 32*b1cdbd2cSJim Jagielski property values within a <type>ObjectInspector</type>. 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski <p>The type of a control determines its visual appearance, its behaviour, and - important 35*b1cdbd2cSJim Jagielski for property handlers using a control - the expected type when reading and writing the 36*b1cdbd2cSJim Jagielski control's value.</p> 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski @see XPropertyControl 39*b1cdbd2cSJim Jagielski @see XPropertyControlFactory 40*b1cdbd2cSJim Jagielski @see XPropertyControl::ValueType 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski @since OpenOffice 2.0.3 43*b1cdbd2cSJim Jagielski*/ 44*b1cdbd2cSJim Jagielskipublished constants PropertyControlType 45*b1cdbd2cSJim Jagielski{ 46*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to choose from a list of 47*b1cdbd2cSJim Jagielski possible property values 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski <p>Controls of type <member>ListBox</member> exchange their values as <code>string</code>.</p> 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski <p>Additionally, those controls support the <type>XStringListControl</type> interface.</p> 52*b1cdbd2cSJim Jagielski */ 53*b1cdbd2cSJim Jagielski const short ListBox = 1; 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to choose from a list of 56*b1cdbd2cSJim Jagielski possible property values, combined with the possibility to enter a new 57*b1cdbd2cSJim Jagielski property value. 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski <p>Controls of type <member>ComboBox</member> exchange their values as <code>string</code>.</p> 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski <p>Additionally, those controls support the <type>XStringListControl</type> interface.</p> 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielski const short ComboBox = 2; 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter property values consisting of a single line of text 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski <p>Controls of type <member>TextField</member> exchange their values as <code>string</code>.</p> 68*b1cdbd2cSJim Jagielski */ 69*b1cdbd2cSJim Jagielski const short TextField = 3; 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter pure text, including line breaks 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski <p>Controls of type <member>MultiLineTextField</member> exchange their values as <code>string</code>.</p> 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski const short MultiLineTextField = 4; 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter a single character 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski <p>Controls of type <member>CharacterField</member> exchange their values as <code>short</code>, 80*b1cdbd2cSJim Jagielski being a single UTF-16 character.</p> 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski const short CharacterField = 5; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter a list of single-line strings 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski <p>Controls of type <member>StringListField</member> exchange their values as <code>sequence< string ><code>.</p> 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski const short StringListField = 6; 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to choose from a list of colors. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski <p>Controls of type <member>ColorListBox</member> usually exchange their values as 93*b1cdbd2cSJim Jagielski <type scope="com::sun::star::util">Color</type>.</p> 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski <p>Additionally, those controls support the <type>XStringListControl</type> interface. If you use 96*b1cdbd2cSJim Jagielski this interface to add additional entries to the list box, which have no color associated with it, 97*b1cdbd2cSJim Jagielski then you can also exchange values as <code>string</code>. That is, if you write a string into 98*b1cdbd2cSJim Jagielski <member>XPropertyControl::Value</member>, and if this string has previously been added to the list 99*b1cdbd2cSJim Jagielski using the <type>XStringListControl</type> interface, this string is selected. Vice versa, if the user 100*b1cdbd2cSJim Jagielski selects one of those non-color strings in the list, then reading <member>XPropertyControl::Value</member> 101*b1cdbd2cSJim Jagielski will retrieve you this stting.</p> 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski const short ColorListBox = 7; 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter a numerical value 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski <p>Controls of type <member>NumericField</member> exchange their values as <code>double</code>.</p> 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski <p>Additionally, those controls support the <type>XNumericControl</type> interface.</p> 110*b1cdbd2cSJim Jagielski */ 111*b1cdbd2cSJim Jagielski const short NumericField = 8; 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter a date value 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski <p>Controls of type <member>DateField</member> exchange their values as <type scope="com::sun::star::util">Date</type>.</p> 116*b1cdbd2cSJim Jagielski */ 117*b1cdbd2cSJim Jagielski const short DateField = 9; 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter a time value 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski <p>Controls of type <member>TimeField</member> exchange their values as <type scope="com::sun::star::util">Time</type>.</p> 122*b1cdbd2cSJim Jagielski */ 123*b1cdbd2cSJim Jagielski const short TimeField = 10; 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski /** denotes a control which allows the user to enter a combined date/time value 126*b1cdbd2cSJim Jagielski 127*b1cdbd2cSJim Jagielski <p>Controls of type <member>DateTimeField</member> exchange their values as <type scope="com::sun::star::util">DateTime</type>.</p> 128*b1cdbd2cSJim Jagielski */ 129*b1cdbd2cSJim Jagielski const short DateTimeField = 11; 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski /** denotes a control which displays a string in a hyperlink-like appearance 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski <p>Controls of type <member>HyperlinkField</member> exchange their values as <code>string</code>.</p> 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski <p>Additionally, those controls support the <type>XHyperlinkControl</type> interface.</p> 136*b1cdbd2cSJim Jagielski */ 137*b1cdbd2cSJim Jagielski const short HyperlinkField = 12; 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski /** denotes a non-standard property control, which is usually provided by an <type>XPropertyHandler</type> 140*b1cdbd2cSJim Jagielski */ 141*b1cdbd2cSJim Jagielski const short Unknown = 13; 142*b1cdbd2cSJim Jagielski}; 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski//============================================================================= 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski}; }; }; }; 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski#endif 149*b1cdbd2cSJim Jagielski 150