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

This service is implemented by the handout presentation shape. More...

import"HandoutShape.idl";

Inheritance diagram for HandoutShape:
Shape PageShape Shape XPropertySet XShape XComponent XShapeDescriptor XGluePointsSupplier XTolerantMultiPropertySet XInterface XShapeDescriptor XInterface XInterface XInterface XInterface XInterface

Included Services

service com::sun::star::presentation::Shape
 
service com::sun::star::drawing::PageShape
 
- Included Services inherited from PageShape
service com::sun::star::drawing::Shape
 

Additional Inherited Members

- Exported Interfaces inherited from Shape
interface com::sun::star::beans::XPropertySet
 handles all the properties of this instance. More...
 
interface com::sun::star::drawing::XShape
 This gives you the size and position of this Shape and lets you change it. More...
 
interface com::sun::star::lang::XComponent
 is used for lifetime control of this Shape. More...
 
interface com::sun::star::drawing::XShapeDescriptor
 The XShapeDescriptor tells you what kind of Shape this instance is. More...
 
interface com::sun::star::drawing::XGluePointsSupplier
 This interfaces gives access to an optional container of gluepoints. More...
 
interface com::sun::star::beans::XTolerantMultiPropertySet
 
- 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 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 XShape
com::sun::star::awt::Point getPosition ()
 gets the current position of this object. More...
 
void setPosition ([in] com::sun::star::awt::Point aPosition)
 sets the current position of this object More...
 
com::sun::star::awt::Size getSize ()
 gets the size of this object. More...
 
void setSize ([in] com::sun::star::awt::Size aSize) raises ( com::sun::star::beans::PropertyVetoException )
 sets the size of this object. More...
 
- Public Member Functions inherited from XShapeDescriptor
string getShapeType ()
 
- 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 Attributes inherited from Shape
string Bookmark
 is a generic URL for the property OnClick. More...
 
com::sun::star::util::Color DimColor
 This is the color for dimming this shape. More...
 
boolean DimHide
 If this property and the property com::sun::star::drawing::Shape::DimPrev are both TRUE, the shape is hidden instead of dimmed to a color. More...
 
boolean DimPrevious
 If this property is TRUE, this shape is dimmed to the color of property com::sun::star::drawing::Shape::DimColor after executing its animation effect. More...
 
com::sun::star::presentation::AnimationEffect Effect
 selects the animation effect of this shape. More...
 
boolean IsEmptyPresentationObject
 If this is a default presentation object and if it is empty, this property is TRUE. More...
 
boolean IsPresentationObject
 If this is a presentation object, this property is TRUE. More...
 
com::sun::star::presentation::ClickAction OnClick
 selects an action performed after the user clicks on this shape. More...
 
boolean PlayFull
 If this property is TRUE, the sound of this shape is played in full. More...
 
long PresentationOrder
 This is the position of this shape in the order of the shapes which can be animated on its page. More...
 
string Sound
 This is the URL to a sound file that is played while the animation effect of this shape is running. More...
 
boolean SoundOn
 If this property is set to TRUE, a sound is played while the animation effect is executed. More...
 
com::sun::star::presentation::AnimationSpeed Speed
 This is the speed of the animation effect. More...
 
com::sun::star::presentation::AnimationEffect TextEffect
 This is the animation effect for the text inside this shape. More...
 
long Verb
 specifies an "OLE2" verb for the ClickAction VERB in the property com::sun::star::drawing::Shape::OnClick. More...
 
- Public Attributes inherited from PageShape
long PageNumber
 this is the page number that is used for the preview. More...
 
- Public Attributes inherited from Shape
long ZOrder
 is used to query or change the ZOrder of this Shape. More...
 
short LayerID
 This is the ID of the Layer to which this Shape is attached. More...
 
string LayerName
 This is the name of the Layer to which this Shape is attached. More...
 
boolean Visible
 If this is FALSE, the Shape is not visible on screen outputs. More...
 
boolean Printable
 If this is FALSE, the Shape is not visible on printer outputs. More...
 
boolean MoveProtect
 With this set to TRUE, this Shape cannot be moved interactively in the user interface. More...
 
string Name
 This is the name of this Shape. More...
 
boolean SizeProtect
 With this set to TRUE, this Shape may not be sized interactively in the user interface. More...
 
com::sun::star::style::XStyle Style
 this property lets you get and set a style for this shape. More...
 
com::sun::star::drawing::HomogenMatrix3 Transformation
 this property lets you get and set the transformation matrix for this shape. More...
 
com::sun::star::container::XNameContainer ShapeUserDefinedAttributes
 this property stores xml attributes. More...
 
long NavigationOrder
 this property stores the navigation order of this shape. More...
 
string Hyperlink
 this property lets you get and set a hyperlink for this shape. More...
 
sequence< com::sun::star::beans::PropertyValueInteropGrabBag
 Grab bag of shape properties, used as a string-any map for interim interop purposes. More...
 
short RelativeHeight
 contains the relative height of the object. More...
 
short RelativeWidth
 contains the relative width of the object. More...
 
short RelativeHeightRelation
 contains the relation of the relative height of the object. More...
 
short RelativeWidthRelation
 contains the relation of the relative width of the object. More...
 
string Title
 contains short title for the object More...
 
string Description
 contains description for the object More...
 
boolean Decorative
 Determines if the shape is purely decorative. More...
 
- Protected Member Functions inherited from XGluePointsSupplier
com::sun::star::container::XIndexContainer getGluePoints ()
 
- Protected Member Functions inherited from XTolerantMultiPropertySet
sequence< com::sun::star::beans::SetPropertyTolerantFailedsetPropertyValuesTolerant ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException )
 sets the values to the properties with the specified names. More...
 
sequence< com::sun::star::beans::GetPropertyTolerantResultgetPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve the values of the specified properties More...
 
sequence< com::sun::star::beans::GetDirectPropertyTolerantResultgetDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve only those values of the specified properties which are direct values. More...
 

Detailed Description

This service is implemented by the handout presentation shape.

Presentation shapes can be used in a presentation page layouts and their position and size is by default set by the presentation shapes on the com::sun::star::drawing::MasterPage.

Exported Interfaces

◆ com::sun::star::drawing::PageShape

◆ com::sun::star::presentation::Shape


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