LibreOffice
LibreOffice 24.2 SDK API Reference
Included Services | List of all members
MasterPage Service Referencepublished

This service is a single master page inside a drawing document. More...

import"MasterPage.idl";

Inheritance diagram for MasterPage:
GenericDrawPage XShapes XShapeGrouper XShapeCombiner XShapeBinder XNamed XPropertySet XIndexAccess XInterface XInterface XInterface XInterface XInterface XElementAccess XInterface

Included Services

service com::sun::star::drawing::GenericDrawPage
 This service describes the base functionality that every draw/master page has. More...
 

Additional Inherited Members

- Exported Interfaces inherited from GenericDrawPage
interface com::sun::star::drawing::XShapes
 manages the Shapes of this page. More...
 
interface com::sun::star::drawing::XShapeGrouper
 With this interface you can group/ungroup a collection of Shapes. More...
 
interface com::sun::star::drawing::XShapeCombiner
 With this interface you can combine/split a collection of Shapes. More...
 
interface com::sun::star::drawing::XShapeBinder
 With this interface you can bind/unbind a collection of Shapes. More...
 
interface com::sun::star::container::XNamed
 Gets or sets the name of this page. More...
 
interface com::sun::star::beans::XPropertySet
 gives you access to the properties of this DrawPage. More...
 
- Public Member Functions inherited from XShapes
void add ([in] com::sun::star::drawing::XShape xShape)
 inserts a Shape into this collection. More...
 
void remove ([in] com::sun::star::drawing::XShape xShape)
 removes a Shape from this collection. More...
 
- Public Member Functions inherited from XIndexAccess
long getCount ()
 
any getByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException )
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- 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 XShapeGrouper
com::sun::star::drawing::XShapeGroup group ([in] com::sun::star::drawing::XShapes xShapes)
 groups the Shapes inside a collection. More...
 
void ungroup ([in] com::sun::star::drawing::XShapeGroup aGroup)
 ungroups a given GroupShape. More...
 
- Public Attributes inherited from GenericDrawPage
long BorderBottom
 This is the border at the bottom. More...
 
long BorderLeft
 This is the border at the left. More...
 
long BorderRight
 This is the border at the right. More...
 
long BorderTop
 This is the border at the top. More...
 
long Height
 This is the height. More...
 
long Width
 This is the width. More...
 
short Number
 This is the number of this page, starting with 1. More...
 
com::sun::star::view::PaperOrientation Orientation
 This is the orientation of this page. More...
 
com::sun::star::container::XNameContainer UserDefinedAttributes
 this property stores xml attributes. More...
 
boolean IsBackgroundDark
 this property is true if the averaged background filling colors luminance is below an application specified threshold value. More...
 
com::sun::star::container::XIndexAccess NavigationOrder
 this index access defines a navigation order for the top level shapes inside this page. More...
 
boolean BackgroundFullSize
 does the background cover the full page or only inside the margins? More...
 
- Protected Member Functions inherited from XShapeCombiner
com::sun::star::drawing::XShape combine ([in] com::sun::star::drawing::XShapes xShapes)
 combines Shapes More...
 
void split ([in] com::sun::star::drawing::XShape Group)
 splits Shapes. More...
 
- Protected Member Functions inherited from XShapeBinder
com::sun::star::drawing::XShape bind ([in] com::sun::star::drawing::XShapes xShapes)
 binds Shapes together. More...
 
void unbind ([in] com::sun::star::drawing::XShape xShape)
 breaks a Shape into its line segments More...
 
- Protected Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 
- Protected 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...
 

Detailed Description

This service is a single master page inside a drawing document.

It serves as a background page for zero or more DrawPages. Since this service is derived from the service GenericDrawPage, it can be used as a draw page with three differences:

  1. It is not linked to any other MasterPage.
  2. It cannot be removed from a document as long as one or more instances of DrawPage are linked to it.
  3. Modifications to a MasterPage are instantly visible on every DrawPage that is linked to it.

Exported Interfaces

◆ com::sun::star::drawing::GenericDrawPage

This service describes the base functionality that every draw/master page has.


The documentation for this service was generated from the following file: