LibreOffice
LibreOffice 24.2 SDK API Reference
|
specifies a document which consists of multiple pages with drawings. More...
import"GenericDrawingDocument.idl";
Included Services | |
service | com::sun::star::document::OfficeDocument |
this base service describes storing and printing More... | |
Exported Interfaces | |
interface | com::sun::star::lang::XMultiServiceFactory |
this factory lets you create various services that are used inside a drawing document More... | |
interface | com::sun::star::beans::XPropertySet |
lets you access the properties of this service. More... | |
interface | com::sun::star::drawing::XDrawPageDuplicator |
lets you duplicate pages inside this document. More... | |
interface | com::sun::star::drawing::XDrawPagesSupplier |
provides an object that is implementing the service DrawPages. More... | |
interface | com::sun::star::drawing::XMasterPagesSupplier |
returns an object that is implementing the service MasterPages. More... | |
interface | com::sun::star::drawing::XLayerSupplier |
returns an object that is implementing the service LayerManager. More... | |
interface | com::sun::star::style::XStyleFamiliesSupplier |
This interface lets you access the styles contained in this document. More... | |
Exported Interfaces inherited from OfficeDocument | |
interface | com::sun::star::frame::XModel |
represents a component which is created from a URL and arguments More... | |
interface | com::sun::star::util::XModifiable |
a storable document should provide information about his modify state More... | |
interface | com::sun::star::frame::XStorable |
offers a simple way to store a component to a URL More... | |
interface | com::sun::star::view::XPrintable |
offers a way to print a component More... | |
interface | XEventBroadcaster |
is an old and deprecated version of the XDocumentEventBroadcaster interface More... | |
interface | XDocumentEventBroadcaster |
makes it possible to register listeners which are called whenever a document event occurs More... | |
interface | XEventsSupplier |
access to bound event handlers More... | |
interface | XViewDataSupplier |
access to some properties describing all open views to a document More... | |
interface | com::sun::star::view::XPrintJobBroadcaster |
allows for getting information about a print job More... | |
interface | XEmbeddedScripts |
is supported when the document can contain scripts and dialogs More... | |
interface | XDocumentPropertiesSupplier |
access to the DocumentProperties. More... | |
interface | XUndoManagerSupplier |
provides access to the document's undo manager. More... | |
Public Attributes | |
long | TabStop |
This property specifies the length between the default tab stops inside text in this document in 1/100th mm. More... | |
com::sun::star::lang::Locale | CharLocale |
contains the identifier of the default locale of the document. More... | |
com::sun::star::awt::Rectangle | VisibleArea |
if this document is an OLE client, this is the current visible area in 100th mm More... | |
com::sun::star::i18n::XForbiddenCharacters | ForbiddenCharacters |
This property gives the XForbiddenCharacters. More... | |
Public Attributes inherited from OfficeDocument | |
boolean | AutomaticControlFocus |
controls the focus behavior of the form controls in the document More... | |
boolean | ApplyFormDesignMode |
controls the initial (on-load) behavior of the form controls in the document More... | |
string | RuntimeUID |
contains a unique id for the document More... | |
sequence< com::sun::star::beans::PropertyValue > | InteropGrabBag |
Grab bag of document properties, used as a string-any map for interim interop purposes. More... | |
Additional Inherited Members | |
Public Member Functions inherited from XModel | |
boolean | attachResource ([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Arguments) |
informs a model about its resource description. More... | |
string | getURL () |
provides information about the location of this model More... | |
sequence< com::sun::star::beans::PropertyValue > | getArgs () |
provides read access on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state More... | |
void | connectController ([in] XController Controller) |
is called whenever a new controller is created for this model. More... | |
void | disconnectController ([in] XController Controller) |
is called whenever an existing controller should be deregistered at this model. More... | |
void | lockControllers () |
suspends some notifications to the controllers which are used for display updates. More... | |
void | unlockControllers () |
resumes the notifications which were suspended by XModel::lockControllers(). More... | |
boolean | hasControllersLocked () |
determines if there is at least one lock remaining. More... | |
XController | getCurrentController () |
provides access to the controller which currently controls this model More... | |
void | setCurrentController ([in] XController Controller) raises ( com::sun::star::container::NoSuchElementException ) |
sets a registered controller as the current controller. More... | |
com::sun::star::uno::XInterface | getCurrentSelection () |
provides read access on current selection on controller More... | |
Public Member Functions inherited from XComponent | |
void | dispose () |
The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More... | |
void | addEventListener ([in] XEventListener xListener) |
adds an event listener to the object. More... | |
void | removeEventListener ([in] XEventListener aListener) |
removes an event listener from the listener list. More... | |
Public Member Functions inherited from XInterface | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. More... | |
void | acquire () |
increases the reference counter by one. More... | |
void | release () |
decreases the reference counter by one. More... | |
Public Member Functions inherited from XModifiable | |
boolean | isModified () |
void | setModified ([in] boolean bModified) raises ( com::sun::star::beans::PropertyVetoException ) |
sets the status of the modified-flag from outside of the object. More... | |
Public Member Functions inherited from XModifyBroadcaster | |
void | addModifyListener ([in] com::sun::star::util::XModifyListener aListener) |
adds the specified listener to receive events "modified." More... | |
void | removeModifyListener ([in] com::sun::star::util::XModifyListener aListener) |
removes the specified listener. More... | |
Public Member Functions inherited from XStorable | |
boolean | hasLocation () |
The object may know the location because it was loaded from there, or because it is stored there. More... | |
string | getLocation () |
After XStorable::storeAsURL() it returns the URL the object was stored to. More... | |
boolean | isReadonly () |
It is not possible to call XStorable::store() successfully when the data store is read-only. More... | |
void | store () raises ( com::sun::star::io::IOException ) |
stores the data to the URL from which it was loaded. More... | |
void | storeAsURL ([in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > lArguments) raises ( com::sun::star::io::IOException ) |
stores the object's persistent data to a URL and makes this URL the new location of the object. More... | |
void | storeToURL ([in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > lArguments) raises ( com::sun::star::io::IOException ) |
stores the object's persistent data to a URL and continues to be a representation of the old URL. More... | |
Public Member Functions inherited from XPrintable | |
sequence< com::sun::star::beans::PropertyValue > | getPrinter () |
void | setPrinter ([in] sequence< com::sun::star::beans::PropertyValue > aPrinter) raises ( com::sun::star::lang::IllegalArgumentException ) |
assigns a new printer to the object. More... | |
void | print ([in] sequence< com::sun::star::beans::PropertyValue > xOptions) raises ( com::sun::star::lang::IllegalArgumentException ) |
prints the object. More... | |
Public Member Functions inherited from XMultiServiceFactory | |
com::sun::star::uno::XInterface | createInstance ([in] string aServiceSpecifier) raises ( com::sun::star::uno::Exception ) |
Creates an instance classified by the specified name. More... | |
com::sun::star::uno::XInterface | createInstanceWithArguments ([in] string ServiceSpecifier, [in] sequence< any > Arguments) raises ( com::sun::star::uno::Exception ) |
Creates an instance classified by the specified name and passes the arguments to that instance. More... | |
sequence< string > | getAvailableServiceNames () |
Provides the available names of the factory to be used to create instances. More... | |
Public Member Functions inherited from XPropertySet | |
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the value of the property with the specified name. More... | |
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XPropertyChangeListener to the specified property. More... | |
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XPropertyChangeListener from the listener list. More... | |
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XVetoableChangeListener from the listener list. More... | |
Public Member Functions inherited from XDrawPageDuplicator | |
com::sun::star::drawing::XDrawPage | duplicate ([in] com::sun::star::drawing::XDrawPage xPage) |
creates a duplicate of a DrawPage or MasterPage, including the Shapes on that page and inserts it into the same model. More... | |
Public Member Functions inherited from XDrawPagesSupplier | |
com::sun::star::drawing::XDrawPages | getDrawPages () |
Public Member Functions inherited from XMasterPagesSupplier | |
com::sun::star::drawing::XDrawPages | getMasterPages () |
Public Member Functions inherited from XLayerSupplier | |
com::sun::star::container::XNameAccess | getLayerManager () |
Public Member Functions inherited from XStyleFamiliesSupplier | |
com::sun::star::container::XNameAccess | getStyleFamilies () |
This method returns the collection of style families available in the container document. More... | |
Protected Member Functions inherited from XEventBroadcaster | |
void | addEventListener ([in] XEventListener Listener) |
registers the given listener More... | |
void | removeEventListener ([in] XEventListener Listener) |
unregisters the given listener More... | |
Protected Member Functions inherited from XDocumentEventBroadcaster | |
void | addDocumentEventListener ([in] XDocumentEventListener Listener) |
registers a listener which is notified about document events More... | |
void | removeDocumentEventListener ([in] XDocumentEventListener Listener) |
revokes a listener which has previously been registered to be notified about document events. More... | |
void | notifyDocumentEvent ([in] string EventName, [in] ::com::sun::star::frame::XController2 ViewController, [in] any Supplement) raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException ) |
causes the broadcaster to notify all registered listeners of the given event More... | |
Protected Member Functions inherited from XEventsSupplier | |
com::sun::star::container::XNameReplace | getEvents () |
offers a list of event handlers which are be bound to events of this object More... | |
Protected Member Functions inherited from XViewDataSupplier | |
::com::sun::star::container::XIndexAccess | getViewData () |
retrieve information about currently opened view to restore it later More... | |
void | setViewData ([in] com::sun::star::container::XIndexAccess Data) |
restore all views which will be represented by given data argument More... | |
Protected Member Functions inherited from XPrintJobBroadcaster | |
void | addPrintJobListener ([in] XPrintJobListener xListener) |
adds an XPrintJobListener to be notified about print progress. More... | |
void | removePrintJobListener ([in] XPrintJobListener xListener) |
removes an XPrintJobListener. More... | |
Protected Member Functions inherited from XDocumentPropertiesSupplier | |
XDocumentProperties | getDocumentProperties () |
provides the document properties object. More... | |
Protected Member Functions inherited from XUndoManagerSupplier | |
XUndoManager | getUndoManager () |
returns the Undo manager associated with the component. More... | |
Protected Attributes inherited from XEmbeddedScripts | |
::com::sun::star::script::XStorageBasedLibraryContainer | BasicLibraries |
is the container of StarBasic macro libraries contained in the document More... | |
::com::sun::star::script::XStorageBasedLibraryContainer | DialogLibraries |
is the container of dialogs libraries contained in the document More... | |
boolean | AllowMacroExecution |
determines whether executing macros from this document is allowed. More... | |
specifies a document which consists of multiple pages with drawings.
Because its function is needed more than once, it's defined as generic one.
this base service describes storing and printing
interface com::sun::star::beans::XPropertySet |
lets you access the properties of this service.
lets you duplicate pages inside this document.
interface com::sun::star::drawing::XLayerSupplier |
returns an object that is implementing the service LayerManager.
This service lets you manipulate the Layers of this document.
returns an object that is implementing the service MasterPages.
With this service you have access to the MasterPages inside a document.
this factory lets you create various services that are used inside a drawing document
The following services are Shapes. They are created by the documents factory and must be inserted into a DrawPage or MasterPage of this document.
The following services are all com::sun::star::text::TextField and can be inserted into text as com::sun::star::text::TextContent.
The following services gives access to resources used inside the document and let you add new resources.
The following service can be set at the Numbering
property inside a com::sun::star::style::ParagraphProperties
The following services can be used for a com::sun::star::image::ImageMap inside the document.
A com::sun::star::image::ImageMap can be obtained from a GraphicObjectShape
The following services lets you access the drawing property defaults of a document.
This interface lets you access the styles contained in this document.
|
property |
contains the identifier of the default locale of the document.
|
propertyreadonly |
This property gives the XForbiddenCharacters.
|
property |
This property specifies the length between the default tab stops inside text in this document in 1/100th mm.
|
property |
if this document is an OLE client, this is the current visible area in 100th mm