ooodev.adapter.presentation.shape_properties_partial module
- class ooodev.adapter.presentation.shape_properties_partial.ShapePropertiesPartial(component)[source]
Bases:
object
Partial class for Presentation Shape.
See also
- Parameters:
component (Shape) –
- __init__(component)[source]
Constructor
- Parameters:
component (Shape) – UNO Component that implements
com.sun.star.presentation.Shape
service.- Return type:
None
- property bookmark: str
Gets/Sets a generic URL for the property
on_click
.- Return type:
str
- property dim_color: Color
This is the color for dimming this shape.
This color is used if the property
dim_prev
isTrue
anddim_hide
isFalse
.- Returns:
Color
- Return type:
- property dim_hide: bool
Gets/Sets - If this property and the property
dim_prev
are bothTrue
, the shape is hidden instead of dimmed to a color.- Return type:
bool
- property dim_previous: bool
Gets/Sets - If this property is
True
, this shape is dimmed to the color of propertydim_color
after executing its animation effect.- Return type:
bool
- property effect: AnimationEffect
Gets/Sets the animation effect of this shape.
- Returns:
Animation effect.
- Return type:
AnimationEffect
Hint
AnimationEffect
can be imported fromooo.dyn.presentation.animation_effect
.
- property is_empty_presentation_object: bool
Gets - If this is a default presentation object and if it is empty, this property is
True
.- Return type:
bool
- property is_presentation_object: bool
Gets if this is a presentation object, this property is TRUE.
Presentation objects are objects like
TitleTextShape
andOutlinerShape
.- Return type:
bool
- property on_click: ClickAction
Gets/Sets an action performed after the user clicks on this shape.
- Returns:
Click action.
- Return type:
ClickAction
Hint
ClickAction
can be imported fromooo.dyn.presentation.click_action
.
- property play_full: bool
Gets/Sets - If this property is
True
, the sound of this shape is played in full.The default behavior is to stop the sound after completing the animation effect.
- Return type:
bool
- property presentation_order: int
This is the position of this shape in the order of the shapes which can be animated on its page.
The animations are executed in this order, starting at the shape with the PresentationOrder
1
. You can change the order by changing this number. Setting it to1
makes this shape the first shape in the execution order for the animation effects.- Return type:
int
- property sound: str
Gets/Sets the URL to a sound file that is played while the animation effect of this shape is running.
- Return type:
str
- property sound_on: bool
Gets/sets - If this property is set to
True
, a sound is played while the animation effect is executed.- Return type:
bool
- property speed: AnimationSpeed
This is the speed of the animation effect.
- Return type:
AnimationSpeed
- property text_effect: AnimationEffect
Gets/Sets the animation effect for the text inside this shape.
- Return type:
AnimationEffect
- property verb: int
Gets/Sets an
OLE2
verb for the ClickAction VERB in the propertyon_click
.- Return type:
int