specifies the standard model of a UnoControlDialog. More...

import"UnoControlDialogModel.idl";

Inheritance diagram for UnoControlDialogModel:

Included Services
service	com::sun::star::awt::UnoControlModel

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...

Exported Interfaces
interface	com::sun::star::lang::XMultiServiceFactory
	allows to create control models, which support the UnoControlDialogElement service and can be inserted into this container. More...

interface	com::sun::star::container::XContainer

interface	com::sun::star::container::XNameContainer

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

Public Attributes
com::sun::star::util::Color	BackgroundColor
	specifies the background color (RGB) of the dialog. More...

boolean	Closeable
	specifies if the dialog is closeable. More...

boolean	Enabled
	determines whether a dialog is enabled or disabled. More...

com::sun::star::awt::FontDescriptor	FontDescriptor
	specifies the font attributes of the text in the caption bar of the dialog. More...

short	FontEmphasisMark
	specifies the com::sun::star::text::FontEmphasis value of the text in the caption bar of the dialog. More...

short	FontRelief
	specifies the com::sun::star::text::FontRelief value of the text in the caption bar of the dialog. More...

string	HelpText
	specifies the help text of the dialog. More...

string	HelpURL
	specifies the help URL of the dialog. More...

boolean	Moveable
	specifies if the dialog is moveable. More...

boolean	Sizeable
	specifies if the dialog is sizeable. More...

com::sun::star::util::Color	TextColor
	specifies the text color (RGB) of the dialog. More...

com::sun::star::util::Color	TextLineColor
	specifies the text line color (RGB) of the dialog. More...

string	Title
	specifies the text that is displayed in the caption bar of the dialog. More...

boolean	DesktopAsParent
	If set to true the dialog will have the desktop as parent. More...

string	ImageURL
	specifies a URL that references a graphic that should be used as a background image. More...

com::sun::star::graphic::XGraphic	Graphic
	specifies a graphic to be displayed as a background image More...

boolean	HScroll
	specifies that a horizontal scrollbar should be added to the dialog More...

boolean	VScroll
	specifies that a vertical scrollbar should be added to the dialog More...

long	ScrollLeft
	specifies the horizontal position of the scrolled dialog content More...

long	ScrollTop
	specifies the vertical position of the scrolled dialog content More...

long	ScrollWidth
	specifies the total width of the scrollable dialog content More...

long	ScrollHeight
	specifies the total height of the scrollable dialog content More...

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

Additional Inherited Members
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 XMultiServiceFactory
com::sun::star::uno::XInterface	createInstance ([in] string aServiceSpecifier) raises ( com::sun::star::uno::Exception )
	Creates an instance classified by the specified name. More...

com::sun::star::uno::XInterface	createInstanceWithArguments ([in] string ServiceSpecifier, [in] sequence< any > Arguments) raises ( com::sun::star::uno::Exception )
	Creates an instance classified by the specified name and passes the arguments to that instance. More...

sequence< string >	getAvailableServiceNames ()
	Provides the available names of the factory to be used to create instances. More...

Public Member Functions inherited from XContainer
void	addContainerListener ([in] com::sun::star::container::XContainerListener xListener)
	adds the specified listener to receive events when elements are inserted or removed. More...

void	removeContainerListener ([in] com::sun::star::container::XContainerListener xListener)
	removes the specified listener so it does not receive any events from this container. More...

Public Member Functions inherited from XNameContainer
void	insertByName ([in] string aName, [in] any aElement) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException, com::sun::star::lang::WrappedTargetException )
	inserts the given element at the specified name. More...

void	removeByName ([in] string Name) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
	removes the element with the specified name. More...

Public Member Functions inherited from XNameReplace
void	replaceByName ([in] string aName, [in] any aElement) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
	replaces the element with the specified name with the given element. More...

Public Member Functions inherited from XNameAccess
any	getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )

sequence< string >	getElementNames ()

boolean	hasByName ([in] string aName)

Public Member Functions inherited from XElementAccess
type	getElementType ()

boolean	hasElements ()

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 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

specifies the standard model of a UnoControlDialog.

Exported Interfaces

◆ com::sun::star::awt::UnoControlModel

service com::sun::star::awt::UnoControlModel

Exported Interfaces

◆ com::sun::star::container::XContainer

interface com::sun::star::container::XContainer

◆ com::sun::star::container::XNameContainer

interface com::sun::star::container::XNameContainer

◆ com::sun::star::lang::XMultiServiceFactory

interface com::sun::star::lang::XMultiServiceFactory

allows to create control models, which support the UnoControlDialogElement service and can be inserted into this container.

Member Data Documentation

◆ BackgroundColor

com::sun::star::util::Color BackgroundColor

property

specifies the background color (RGB) of the dialog.

◆ Closeable

boolean Closeable

property

specifies if the dialog is closeable.

◆ DesktopAsParent

boolean DesktopAsParent

optionalproperty

If set to true the dialog will have the desktop as parent.

Since: OOo 2.3

◆ Enabled

boolean Enabled

property

determines whether a dialog is enabled or disabled.

◆ FontDescriptor

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

property

specifies the font attributes of the text in the caption bar of the dialog.

◆ FontEmphasisMark

short FontEmphasisMark

property

specifies the com::sun::star::text::FontEmphasis value of the text in the caption bar of the dialog.

◆ FontRelief

short FontRelief

property

specifies the com::sun::star::text::FontRelief value of the text in the caption bar of the dialog.

◆ Graphic

com::sun::star::graphic::XGraphic Graphic

optionalpropertytransient

specifies a graphic to be displayed as a background image

If this property is present, it interacts with the ImageURL in the following way:

If ImageURL is set, Graphic will be reset to an object as loaded from the given image URL, or NULL if ImageURL does not point to a valid image file.
If Graphic is set, ImageURL will be reset to an empty string.

Since: OOo 2.4

◆ HelpText

string HelpText

property

specifies the help text of the dialog.

◆ HelpURL

string HelpURL

property

specifies the help URL of the dialog.

◆ HScroll

boolean HScroll

optionalproperty

specifies that a horizontal scrollbar should be added to the dialog

Since: LibreOffice 4.0

◆ ImageURL

string ImageURL

optionalproperty

specifies a URL that references a graphic that should be used as a background image.

See also: Graphic

Since: OOo 2.4

◆ Moveable

boolean Moveable

property

specifies if the dialog is moveable.

◆ ScrollHeight

long ScrollHeight

optionalproperty

specifies the total height of the scrollable dialog content

Since: LibreOffice 4.0

◆ ScrollLeft

long ScrollLeft

optionalproperty

specifies the horizontal position of the scrolled dialog content

Since: LibreOffice 4.0

◆ ScrollTop

long ScrollTop

optionalproperty

specifies the vertical position of the scrolled dialog content

Since: LibreOffice 4.0

◆ ScrollWidth

long ScrollWidth

optionalproperty

specifies the total width of the scrollable dialog content

Since: LibreOffice 4.0

◆ Sizeable

boolean Sizeable

property

specifies if the dialog is sizeable.

◆ TextColor

com::sun::star::util::Color TextColor

property

specifies the text color (RGB) of the dialog.

◆ TextLineColor

com::sun::star::util::Color TextLineColor

property

specifies the text line color (RGB) of the dialog.

◆ Title

string Title

property

specifies the text that is displayed in the caption bar of the dialog.

◆ VScroll

boolean VScroll

optionalproperty

specifies that a vertical scrollbar should be added to the dialog

Since: LibreOffice 4.0

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

com/sun/star/awt/UnoControlDialogModel.idl

Included Services

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ com::sun::star::awt::UnoControlModel

Exported Interfaces

◆ com::sun::star::container::XContainer

◆ com::sun::star::container::XNameContainer

◆ com::sun::star::lang::XMultiServiceFactory

Member Data Documentation

◆ BackgroundColor

◆ Closeable

◆ DesktopAsParent

◆ Enabled

◆ FontDescriptor

◆ FontEmphasisMark

◆ FontRelief

◆ Graphic

◆ HelpText

◆ HelpURL

◆ HScroll

◆ ImageURL

◆ Moveable

◆ ScrollHeight

◆ ScrollLeft

◆ ScrollTop

◆ ScrollWidth

◆ Sizeable

◆ TextColor

◆ TextLineColor

◆ Title

◆ VScroll