spire-presentation 10.6.4__py3-none-win_amd64.whl → 10.8.1__py3-none-win_amd64.whl

spire/presentation/SimpleShapeBaseLocking.py

@@ -8,14 +8,20 @@ import abc
 
 class SimpleShapeBaseLocking (  BaseShapeLocking) :
     """
-
+    Provides locking properties for simple shapes in presentations.
+    
+    This class allows controlling various protection settings that determine
+    which operations are disabled on parent Autoshape elements.
     """
     @property
     def GroupingProtection(self)->bool:
         """
-    <summary>
-        Indicates whether an adding this shape to a group Disallow.
-    </summary>
+        Gets or sets whether adding this shape to groups is disallowed.
+        
+        Returns:
+            bool: 
+            True = Adding to groups is disabled
+            False = Adding to groups is allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_GroupingProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_GroupingProtection.restype=c_bool
@@ -24,15 +30,26 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
 
     @GroupingProtection.setter
     def GroupingProtection(self, value:bool):
+        """
+        Sets whether adding this shape to groups is disallowed.
+        
+        Args:
+            value (bool): 
+            True to disable adding to groups
+            False to allow adding to groups
+        """
         GetDllLibPpt().SimpleShapeBaseLocking_set_GroupingProtection.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().SimpleShapeBaseLocking_set_GroupingProtection,self.Ptr, value)
 
     @property
     def SelectionProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a selecting this shape Disallow.
-    </summary>
+        Gets or sets whether selecting this shape is disallowed.
+        
+        Returns:
+            bool: 
+            True = Selecting is disabled
+            False = Selecting is allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_SelectionProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_SelectionProtection.restype=c_bool
@@ -47,9 +64,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def RotationProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a changing rotation angle of this shape Disallow.
-    </summary>
+        Gets or sets whether changing rotation angle is disallowed.
+        
+        Returns:
+            bool: 
+            True = Rotation changes are disabled
+            False = Rotation changes are allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_RotationProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_RotationProtection.restype=c_bool
@@ -64,9 +84,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def AspectRatioProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a shape have to preserve aspect ratio on resizing.
-    </summary>
+        Gets or sets whether preserving aspect ratio on resize is enforced.
+        
+        Returns:
+            bool: 
+            True = Aspect ratio must be preserved
+            False = Aspect ratio can be changed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_AspectRatioProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_AspectRatioProtection.restype=c_bool
@@ -81,9 +104,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def PositionProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a moving this shape Disallow.
-    </summary>
+        Gets or sets whether moving this shape is disallowed.
+        
+        Returns:
+            bool: 
+            True = Moving is disabled
+            False = Moving is allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_PositionProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_PositionProtection.restype=c_bool
@@ -98,9 +124,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def ResizeProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a resizing this shape Disallow.
-    </summary>
+        Gets or sets whether resizing this shape is disallowed.
+        
+        Returns:
+            bool: 
+            True = Resizing is disabled
+            False = Resizing is allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_ResizeProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_ResizeProtection.restype=c_bool
@@ -115,9 +144,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def EditPointProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a direct changing of contour of this shape Disallow.
-    </summary>
+        Gets or sets whether direct contour editing is disallowed.
+        
+        Returns:
+            bool: 
+            True = Contour editing is disabled
+            False = Contour editing is allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_EditPointProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_EditPointProtection.restype=c_bool
@@ -132,9 +164,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def AdjustHandlesProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a changing adjust values Disallow.
-    </summary>
+        Gets or sets whether changing adjust values is disallowed.
+        
+        Returns:
+            bool: 
+            True = Adjust handle changes are disabled
+            False = Adjust handle changes are allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_AdjustHandlesProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_AdjustHandlesProtection.restype=c_bool
@@ -149,9 +184,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def ArrowheadChangesProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a changing arrowheads Disallow.
-    </summary>
+        Gets or sets whether changing arrowheads is disallowed.
+        
+        Returns:
+            bool: 
+            True = Arrowhead changes are disabled
+            False = Arrowhead changes are allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_ArrowheadChangesProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_ArrowheadChangesProtection.restype=c_bool
@@ -166,9 +204,12 @@ class SimpleShapeBaseLocking (  BaseShapeLocking) :
     @property
     def ShapeTypeProtection(self)->bool:
         """
-    <summary>
-        Indicates whether a changing of a shape type Disallow.
-    </summary>
+        Gets or sets whether changing shape type is disallowed.
+        
+        Returns:
+            bool: 
+            True = Shape type changes are disabled
+            False = Shape type changes are allowed
         """
         GetDllLibPpt().SimpleShapeBaseLocking_get_ShapeTypeProtection.argtypes=[c_void_p]
         GetDllLibPpt().SimpleShapeBaseLocking_get_ShapeTypeProtection.restype=c_bool

spire/presentation/SlideBackground.py

@@ -8,18 +8,22 @@ import abc
 
 class SlideBackground (  IActiveSlide) :
     """
-    <summary>
-        Represents background of a slide.
-    </summary>
+    Represents the background of a slide.
+    
+    Attributes:
+        Type (BackgroundType): Gets or sets the type of background fill.
+        EffectDag (EffectDag): Gets the Effect Dag object.
+        Fill (FillFormat): Gets or sets the FillFormat for BackgroundType.OwnBackground fill.
+        ThemeColor (ColorFormat): Gets or sets the ColorFormat for themed fill.
+        ThemeIndex (UInt16): Gets or sets the index of the theme (0-999, 0 means no fill).
+        Slide (ActiveSlide): Gets the parent slide of the shape (read-only).
+        Presentation (Presentation): Gets the parent presentation of the slide (read-only).
     """
     @property
 
     def Type(self)->'BackgroundType':
         """
-    <summary>
-        Gets a type of background fill.
-            Read/write <see cref="T:Spire.Presentation.Drawing.BackgroundType" />.
-    </summary>
+        Gets or sets the type of background fill.
         """
         GetDllLibPpt().SlideBackground_get_Type.argtypes=[c_void_p]
         GetDllLibPpt().SlideBackground_get_Type.restype=c_int
@@ -36,9 +40,7 @@ class SlideBackground (  IActiveSlide) :
 
     def EffectDag(self)->'EffectDag':
         """
-    <summary>
-        Gets Effect Dag.
-    </summary>
+        Gets the Effect Dag.
         """
         GetDllLibPpt().SlideBackground_get_EffectDag.argtypes=[c_void_p]
         GetDllLibPpt().SlideBackground_get_EffectDag.restype=c_void_p
@@ -51,10 +53,7 @@ class SlideBackground (  IActiveSlide) :
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
-        Gets a FillFormat for BackgroundType.OwnBackground fill.
-            Readonly <see cref="P:Spire.Presentation.SlideBackground.Fill" />.
-    </summary>
+        Gets or sets the FillFormat for BackgroundType.OwnBackground fill.
         """
         GetDllLibPpt().SlideBackground_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().SlideBackground_get_Fill.restype=c_void_p
@@ -72,10 +71,7 @@ class SlideBackground (  IActiveSlide) :
 
     def ThemeColor(self)->'ColorFormat':
         """
-    <summary>
-        Return a ColorFormat for Themed fill.
-            Readonly <see cref="T:Spire.Presentation.Drawing.ColorFormat" />.
-    </summary>
+        Gets or sets the ColorFormat for themed fill.
         """
         GetDllLibPpt().SlideBackground_get_ThemeColor.argtypes=[c_void_p]
         GetDllLibPpt().SlideBackground_get_ThemeColor.restype=c_void_p
@@ -93,10 +89,7 @@ class SlideBackground (  IActiveSlide) :
 
     def ThemeIndex(self)->'UInt16':
         """
-    <summary>
-        Gets an index of Theme.
-            0..999, 0 eqauls no fill.
-    </summary>
+        Gets or sets the index of the theme (0-999, 0 means no fill).
         """
         GetDllLibPpt().SlideBackground_get_ThemeIndex.argtypes=[c_void_p]
         GetDllLibPpt().SlideBackground_get_ThemeIndex.restype=c_void_p
@@ -113,11 +106,13 @@ class SlideBackground (  IActiveSlide) :
 
     def GetBackgroundFillFormat(self ,slide:'ActiveSlide')->'FillFormat':
         """
-    <summary>
-        Gets slide's background fillformat.
-            Read only <see cref="M:Spire.Presentation.SlideBackground.GetBackgroundFillFormat(Spire.Presentation.ActiveSlide)" />.
-    </summary>
-    <param name="slide">the slide with current background.</param>
+        Gets the slide's background fill format.
+        
+        Args:
+            slide (ActiveSlide): The slide with current background.
+        
+        Returns:
+            FillFormat: The fill format of the background.
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -131,7 +126,13 @@ class SlideBackground (  IActiveSlide) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current object.
+        
+        Args:
+            obj (SpireObject): The object to compare with.
+            
+        Returns:
+            bool: True if the objects are equal, otherwise False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -144,10 +145,7 @@ class SlideBackground (  IActiveSlide) :
 
     def Slide(self)->'ActiveSlide':
         """
-    <summary>
-        Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        Gets the parent slide of the shape (read-only).
         """
         GetDllLibPpt().SlideBackground_get_Slide.argtypes=[c_void_p]
         GetDllLibPpt().SlideBackground_get_Slide.restype=c_void_p
@@ -160,10 +158,7 @@ class SlideBackground (  IActiveSlide) :
 
     def Presentation(self)->'Presentation':
         """
-    <summary>
-        Gets the parent presentation of a slide.
-            Read-only <see cref="T:Spire.Presentation.PresentationPptx" />.
-    </summary>
+        Gets the parent presentation of the slide (read-only).
         """
         GetDllLibPpt().SlideBackground_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().SlideBackground_get_Presentation.restype=c_void_p

spire/presentation/SlideColorScheme.py

@@ -8,17 +8,16 @@ import abc
 
 class SlideColorScheme (SpireObject) :
     """
-    <summary>
-        Represents an additional color scheme which can be assigned to a slide.
-    </summary>
+    Represents an additional color scheme which can be assigned to a slide.
     """
     @property
 
     def Name(self)->str:
         """
-    <summary>
-        Gets a name of this scheme.
-    </summary>
+        Gets the name of this scheme.
+
+        Returns:
+            str: The name of the color scheme.
         """
         GetDllLibPpt().SlideColorScheme_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().SlideColorScheme_get_Name.restype=c_void_p
@@ -30,10 +29,10 @@ class SlideColorScheme (SpireObject) :
 
     def ColorScheme(self)->'ColorScheme':
         """
-    <summary>
-        Gets a color scheme.
-            Readonly <see cref="T:Spire.Presentation.Drawing.ColorScheme" />.
-    </summary>
+        Gets the color scheme.
+
+        Returns:
+            ColorScheme: The associated color scheme object.
         """
         GetDllLibPpt().SlideColorScheme_get_ColorScheme.argtypes=[c_void_p]
         GetDllLibPpt().SlideColorScheme_get_ColorScheme.restype=c_void_p
@@ -45,7 +44,13 @@ class SlideColorScheme (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Checks equality with another object.
+
+        Args:
+            obj (SpireObject): The object to compare.
 
+        Returns:
+            bool: True if objects are equal, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/SlideLayoutType.py

@@ -8,9 +8,45 @@ import abc
 
 class SlideLayoutType(Enum):
     """
-    <summary>
-        Represents the slide layout type.
-    </summary>
+    Specifies the type of slide layout.
+
+    Attributes:
+        Custom: Custom layout (-1)
+        Title: Title slide (0)
+        Text: Text-only layout (1)
+        TwoColumnText: Two-column text layout (2)
+        Table: Table layout (3)
+        TextAndChart: Text and chart side-by-side (4)
+        ChartAndText: Chart and text side-by-side (5)
+        Diagram: Diagram layout (6)
+        Chart: Chart-only layout (7)
+        TextAndClipArt: Text and clip art side-by-side (8)
+        ClipArtAndText: Clip art and text side-by-side (9)
+        TitleOnly: Title-only layout (10)
+        Blank: Blank slide (11)
+        TextAndObject: Text and object side-by-side (12)
+        ObjectAndText: Object and text side-by-side (13)
+        Object: Object-only layout (14)
+        TitleAndObject: Title and object layout (15)
+        TextAndMedia: Text and media side-by-side (16)
+        MediaAndText: Media and text side-by-side (17)
+        ObjectOverText: Object positioned over text (18)
+        TextOverObject: Text positioned over object (19)
+        TextAndTwoObjects: Text with two objects (20)
+        TwoObjectsAndText: Two objects with text (21)
+        TwoObjectsOverText: Two objects over text (22)
+        FourObjects: Four objects arranged in quadrants (23)
+        VerticalText: Vertical text layout (24)
+        ClipArtAndVerticalText: Clip art with vertical text (25)
+        VerticalTitleAndText: Vertical title and text (26)
+        VerticalTitleAndTextOverChart: Vertical title/text over chart (27)
+        TwoObjects: Two objects side-by-side (28)
+        ObjectAndTwoObject: Object with two subordinate objects (29)
+        TwoObjectsAndObject: Two objects with a primary object (30)
+        SectionHeader: Section header layout (31)
+        TwoTextAndTwoObjects: Two text sections with two objects (32)
+        TitleObjectAndCaption: Title with object and caption (33)
+        PictureAndCaption: Picture with caption layout (34)
     """
     Custom = -1
     Title = 0