LibreOffice
LibreOffice 7.2 SDK API Reference
Public Member Functions | List of all members
XStringListControl Interface Reference

defines the interface for an XPropertyControl which, additionally to the basic behavior, supports a list of strings interpreted as possible property values. More...

import"XStringListControl.idl";

Inheritance diagram for XStringListControl:
XPropertyControl

Public Member Functions

void clearList ()
 clears the whole list More...
 
void prependListEntry ([in] string NewEntry)
 prepends a new entry to the beginning of the list More...
 
void appendListEntry ([in] string NewEntry)
 appends a new entry to the end of the list More...
 
sequence< string > getListEntries ()
 gets all list entries More...
 
- Public Member Functions inherited from XPropertyControl
boolean isModified ()
 determines whether the control content is currently modified More...
 
void notifyModifiedValue ()
 notifies the context in which the control lives of the current control value, if this value is currently modified More...
 

Additional Inherited Members

- Public Attributes inherited from XPropertyControl
short ControlType
 denotes the type of the control, as one of the PropertyControlType constants More...
 
any Value { set raises(com::sun::star::beans::IllegalTypeException); }
 denotes the current content of the control. More...
 
type ValueType
 denotes the value type of the control. More...
 
XPropertyControlContext ControlContext
 specifies the context of the control within the ObjectInspector. More...
 
com::sun::star::awt::XWindow ControlWindow
 denotes the window which is the real UI representation of the property control. More...
 

Detailed Description

defines the interface for an XPropertyControl which, additionally to the basic behavior, supports a list of strings interpreted as possible property values.

A control which would canonically implement this interface is a list box control: The string list defined by XStringListControl would in the control be represented as drop-down list containing all the strings.

Since
OOo 2.0.3

Member Function Documentation

◆ appendListEntry()

void appendListEntry ( [in] string  NewEntry)

appends a new entry to the end of the list

◆ clearList()

void clearList ( )

clears the whole list

◆ getListEntries()

sequence< string > getListEntries ( )

gets all list entries

◆ prependListEntry()

void prependListEntry ( [in] string  NewEntry)

prepends a new entry to the beginning of the list


The documentation for this interface was generated from the following file: