Overview | Module | Use | Devguide | Index

Nested Modules | Services | Singletons | Interfaces | Structs | Exceptions | Enums | Typedefs | Constant Groups

:: com :: sun :: star ::
module frame
Description Desktop environment framework interfaces.

Nested Modules
status |

Services
AutoRecovery |
Bibliography |
Components | specifies a collection of components
ContentHandler | special dispatcher for non visible contents, e.g. sounds
ContentHandlerFactory | factory to create content loader
Controller | is an abstract service for a component which offers a deeper integration of desktop components than a ::com::sun::star::awt::XWindow can offer
Desktop | is the environment for components which can instantiate within frames
DesktopTask | [ DEPRECATED ] use the Frame service instead of this
DesktopTasks | [ DEPRECATED ]
DispatchHelper | provides an easy way to dispatch an URL using one call instead of multiple ones.
DispatchProvider | provides XDispatch objects for certain functions which are useful at the UI
DispatchRecorder | provides functionality to record XDispatch::dispatch() requests
DispatchRecorderSupplier | provides a DispatchRecorder
DocumentTemplates | is a service for accessing the document templates of the office and manipulate them ( add or rename or remove templates ) It implements a high level interface on top of an ucb content provider which is used for template configuration.
Frame | represents the environment for a desktop component
FrameControl | contains a frame with a desktop component
FrameLoader | derivations of this abstract service are used to load components into Frames of the environment
FrameLoaderFactory | factory to create frame loader
FramesContainer | this is a special container which can contain frames
GlobalEventBroadcaster | This service offers the document event functionality that can be found at any ::com::sun::star::document::OfficeDocument, but it does it for all existing documents. So it is a single place where a listener can be registered for all events in all documents.
LayoutManager | controls the layout of user interface elements which are part of a frame.
MediaTypeDetectionHelper | provides for mapping a given sequence of content identifier strings to a sequence of respective media (mime) types
ModuleManager | can be used to identify office modules.
PopupMenuController | provides access to a pop-up menu controller.
PopupMenuControllerFactory | specifies a factory that creates instances of registered popup menu controller.
ProtocolHandler | special dispatch provider registered for URL protocols
SessionListener | This was created from it's sole place of use, so it might be incomplete.
SessionManager | The SessionManager service provides an interface to the session manager of the desktop. A session manager keeps track of applications that are running when the desktop shuts down and starts them again in the same state they were left when the desktop starts up the next time. To be able to do this the session manager needs cooperation from applications; applications have to provide sufficient information to be started again as well as restore the state they were left in. The normal flow of operation looks like this:
Settings | [ DEPRECATED ]
StartModule |
StatusbarController | is an abstract service for a component which offers a more complex user interface to users within a status bar.
StatusbarControllerFactory | specifies a factory that creates instances of registered status bar controller.
SynchronousFrameLoader | derivations of this abstract service are used to load components into Frames of the environment
Task | [ DEPRECATED ] represents a top level frame in the frame hierarchy with the desktop as root
TaskCreator |
TemplateAccess | provides a high level API to organize document templates
ToolbarController | is an abstract service for a component which offers a more complex user interface to users within a toolbar.
ToolbarControllerFactory | specifies a factory that creates instances of registered toolbar controller.
TransientDocumentsDocumentContentFactory | specifies a factory for ::com::sun::star::ucb::TransientDocumentsDocumentContents.
UICommandDescription | a service which provides information about user interface commands of modules.

Interfaces
XBorderResizeListener | allows to listen to border resize events of a controller.
XBrowseHistoryRegistry | [ DEPRECATED ]
XComponentLoader | this is a simple interface to load components by an URL into a frame environment
XComponentRegistry | [ DEPRECATED ]
XConfigManager | [ DEPRECATED ]
XControlNotificationListener | Must be implemented by dispatch objects which want to get notifications about control events.
XController | With this interface, components viewed in a Frame can serve events (by supplying dispatches).
XController2 | extends the XController interface
XControllerBorder | allows to retrieve information about controller's border.
XDesktop | This is the main interface of a desktop service.
XDesktop2 |
XDesktopTask | [ DEPRECATED ] use XFrame instead of this
XDispatch | serves state information of objects which can be connected to controls (e.g. toolbox controls).
XDispatchHelper | provides an easy way to dispatch functions useful at UI level.
XDispatchInformationProvider | provides information about supported commands
XDispatchProvider | provides XDispatch interfaces for certain functions which are useful at the UI.
XDispatchProviderInterception | makes it possible to register an XDispatchProvider which intercepts all requests of XDispatch to this instance.
XDispatchProviderInterceptor | makes it possible to intercept request of XDispatch.
XDispatchRecorder | provides recording functionality of dispatches
XDispatchRecorderSupplier | provides access to the record mechanism of dispatches
XDispatchResultListener | listener for results of XNotifyingDispatch::dispatchWithNotification()
XDocumentTemplates | provides a high level API to organize document templates
XExtendedFilterDetection | [ DEPRECATED ] use ::com::sun::star::document::XExtendedFilterDetection instead of this
XFilterDetect | [ DEPRECATED ] use ::com::sun::star::document::XExtendedFilterDetection instead of this
XFrame | a frame object can be considered to be an "anchor" object where a component can be attached to.
XFrame2 |
XFrameActionListener | has to be provided if an object wants to receive events when several things happen to components within frames of the desktop frame tree.
XFrameLoader | load components into a frame
XFrameLoaderQuery | [ DEPRECATED ] use service FrameLoaderFactory instead of this
XFrameSetModel | [ DEPRECATED ] use XModel instead of this
XFrames | manages and creates frames.
XFramesSupplier | provides access to sub frames of current one
XGlobalEventBroadcaster | Provides a unified interface for the GlobalEventBroadcaster service to implement.
XInterceptorInfo | makes it possible to get information about a registered interceptor and is used by frame interceptor mechanism to perform interception.
XLayoutManager | central interface to query for, create, destroy and manipulate user interface elements which are bound to a layout manager.
XLayoutManagerEventBroadcaster | makes it possible to receive events from a layout manager.
XLayoutManagerListener | makes it possible to receive events from a layout manager.
XLoadEventListener | is used to receive callbacks from an asynchronous frame loader.
XLoadable | offers a simple way to initialize a component or load it from an URL.
XMenuBarAcceptor | [ DEPRECATED ] provides function to update a menu bar for inplace editing.
XMenuBarMergingAcceptor | provides functions to set and remove a merged menu bar for inplace editing.
XModel | represents a component which is created from an URL and arguments.
XModel2 | extends interface XModel. The following functions are added: - enumeration of all currently connected controller objects. (not getCurrentController() only, which depends on focus) - establish new view controller factory methods, which will make it possible to create new views for this model.
XModule | can be used to overrule identification of office modules.
XModuleManager | can be used to identify office modules.
XModuleManager2 | This interface provides a merged single interface for the ModuleManager service to implement.
XNotifyingDispatch | dispatch with guaranteed notify (instead of XDispatch)
XPopupMenuController | provides data to a pop-up menu controller implementation to fill and update a pop-up menu dynamically.
XRecordableDispatch | extends an existing XDispatch implementation with functionality for dispatch recording
XSessionManagerClient | Connect to a session manager to get information about pending desktop shutdown
XSessionManagerListener |
XSessionManagerListener2 |
XStatusListener | makes it possible to receive events when the state of a feature changes.
XStatusbarController | interface to be implemented by a component offering a more complex user interface to users within a status bar.
XStorable | offers a simple way to store a component to an URL.
XStorable2 | extends XStorable.
XSubToolbarController | special interface to support sub-toolbars in a controller implementation.
XSynchronousDispatch | additional interfaces for dispatch objects: allow to execute with return value
XSynchronousFrameLoader | loads a resource into a Frame.
XTask | [ DEPRECATED ] use XFrame instead of this one
XTasksSupplier | [ DEPRECATED ] use XFramesSupplier instead of that
XTerminateListener | has to be provided if an object wants to receive an event when the master environment (e.g., desktop) is terminated.
XTerminateListener2 | extend interface XTerminateListener so a listener will be informed in case termination process was canceled by other reasons.
XTitle | an interface representing an entity with a modifyable title.
XTitleChangeBroadcaster | todo document me
XTitleChangeListener | todo document me
XToolbarController | is an abstract service for a component which offers a more complex user interface to users within a toolbar.
XToolbarControllerListener | is used to notify a toolbar controller about events
XTransientDocumentsDocumentContentFactory | specifies a factory for ::com::sun::star::ucb::TransientDocumentsDocumentContents.
XUIControllerFactory | a factory to create User Interface controllers.
XUIControllerRegistration | is used to query, register and unregister user interface controller.
XUntitledNumbers | knows all currently used and all free numbers for using with untitled but counted objects.
XUrlList | [ DEPRECATED ]
XWindowArranger | [ DEPRECATED ]

Structs
BorderWidths | specifies a border area by offsets from each side.
ControlCommand | describes a command which can be send to a generic toolbar control.
ControlEvent | describes a control event send by extended user interface controls.
DispatchDescriptor | describes a feature to be retrieved by a URL that has to be loaded into a specified frame
DispatchInformation | provides information about a supported command
DispatchResultEvent | contains the result of the dispatch action, if State is set to SUCCESS
DispatchStatement | represents a dispatch statement from a recorded macro
FeatureStateEvent | This event is broadcast by a Controller whenever the state of the feature changes
FrameActionEvent | this event struct is broadcast for actions which can happen to components within frames
TitleChangedEvent | todo document me

Exceptions
DoubleInitializationException | This exception can be thrown in case an object is initialized second time.
IllegalArgumentIOException | This exception can be thrown in case arguments are wrong.
TerminationVetoException | can be thrown by a XTerminateListener to prevent the environment (e.g., desktop) from terminating
UnknownModuleException | This exception can be thrown in case an office * module could not be classified or does not have * a valid configuration.

Enums
FrameAction | these are the events which can happen to the components in frames of the desktop

Constant Groups
CommandGroup | provides information about a supported command
DispatchResultState | possible values for DispatchResultEvent
FrameSearchFlag | these types describe the algorithm to be used to search a frame
LayoutManagerEvents | provides information about layout manager events
UntitledNumbersConst |
WindowArrange | these constants are used to specify a style of window arrangement

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.