com::sun::star::ui Module Reference

Dialogs and other UI elements. More...

Modules
module	dialogs
	dialogs.
module	test

Constant Groups
constants	ActionTriggerSeparatorType
	Determines the type of a separator in an ActionTriggerContainer.
constants	ImageType
	Determine the image set of an image manager.
constants	ItemStyle
	specifies styles which influence the appearance and the behavior of an user interface item.
constants	ItemType
	Determines the type of an item.
constants	UIElementType
	determine the type of a user interface element which is controlled by a layout manager.

Classes
service	ActionTrigger
	describes a trigger for an (user inter-)action. More...
service	ActionTriggerContainer
	describes a container of user actions. More...
service	ActionTriggerSeparator
	describes a separator entry. More...
service	AddressBookSourceDialog
	This interface could be incomplete since I derived it from its places of use. More...
service	ConfigurableUIElement
	specifies a configurable user interface element that supports persistence. More...
struct	ConfigurationEvent
	this event is broadcasted by a configuration manager whenever the state of user interface element has changed. More...
singleton	ContextChangeEventMultiplexer
	Multiplex events for context changes. More...
struct	ContextChangeEventObject
struct	ContextMenuExecuteEvent
	contains all information about the requested context menu. More...
service	DocumentAcceleratorConfiguration
service	GlobalAcceleratorConfiguration
	provides access to the global accelerator (aka shortcut) configuration set. More...
service	ImageManager
service	ItemDescriptor
	describes a user interface item that is part of a user interface element. More...
struct	LayoutSize
	Size used for layouting windows. More...
service	ModuleAcceleratorConfiguration
service	ModuleUICategoryDescription
	a service which provides information about the user interface command categories of a single module. More...
service	ModuleUICommandDescription
	a service which provides information about the user interface commands of a single module. More...
service	ModuleUIConfigurationManager
	specifies a user interface configuration manager which gives access to user interface configuration data of a module. More...
service	ModuleUIConfigurationManagerSupplier
	A legacy (single-instance) service-variant of theModuleUIConfigurationManagerSupplier singleton. More...
service	ModuleWindowStateConfiguration
	a service which provides window based information about user interface elements of a single application module. More...
singleton	theModuleUIConfigurationManagerSupplier
	specifies a central user interface configuration provider which gives access to module based user interface configuration managers. More...
singleton	theUICategoryDescription
	a singleton which provides information about user interface command categories. More...
singleton	theUIElementFactoryManager
	specifies a user interface factory manager that controls all registered user interface element factories. More...
singleton	theWindowContentFactoryManager
	This interface could be incomplete since I derived it from its sole place of use. More...
singleton	theWindowStateConfiguration
	a singleton which provides window based information about user interface elements. More...
service	UICategoryDescription
	A legacy (single-instance) service-variant of theUICategoryDescription singleton. More...
service	UIConfigurationManager
	specifies a user interface configuration manager which controls all customizable user interface elements of an object. More...
service	UIElement
	specifies a user interface element. More...
service	UIElementFactory
	specifies a user interface element factory that can create and initialize a user interface element type. More...
service	UIElementFactoryManager
	A legacy (single-instance) service-variant of theUIElementFactoryManager singleton. More...
service	UIElementSettings
	describes the internal structure of a configurable user interface element. More...
service	WindowContentFactory
	specifies a factory which creates a window that is a container for user interface elements. More...
service	WindowContentFactoryManager
	A legacy (single-instance) service-variant of theWindowContentFactoryManager singleton. More...
service	WindowStateConfiguration
	A legacy (single-instance) service-variant of theWindowStateConfiguration singleton. More...
interface	XAcceleratorConfiguration
	provides read/write access to an accelerator configuration set. More...
interface	XContextChangeEventListener
interface	XContextChangeEventMultiplexer
	Provide a central access point for a group of events. More...
interface	XContextMenuInterception
	This interface enables an object to get interceptors registered that change context menus or prevent them from being executed. More...
interface	XContextMenuInterceptor
	This interface enables the object to be registered as interceptor to change context menus or prevent them from being executed. More...
interface	XDeck
	provides access to Deck More...
interface	XDecks
	provides access to Decks of a Sidebar. More...
interface	XDockingAreaAcceptor
	this interface enables developer to implement different docking area acceptors which are used by the frame based layout manager. More...
interface	XImageManager
	specifies access functions to an images manager interface to add, replace and remove images associations to command URLs. More...
interface	XModuleUIConfigurationManager
	specifies specific functions of a module based user interface configuration manager interface. More...
interface	XModuleUIConfigurationManager2
	Provides a unified interface for the ModuleUIConfigurationManager service. More...
interface	XModuleUIConfigurationManagerSupplier
	allows to retrieve user interface configuration managers related to OpenOffice.org modules. More...
interface	XPanel
	provides access to Panel More...
interface	XPanels
	provides access to Panels of a Deck. More...
interface	XSidebar
	Interface of the sidebar that allows its elements like panels to eg request layouts. More...
interface	XSidebarPanel
	Optional interface of sidebar panels. More...
interface	XSidebarProvider
	Interface of the sidebar. More...
interface	XStatusbarItem
	Represents an item in a status bar. More...
interface	XToolPanel
	describes the basic interface to be implemented by a tool panel More...
interface	XUIConfiguration
	supports to notify other implementations about changes of a user interface configuration manager. More...
interface	XUIConfigurationListener
	supplies information about changes of a user interface configuration manager. More...
interface	XUIConfigurationManager
	specifies a user interface configuration manager interface which controls the structure of all customizable user interface elements. More...
interface	XUIConfigurationManager2
interface	XUIConfigurationManagerSupplier
	allows to retrieve the user interface configuration manager related to an object. More...
interface	XUIConfigurationPersistence
	specifies a persistence interface which supports to load/store user interface configuration data to a storage and to retrieve information about the current state. More...
interface	XUIConfigurationStorage
	supplies functions to change or get information about the storage of a user interface configuration manager. More...
interface	XUIElement
	provides a function to retrieve a special purpose interface dependent on the user interface element type. More...
interface	XUIElementFactory
	specifies a user interface element factory that can create and initialize user interface elements. More...
interface	XUIElementFactoryManager
	Provides a unified interface for the new-style service XUIElementFactoryManager. More...
interface	XUIElementFactoryRegistration
	is used to query, register and deregister user interface element factories. More...
interface	XUIElementSettings
	provides functions to retrieve and change user interface element structure data and to update its visible representation. More...
interface	XUIFunctionListener
	special interface to receive notification that a user interface element will execute a function. More...
interface	XUpdateModel
	Internal interface to update the used css::frame::XModel More...

Enumerations
enum	ContextMenuInterceptorAction { IGNORED, CANCELLED, EXECUTE_MODIFIED, CONTINUE_MODIFIED }
	determines the action that is requested from the XContextMenuInterceptor. More...
enum	DockingArea {   DOCKINGAREA_TOP, DOCKINGAREA_BOTTOM, DOCKINGAREA_LEFT, DOCKINGAREA_RIGHT,   DOCKINGAREA_DEFAULT }
	specifies different docking areas a frame based layout manager supports. More...

Detailed Description

Dialogs and other UI elements.

Enumeration Type Documentation

ContextMenuInterceptorAction

enum ContextMenuInterceptorAction

published

determines the action that is requested from the XContextMenuInterceptor.

Enumerator
IGNORED	the XContextMenuInterceptor has ignored the call. The next registered XContextMenuInterceptor should be notified.
CANCELLED	the context menu must not be executed. The next registered XContextMenuInterceptor should not be notified.
EXECUTE_MODIFIED	the menu has been modified and should be executed without notifying the next registered XContextMenuInterceptor.
CONTINUE_MODIFIED	the menu has been modified and the next registered XContextMenuInterceptor should be notified.

DockingArea

enum DockingArea

specifies different docking areas a frame based layout manager supports.

A frame based layout manager supports four different docking areas where dockable user interface elements can be docked.

See also

com::sun::star::frame::XLayoutManager

Since

OOo 2.0

Enumerator
DOCKINGAREA_TOP	the top docking area below the menu bar.
DOCKINGAREA_BOTTOM	the bottom docking area above the status bar.
DOCKINGAREA_LEFT	the left side docking area.
DOCKINGAREA_RIGHT	the right side docking area.
DOCKINGAREA_DEFAULT	a default docking area. It depends on the implementation how to treat this value.