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.

Services
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 an abstract service for accessing the document templates of the office and manipulate them ( add or rename or remove templates )
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 Frame s of the environment
FrameLoaderFactory | factory to create frame loader
FramesContainer | this is a special container which can contain frames
MediaTypeDetectionHelper | provides for mapping a given sequence of content identifier strings to a sequence of respective media (mime) types
ProtocolHandler | special dispatch provider registered for URL protocols
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 ]
SynchronousFrameLoader | derivations of this abstract service are used to load components into Frame s of the environment
Task | [ DEPRECATED ] represents a top level frame in the frame hierarchy with the desktop as root
TemplateAccess | provides a high level api to organize document templates

Interfaces
XBrowseHistoryRegistry | [ DEPRECATED ]
XComponentLoader | this is a simple interface to load components by an URL into a frame environment
XComponentRegistry | [ DEPRECATED ]
XConfigManager | [ DEPRECATED ]
XController | With this interface, components viewed in a Frame can serve events (by supplying dispatches).
XDesktop | This is the main interface of a desktop service.
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 any easy dispatch interfaces for certain functions which are useful at the UI.
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.
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
XInterceptorInfo | makes it possible to get information about a registered interceptor and is used by frame interceptor mechanism to perform interception.
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.
XModel | represents a component which is created from an URL and arguments.
XNotifyingDispatch | dispatch with guaranteed notify (instead of XDispatch )
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 |
XStatusListener | makes it possible to receive events when the state of a feature changes.
XStorable | offers a simple way to store a component to an URL.
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.
XUrlList | [ DEPRECATED ]
XWindowArranger | [ DEPRECATED ]

Structs
DispatchDescriptor | describes a feature to be retrieved by a URL that has to be loaded into a specified frame
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

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

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

Constant Groups
DispatchResultState | possible values for DispatchResultEvent
FrameSearchFlag | these types describe the algorithm to be used to search a frame
WindowArrange | these constants are used to specify a style of window arrangement

Top of Page

Copyright © 2003 Sun Microsystems, Inc.