:: com :: sun :: star ::

module frame
Description
Desktop environment framework interfaces.

Nested Modules
status
Services
::com::sun::star::frame::Components specifies a collection of components
::com::sun::star::frame::ContentHandler special dispatcher for non visible contents, e.g. sounds
::com::sun::star::frame::ContentHandlerFactory factory to create content loader
::com::sun::star::frame::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
::com::sun::star::frame::Desktop is the environment for components which can instantiate within frames
::com::sun::star::frame::DesktopTask [ DEPRECATED ]
use the ::com::sun::star::frame::Frame service instead of this
::com::sun::star::frame::DesktopTasks [ DEPRECATED ]
::com::sun::star::frame::DispatchHelper provides an easy way to dispatch an URL using one call instead of multiple ones.
::com::sun::star::frame::DispatchProvider provides ::com::sun::star::frame::XDispatch objects for certain functions which are useful at the UI
::com::sun::star::frame::DispatchRecorder provides functionality to record ::com::sun::star::frame::XDispatch::dispatch() requests
::com::sun::star::frame::DispatchRecorderSupplier provides a ::com::sun::star::frame::DispatchRecorder
::com::sun::star::frame::DocumentTemplates is an abstract service for accessing the document templates of the office and manipulate them ( add or rename or remove templates )
::com::sun::star::frame::Frame represents the environment for a desktop component
::com::sun::star::frame::FrameControl contains a frame with a desktop component
::com::sun::star::frame::FrameLoader derivations of this abstract service are used to load components into ::com::sun::star::frame::Frame s of the environment
::com::sun::star::frame::FrameLoaderFactory factory to create frame loader
::com::sun::star::frame::FramesContainer this is a special container which can contain frames
::com::sun::star::frame::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.
::com::sun::star::frame::LayoutManager controls the layout of user interface elements which are part of a frame.
::com::sun::star::frame::MediaTypeDetectionHelper provides for mapping a given sequence of content identifier strings to a sequence of respective media (mime) types
::com::sun::star::frame::ModuleManager can be used to identify office modules.
::com::sun::star::frame::PopupMenuController provides access to a popup menu controller.
::com::sun::star::frame::PopupMenuControllerFactory specifies a factory that creates instances of registered popup menu controller.
::com::sun::star::frame::ProtocolHandler special dispatch provider registered for URL protocols
::com::sun::star::frame::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:
::com::sun::star::frame::Settings [ DEPRECATED ]
::com::sun::star::frame::StatusbarController is an abstract service for a component which offers a more complex user interface to users within a status bar.
::com::sun::star::frame::StatusbarControllerFactory specifies a factory that creates instances of registered status bar controller.
::com::sun::star::frame::SynchronousFrameLoader derivations of this abstract service are used to load components into ::com::sun::star::frame::Frame s of the environment
::com::sun::star::frame::Task [ DEPRECATED ]
represents a top level frame in the frame hierarchy with the desktop as root
::com::sun::star::frame::TemplateAccess provides a high level api to organize document templates
::com::sun::star::frame::ToolbarController is an abstract service for a component which offers a more complex user interface to users within a toolbar.
::com::sun::star::frame::TransientDocumentsDocumentContentFactory specifies a factory for ::com::sun::star::ucb::TransientDocumentsDocumentContent s.
Interfaces
::com::sun::star::frame::XBorderResizeListener allows to listen to border resize events of a controller.
::com::sun::star::frame::XBrowseHistoryRegistry [ DEPRECATED ]
::com::sun::star::frame::XComponentLoader this is a simple interface to load components by an URL into a frame environment
::com::sun::star::frame::XComponentRegistry [ DEPRECATED ]
::com::sun::star::frame::XConfigManager [ DEPRECATED ]
::com::sun::star::frame::XController With this interface, components viewed in a ::com::sun::star::frame::Frame can serve events (by supplying dispatches).
::com::sun::star::frame::XControllerBorder allows to retrieve information about controller's border.
::com::sun::star::frame::XDesktop This is the main interface of a desktop service.
::com::sun::star::frame::XDesktopTask [ DEPRECATED ]
use ::com::sun::star::frame::XFrame instead of this
::com::sun::star::frame::XDispatch serves state information of objects which can be connected to controls (e.g., toolbox controls).
::com::sun::star::frame::XDispatchHelper provides any easy dispatch interfaces for certain functions which are useful at the UI.
::com::sun::star::frame::XDispatchInformationProvider provides information about supported commands
::com::sun::star::frame::XDispatchProvider provides ::com::sun::star::frame::XDispatch interfaces for certain functions which are useful at the UI.
::com::sun::star::frame::XDispatchProviderInterception makes it possible to register an ::com::sun::star::frame::XDispatchProvider which intercepts all requests of ::com::sun::star::frame::XDispatch to this instance.
::com::sun::star::frame::XDispatchProviderInterceptor makes it possible to intercept request of ::com::sun::star::frame::XDispatch .
::com::sun::star::frame::XDispatchRecorder provides recording functionality of dispatches
::com::sun::star::frame::XDispatchRecorderSupplier provides access to the record mechanism of dispatches
::com::sun::star::frame::XDispatchResultListener listener for results of ::com::sun::star::frame::XNotifyingDispatch::dispatchWithNotification()
::com::sun::star::frame::XDocumentTemplates provides a high level api to organize document templates
::com::sun::star::frame::XExtendedFilterDetection [ DEPRECATED ]
use ::com::sun::star::document::XExtendedFilterDetection instead of this
::com::sun::star::frame::XFilterDetect [ DEPRECATED ]
use ::com::sun::star::document::XExtendedFilterDetection instead of this
::com::sun::star::frame::XFrame a frame object can be considered to be an "anchor" object where a component can be attached to.
::com::sun::star::frame::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.
::com::sun::star::frame::XFrameLoader load components into a frame
::com::sun::star::frame::XFrameLoaderQuery [ DEPRECATED ]
use service ::com::sun::star::frame::FrameLoaderFactory instead of this
::com::sun::star::frame::XFrameSetModel [ DEPRECATED ]
use ::com::sun::star::frame::XModel instead of this
::com::sun::star::frame::XFrames manages and creates frames.
::com::sun::star::frame::XFramesSupplier provides access to sub frames of current one
::com::sun::star::frame::XInplaceLayout [ DEPRECATED ]
special interface to support inplace editing of components inside OpenOffice.org.
::com::sun::star::frame::XInterceptorInfo makes it possible to get information about a registered interceptor and is used by frame interceptor mechanism to perform interception.
::com::sun::star::frame::XLayoutManager central interface to query for, create, destroy and manipulate user interface elements which are bound to a layout manager.
::com::sun::star::frame::XLayoutManagerEventBroadcaster makes it possible to receive events from a layout manager.
::com::sun::star::frame::XLayoutManagerListener makes it possible to receive events from a layout manager.
::com::sun::star::frame::XLoadEventListener is used to receive callbacks from an asynchronous frame loader.
::com::sun::star::frame::XLoadable offers a simple way to initialize a component or load it from an URL.
::com::sun::star::frame::XMenuBarAcceptor [ DEPRECATED ]
provides function to update a menu bar for inplace editing.
::com::sun::star::frame::XMenuBarMergingAcceptor provides functions to set and remove a merged menu bar for inplace editing.
::com::sun::star::frame::XModel represents a component which is created from an URL and arguments.
::com::sun::star::frame::XModuleManager can be used to identify office modules.
::com::sun::star::frame::XNotifyingDispatch dispatch with guaranteed notify (instead of ::com::sun::star::frame::XDispatch )
::com::sun::star::frame::XPopupMenuController provides data to a popup menu controller implementation to fill and update a popup menu dynamically.
::com::sun::star::frame::XRecordableDispatch extends an existing ::com::sun::star::frame::XDispatch implementation with functionality for dispatch recording
::com::sun::star::frame::XSessionManagerClient Connect to a session manager to get information about pending desktop shutdown
::com::sun::star::frame::XSessionManagerListener
::com::sun::star::frame::XStatusListener makes it possible to receive events when the state of a feature changes.
::com::sun::star::frame::XStatusbarController is an abstract service for a component which offers a more complex user interface to users within a status bar.
::com::sun::star::frame::XStorable offers a simple way to store a component to an URL.
::com::sun::star::frame::XStorable2 extends ::com::sun::star::frame::XStorable .
::com::sun::star::frame::XSubToolbarController special interface to support sub-toolbars in a controller implementation.
::com::sun::star::frame::XSynchronousDispatch additional interfaces for dispatch objects: allow to execute with return value
::com::sun::star::frame::XSynchronousFrameLoader loads a resource into a ::com::sun::star::frame::Frame .
::com::sun::star::frame::XTask [ DEPRECATED ]
use ::com::sun::star::frame::XFrame instead of this one
::com::sun::star::frame::XTasksSupplier [ DEPRECATED ]
use ::com::sun::star::frame::XFramesSupplier instead of that
::com::sun::star::frame::XTerminateListener has to be provided if an object wants to receive an event when the master environment (e.g., desktop) is terminated.
::com::sun::star::frame::XToolbarController is an abstract service for a component which offers a more complex user interface to users within a toolbar.
::com::sun::star::frame::XToolbarControllerListener is used to notify a toolbar controller about events
::com::sun::star::frame::XTransientDocumentsDocumentContentFactory specifies a factory for ::com::sun::star::ucb::TransientDocumentsDocumentContent s.
::com::sun::star::frame::XUIControllerRegistration is used to query, register and unregister user interface controller.
::com::sun::star::frame::XUrlList [ DEPRECATED ]
::com::sun::star::frame::XWindowArranger [ DEPRECATED ]
Structs
::com::sun::star::frame::BorderWidths specifies a border area by offsets from each side.
::com::sun::star::frame::DispatchDescriptor describes a feature to be retrieved by a URL that has to be loaded into a specified frame
::com::sun::star::frame::DispatchInformation provides information about a supported command
::com::sun::star::frame::DispatchResultEvent contains the result of the dispatch action, if State is set to SUCCESS
::com::sun::star::frame::DispatchStatement represents a dispatch statement from a recorded macro
::com::sun::star::frame::FeatureStateEvent This event is broadcast by a ::com::sun::star::frame::Controller whenever the state of the feature changes
::com::sun::star::frame::FrameActionEvent this event struct is broadcast for actions which can happen to components within frames
Exceptions
::com::sun::star::frame::DoubleInitializationException This exception can be thrown in case an object is initialized second time.
::com::sun::star::frame::IllegalArgumentIOException This exception can be thrown in case arguments are wrong.
::com::sun::star::frame::TerminationVetoException can be thrown by a ::com::sun::star::frame::XTerminateListener to prevent the environment (e.g., desktop) from terminating
::com::sun::star::frame::UnknownModuleException This exception can be thrown in case an office * module could not be classified or does not have * a valid configuration.
Enums
::com::sun::star::frame::FrameAction these are the events which can happen to the components in frames of the desktop
Constant Groups
::com::sun::star::frame::CommandGroup provides information about a supported command
::com::sun::star::frame::DispatchResultState possible values for ::com::sun::star::frame::DispatchResultEvent
::com::sun::star::frame::FrameSearchFlag these types describe the algorithm to be used to search a frame
::com::sun::star::frame::LayoutManagerEvents provides information about layout manager events
::com::sun::star::frame::WindowArrange these constants are used to specify a style of window arrangement
Top of Page