LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Variables
com::sun::star::inspection::PropertyControlType Constant Group Reference

describes pre-defined possible control types to be used to display and enter property values within a ObjectInspector. More...

Variables

const short ListBox = 1
 denotes a control which allows the user to choose from a list of possible property values More...
 
const short ComboBox = 2
 denotes a control which allows the user to choose from a list of possible property values, combined with the possibility to enter a new property value. More...
 
const short TextField = 3
 denotes a control which allows the user to enter property values consisting of a single line of text More...
 
const short MultiLineTextField = 4
 denotes a control which allows the user to enter pure text, including line breaks More...
 
const short CharacterField = 5
 denotes a control which allows the user to enter a single character More...
 
const short StringListField = 6
 denotes a control which allows the user to enter a list of single-line strings More...
 
const short ColorListBox = 7
 denotes a control which allows the user to choose from a list of colors. More...
 
const short NumericField = 8
 denotes a control which allows the user to enter a numerical value More...
 
const short DateField = 9
 denotes a control which allows the user to enter a date value More...
 
const short TimeField = 10
 denotes a control which allows the user to enter a time value More...
 
const short DateTimeField = 11
 denotes a control which allows the user to enter a combined date/time value More...
 
const short HyperlinkField = 12
 denotes a control which displays a string in a hyperlink-like appearance More...
 
const short Unknown = 13
 denotes a non-standard property control, which is usually provided by an XPropertyHandler More...
 

Detailed Description

describes pre-defined possible control types to be used to display and enter property values within a ObjectInspector.

The type of a control determines its visual appearance, its behavior, and - important for property handlers using a control - the expected type when reading and writing the control's value.

See Also
XPropertyControl
XPropertyControlFactory
XPropertyControl::ValueType
Since
OOo 2.0.3

Variable Documentation

const short CharacterField = 5

denotes a control which allows the user to enter a single character

Controls of type CharacterField exchange their values as short, being a single UTF-16 character.

const short ColorListBox = 7

denotes a control which allows the user to choose from a list of colors.

Controls of type ColorListBox usually exchange their values as com::sun::star::util::Color.

Additionally, those controls support the XStringListControl interface. If you use this interface to add additional entries to the list box, which have no color associated with it, then you can also exchange values as string. That is, if you write a string into XPropertyControl::Value, and if this string has previously been added to the list using the XStringListControl interface, this string is selected. Vice versa, if the user selects one of those non-color strings in the list, then reading XPropertyControl::Value will retrieve you this string.

const short ComboBox = 2

denotes a control which allows the user to choose from a list of possible property values, combined with the possibility to enter a new property value.

Controls of type ComboBox exchange their values as string.

Additionally, those controls support the XStringListControl interface.

const short DateField = 9

denotes a control which allows the user to enter a date value

Controls of type DateField exchange their values as com::sun::star::util::Date.

const short DateTimeField = 11

denotes a control which allows the user to enter a combined date/time value

Controls of type DateTimeField exchange their values as com::sun::star::util::DateTime.

const short HyperlinkField = 12

denotes a control which displays a string in a hyperlink-like appearance

Controls of type HyperlinkField exchange their values as string.

Additionally, those controls support the XHyperlinkControl interface.

const short ListBox = 1

denotes a control which allows the user to choose from a list of possible property values

Controls of type ListBox exchange their values as string.

Additionally, those controls support the XStringListControl interface.

const short MultiLineTextField = 4

denotes a control which allows the user to enter pure text, including line breaks

Controls of type MultiLineTextField exchange their values as string.

const short NumericField = 8

denotes a control which allows the user to enter a numerical value

Controls of type NumericField exchange their values as double.

Additionally, those controls support the XNumericControl interface.

const short StringListField = 6

denotes a control which allows the user to enter a list of single-line strings

Controls of type StringListField exchange their values as sequence< string >.

const short TextField = 3

denotes a control which allows the user to enter property values consisting of a single line of text

Controls of type TextField exchange their values as string.

const short TimeField = 10

denotes a control which allows the user to enter a time value

Controls of type TimeField exchange their values as com::sun::star::util::Time.

const short Unknown = 13

denotes a non-standard property control, which is usually provided by an XPropertyHandler