This service specifies the model for control which provides controller functionality for a DataForm, such as navigating or filtering the form. More...

import"NavigationToolBar.idl";

Inheritance diagram for NavigationToolBar:

Included Services
service	com::sun::star::form::FormControlModel

Included Services inherited from FormControlModel
service	com::sun::star::awt::UnoControlModel

service	com::sun::star::form::FormComponent

Included Services inherited from UnoControlModel
service	com::sun::star::awt::UnoControlDialogElement
	This service is present when the control model is embedded in an UnoControlDialogModel. More...

Public Attributes
short	Border
	denotes the border style of the control. More...

boolean	Enabled
	determines whether the control is enabled or disabled. More...

com::sun::star::awt::FontDescriptor	FontDescriptor
	contains the font attributes for the text in the control More...

long	TextColor
	specifies the text color (as RGB value) of the control. More...

long	TextLineColor
	specifies the text line color (as RGB value) of the control. More...

long	FontRelief
	specifies the relief for the font described in FontDescriptor More...

long	FontEmphasisMark
	specifies the emphasis mark for the font described in FontDescriptor More...

short	IconSize
	specifies the size of the icons in the control More...

boolean	ShowPosition
	determines whether the control should provide functionality for positioning the parent form More...

boolean	ShowNavigation
	determines whether the control should provide functionality for navigating the parent form More...

boolean	ShowRecordActions
	determines whether the control should provide functionality for acting on the current record of the parent form More...

boolean	ShowFilterSort
	determines whether the control should provide functionality for filtering and sorting the parent form More...

long	RepeatDelay
	specifies a repeat delay for the control More...

Public Attributes inherited from FormControlModel
short	ClassId
	specifies the ID for classification of the component. More...

short	TabIndex
	determines the relative taborder of the control associated with the model. More...

string	Tag
	used for additional information. More...

Public Attributes inherited from UnoControlModel
string	DefaultControl
	specifies the service name of the default control for this model. More...

Public Attributes inherited from FormComponent
string	Name
	the name of the component. More...

Additional Inherited Members
Exported Interfaces inherited from FormControlModel
interface	com::sun::star::beans::XFastPropertySet
	This optional interface gives an efficient access to all properties at once or an ability to set more than one property at once. More...

interface	com::sun::star::beans::XPropertyState
	This optional interface gives access to the state of the properties, e.g. More...

Exported Interfaces inherited from UnoControlModel
interface	com::sun::star::awt::XControlModel

interface	com::sun::star::lang::XComponent

interface	com::sun::star::beans::XPropertySet

interface	com::sun::star::beans::XMultiPropertySet

interface	com::sun::star::io::XPersistObject

interface	com::sun::star::util::XCloneable

Exported Interfaces inherited from FormComponent
interface	com::sun::star::form::XFormComponent
	identifies the component as a candidate for being part of a form. More...

interface	com::sun::star::lang::XComponent
	allows life-time control of form components. More...

interface	com::sun::star::container::XNamed
	Each FormComponent must supply a name for identification. More...

interface	com::sun::star::beans::XPropertySet
	gives access to the properties. More...

interface	com::sun::star::io::XPersistObject
	Each FormComponent must be able to be stored into and read from a stream. More...

interface	com::sun::star::beans::XPropertyBag
	allows to associate arbitrary properties with the form component More...

Exported Interfaces inherited from XPropertyBag
interface	com::sun::star::beans::XPropertySet

interface	com::sun::star::beans::XPropertyContainer

interface	com::sun::star::beans::XPropertyAccess

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Public Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...

void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...

void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...

Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...

any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...

void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...

void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...

void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...

Public Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values to the properties with the specified names. More...

sequence< any >	getPropertyValues ([in] sequence< string > aPropertyNames)

void	addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	adds an XPropertiesChangeListener to the specified property with the specified names. More...

void	removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
	removes an XPropertiesChangeListener from the listener list. More...

void	firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	fires a sequence of PropertyChangeEvents to the specified listener. More...

Public Member Functions inherited from XPersistObject
string	getServiceName ()
	gives the service name of the object More...

void	write ([in] com::sun::star::io::XObjectOutputStream OutStream) raises ( com::sun::star::io::IOException )
	writes all the persistent data of the object to the stream. More...

void	read ([in] com::sun::star::io::XObjectInputStream InStream) raises ( com::sun::star::io::IOException )
	reads all the persistent data of the object from the stream. More...

Public Member Functions inherited from XCloneable
com::sun::star::util::XCloneable	createClone ()
	creates a copy of the object. More...

Public Member Functions inherited from XChild
com::sun::star::uno::XInterface	getParent ()
	grants access to the object containing this content. More...

void	setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
	sets the parent to this object. More...

Public Member Functions inherited from XNamed
string	getName ()

void	setName ([in] string aName)
	sets the programmatic name of the object. More...

Protected Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Protected Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...

void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...

void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...

Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...

any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...

void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...

void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...

void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...

Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values to the properties with the specified names. More...

sequence< any >	getPropertyValues ([in] sequence< string > aPropertyNames)

void	addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	adds an XPropertiesChangeListener to the specified property with the specified names. More...

void	removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
	removes an XPropertiesChangeListener from the listener list. More...

void	firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	fires a sequence of PropertyChangeEvents to the specified listener. More...

Protected Member Functions inherited from XPersistObject
string	getServiceName ()
	gives the service name of the object More...

void	write ([in] com::sun::star::io::XObjectOutputStream OutStream) raises ( com::sun::star::io::IOException )
	writes all the persistent data of the object to the stream. More...

void	read ([in] com::sun::star::io::XObjectInputStream InStream) raises ( com::sun::star::io::IOException )
	reads all the persistent data of the object from the stream. More...

Protected Member Functions inherited from XCloneable
com::sun::star::util::XCloneable	createClone ()
	creates a copy of the object. More...

Protected Member Functions inherited from XPropertyContainer
void	addProperty ([in] string Name, [in] short Attributes, [in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException )
	adds a property to the object. More...

void	removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException )
	removes a property from the object. More...

Protected Member Functions inherited from XPropertyAccess
sequence< com::sun::star::beans::PropertyValue >	getPropertyValues ()

void	setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values of given properties. More...

Protected Member Functions inherited from XFastPropertySet
void	setFastPropertyValue ([in] long nHandle, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value to the property with the specified name. More...

any	getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState	getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )

sequence< com::sun::star::beans::PropertyState >	getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )

void	setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
	Sets the property to default value. More...

any	getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

Protected Attributes inherited from UnoControlDialogElement
long	Height
	specifies the height of the control. More...

string	Name
	specifies the name of the control. More...

string	PositionX
	specifies the horizontal position of the control. More...

string	PositionY
	specifies the vertical position of the control. More...

long	Step
	specifies the step of the control. More...

short	TabIndex
	specifies the tabindex of the control. More...

string	Tag
	specifies the tag of the control. More...

long	Width
	specifies the width of the control. More...

Detailed Description

This service specifies the model for control which provides controller functionality for a DataForm, such as navigating or filtering the form.

Exported Interfaces

◆ com::sun::star::form::FormControlModel

service com::sun::star::form::FormControlModel

Member Data Documentation

◆ Border

short Border

property

denotes the border style of the control.

Allowed values are

0: no border at all
1: 3D border
2: simple flat

◆ Enabled

boolean Enabled

property

determines whether the control is enabled or disabled.

◆ FontDescriptor

com::sun::star::awt::FontDescriptor FontDescriptor

property

contains the font attributes for the text in the control

◆ FontEmphasisMark

long FontEmphasisMark

property

specifies the emphasis mark for the font described in FontDescriptor

The value must be one of the com::sun::star::text::FontEmphasis constants.

◆ FontRelief

long FontRelief

property

specifies the relief for the font described in FontDescriptor

The value must be one of the com::sun::star::text::FontRelief constants.

◆ IconSize

short IconSize

property

specifies the size of the icons in the control

At least the following values are to be supported:

0: small icons (16x16)
1: medium size icons (26x26)

◆ RepeatDelay

long RepeatDelay

property

specifies a repeat delay for the control

Some buttons of a NavigationToolBar may show repeating behavior, e.g. may be repeatedly triggered when the user keeps the mouse pressed over such a button.
The delay between two such triggers (in milliseconds) is specified with this property.

◆ ShowFilterSort

boolean ShowFilterSort

property

determines whether the control should provide functionality for filtering and sorting the parent form

◆ ShowNavigation

boolean ShowNavigation

property

determines whether the control should provide functionality for navigating the parent form

◆ ShowPosition

boolean ShowPosition

property

determines whether the control should provide functionality for positioning the parent form

◆ ShowRecordActions

boolean ShowRecordActions

property

determines whether the control should provide functionality for acting on the current record of the parent form

◆ TextColor

long TextColor

property

specifies the text color (as RGB value) of the control.

◆ TextLineColor

long TextLineColor

property

specifies the text line color (as RGB value) of the control.

This color is used if the FontDescriptor defines that the text in the control should be underlined or stroke out.

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

com/sun/star/form/component/NavigationToolBar.idl

Included Services

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ com::sun::star::form::FormControlModel

Member Data Documentation

◆ Border

◆ Enabled

◆ FontDescriptor

◆ FontEmphasisMark

◆ FontRelief

◆ IconSize

◆ RepeatDelay

◆ ShowFilterSort

◆ ShowNavigation

◆ ShowPosition

◆ ShowRecordActions

◆ TextColor

◆ TextLineColor