| Overview | Module | Use | Devguide | Index |
| Nested Modules | Services | Singletons | Interfaces | Structs | Exceptions | Enums | Typedefs | Constant Groups |
| module embed |
| Services | |
| BaseStorage | This is a service that allows to get access to a storage hierarchy. |
| DocumentCloser | The main task of this service is to close an office document frame embedded in an application running in another process correctly. |
| EmbeddedObjectDescriptor | describes properties of an embedded object |
| FileSystemStorage | This is a service that allows to get access to a file system folder using storage hierarchy. |
| FileSystemStorageFactory | The FileSystemStorageFactory is a service that allows to create a FileSystemStorage based on URL. The URL must point to a folder. |
| InstanceLocker | The main task of this service is to prevent closing, terminating and/or etc. of controlled object. |
| OLESimpleStorage | This service provides a simple functionality to allow read/write the storages in OLE storage format. |
| Storage | This is a service that allows to get access to a package using storage hierarchy. |
| StorageFactory | The StorageFactory is a service that allows to create a storage based on either stream or URL. |
| StorageStream | This is a service that represents a stream that can be provided by XStorage::openStreamElement() call implemented by Storage service. |
| Interfaces | |
| XActionsApproval | allows to request an approval for an action. |
| XClassifiedObject | represents common functionality for embedded objects |
| XCommonEmbedPersist | specifies common implementation for embedded objects and links persistence. |
| XComponentSupplier | provides access to a component. |
| XEmbedObjectClipboardCreator | allows to create and initialize a new embedded object from clipboard. |
| XEmbedObjectCreator | allows to create and initialize a new embedded object. |
| XEmbedObjectFactory | allows to create and initialize a new embedded object of specified type. |
| XEmbedPersist | specifies an implementation for embedded object persistence. |
| XEmbeddedClient | represents common functionality for embedded clients. |
| XEmbeddedObject | represents common functionality for embedded objects. |
| XEncryptionProtectedSource | This interface allows to set a password for an object. |
| XEncryptionProtectedSource2 | This interface allows to set a password for an object. |
| XEncryptionProtectedStorage | This interface allows to set a password for an object. |
| XExtendedStorageStream | This interface allows access to an extended storage stream that might be transacted. |
| XHatchWindow | specifies the operations for a hatch window. |
| XHatchWindowController | specifies the operations for a hatch window. |
| XHatchWindowFactory | creates a hatch window implementation. |
| XHierarchicalStorageAccess | This interface allows hierarchical access to storage tree. |
| XHierarchicalStorageAccess2 | This interface extends XHierarchicalStorageAccess interface. |
| XInplaceClient | represents common functionality for inplace clients. |
| XInplaceObject | represents common functionality for inplace embedded objects. |
| XInsertObjectDialog | allows to create and initialize a new embedded object using GUI dialog. |
| XLinkCreator | allows to create and initialize a new link. |
| XLinkFactory | allows to create and initialize a new link of specified type. |
| XLinkageSupport | specifies an additional implementation for linked embedded object support. |
| XOLESimpleStorage | This interface allows to access and change contents of OLE storages. |
| XOptimizedStorage | This is a temporary interface that is introduced to temporarily optimize the document storing process. PLEASE DO NOT USE IT, it might change in any time and will be depricated soon! Another solution will be introduced as final one. |
| XPackageStructureCreator | allows to convert file system folder tree in to a package. |
| XPersistanceHolder | allows to disconnect an object from its persistence. |
| XRelationshipAccess | This interface allows to ge access to relationship data. |
| XStateChangeBroadcaster | broadcasts message in case embedded object object changes it's state. |
| XStateChangeListener | makes it possible to receive events when an embedded object changes it's state. |
| XStorage | This interface represents main storage functionality. |
| XStorage2 | This interface extends the base XStorage interface. |
| XStorageRawAccess | This interface represents main storage functionality. |
| XTransactedObject | allows transacted access to an object. |
| XTransactionBroadcaster | broadcasts messege in case transacted object is commited or reverted. |
| XTransactionListener | makes it possible to receive events when a transacted object is commited or reverted. |
| XTransferableSupplier | provide access to a ::com::sun::star::datatransfer::XTransferable implementation from the object. |
| XVisualObject | represents common visualisation functionality for embedded objects. |
| XWindowSupplier | provides access to a vcl window implementation. |
| Structs | |
| InsertedObjectInfo | is intended to provide result of creation of an embedded object by dialog. |
| VerbDescriptor | describes a verb. |
| VisualRepresentation | can contain a graphical representation in an arbitrary format. |
| Exceptions | |
| InvalidStorageException | This exception can be thrown in case a storage is invalid. |
| LinkageMisuseException | This exception can be thrown in case a linked object is misused. |
| NeedsRunningStateException | This exception can be thrown in case a list of accepted verbs of states is requested and the object is in loaded state and this information can be retrieved only when the object is in running state. |
| NoVisualAreaSizeException | This exception can be thrown in case the object can not provide own visual area currently. |
| ObjectSaveVetoException | This exception can be thrown in case container whants to avoid objects saving. |
| StateChangeInProgressException | This exception can be thrown in case the object does not allow to call requested functionality currently because the object is changing state. |
| StorageWrappedTargetException | This exception can wrap an exception thrown during XStorage methods execution. |
| UnreachableStateException | This exception can be thrown in case specified state can not be reached. |
| UseBackupException | This exception can be thrown in case a storage commit is failed. |
| WrongStateException | This exception can be thrown in case the object's state does not allow to call requested functionality. |
| Constant Groups | |
| Actions | This constant set contains possible actions that could be approved by ::ActionsApproval implementation. |
| Aspects | The constant set contains possible aspects for an embedded object. |
| ElementModes | The constant set contains possible modes to open an element. |
| EmbedMapUnits | contains list of possible map modes supported by embedded object. |
| EmbedMisc | The constant set contains flags describing miscellaneous charactetistics of embedded objects. |
| EmbedStates | This constant set contains possible states for ::EmbeddedObject. |
| EmbedUpdateModes | The constant set specifies possible modes of object update. |
| EmbedVerbs | This constants set contains possible verbs for a contained object. |
| EntryInitModes | This constant set contains possible modes to initialize object persistance. |
| StorageFormats | The constant set contains IDs of formats that are supported by StorageFactory. |
| VerbAttributes | The constant set specifies possible attributes of a verb. |
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
