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

spire/presentation/PresetCameraType.py

@@ -8,9 +8,7 @@ import abc
 
 class PresetCameraType(Enum):
     """
-    <summary>
-        Indicates camera preset type.
-    </summary>
+    Enumerates predefined camera perspectives for 3D object visualization.
     """
     none = -1
     IsometricBottomDown = 0

spire/presentation/PresetLightRigType.py

@@ -8,9 +8,27 @@ import abc
 
 class PresetLightRigType(Enum):
     """
-    <summary>
-        Indicates light preset types.
-    </summary>
+    Enumerates predefined lighting configurations for 3D object rendering.
+    
+    Attributes:
+        none: No preset lighting applied.
+        Balanced: Evenly distributed lighting.
+        BrightRoom: Bright room-like illumination.
+        Chilly: Cool-toned lighting effect.
+        Contrasting: High-contrast lighting setup.
+        Flat: Uniform, shadowless lighting.
+        Flood: Intense floodlight illumination.
+        Freezing: Extreme cool-toned lighting.
+        Glow: Soft glowing light effect.
+        Harsh: Strong directional lighting with sharp shadows.
+        LegacyFlat1: Legacy flat lighting preset 1.
+        # ... (other legacy presets)
+        Morning: Simulated morning light conditions.
+        Soft: Soft diffused lighting.
+        Sunrise: Warm sunrise-like lighting.
+        Sunset: Warm sunset-like lighting.
+        ThreePt: Standard three-point lighting setup.
+        TwoPt: Two-point lighting configuration.
     """
     none = -1
     Balanced = 0

spire/presentation/PresetMaterialType.py

@@ -8,9 +8,25 @@ import abc
 
 class PresetMaterialType(Enum):
     """
-    <summary>
-        Indicates material of shape.
-    </summary>
+    Enumerates the types of material presets that can be applied to shapes.
+    
+    Attributes:
+        none: No material preset applied.
+        Clear: Transparent material effect.
+        DkEdge: Dark edge material effect.
+        Flat: Flat, non-reflective material.
+        LegacyMatte: Legacy matte finish material.
+        LegacyMetal: Legacy metallic material effect.
+        LegacyPlastic: Legacy plastic material effect.
+        LegacyWireframe: Legacy wireframe material effect.
+        Matte: Non-glossy, diffuse material.
+        Metal: Reflective metallic material.
+        Plastic: Semi-gloss plastic material.
+        Powder: Soft, powdery material texture.
+        SoftEdge: Material with soft-edged lighting.
+        Softmetal: Soft metallic material effect.
+        TranslucentPowder: Semi-transparent powdery material.
+        WarmMatte: Warm-toned matte finish material.
     """
     none = -1
     Clear = 0

spire/presentation/PresetShadowValue.py

@@ -8,9 +8,10 @@ import abc
 
 class PresetShadowValue(Enum):
     """
-    <summary>
-        Represents a preset for a shadow effect.
-    </summary>
+    Defines the types of preset shadow effects available for presentation elements.
+    
+    These enumerated values represent different preconfigured shadow effects that
+    can be applied to shapes, text, and other slide objects.
     """
     TopLeftDrop = 0
     TopLeftLargeDrop = 1

spire/presentation/RectangleAlignment.py

@@ -8,9 +8,9 @@ import abc
 
 class RectangleAlignment(Enum):
     """
-    <summary>
-        Defines 2-dimension allignment.
-    </summary>
+    Specifies the alignment position of a rectangular object.
+    
+    Defines 9-point alignment positions for rectangular objects within a containing space.
     """
     none = -1
     TopLeft = 0

spire/presentation/RelativeRectangle.py

@@ -8,12 +8,18 @@ import abc
 
 class RelativeRectangle (SpireObject) :
     """
-
+    Represents a rectangle defined using relative coordinates (percentages).
+    
+    Used to specify positions and dimensions relative to a container element,
+    with values typically ranging from 0.0 to 100.0.
     """
     @property
     def X(self)->float:
         """
-
+        Gets the X-coordinate of the rectangle's origin.
+        
+        Returns:
+            float: The relative X-position as a percentage.
         """
         GetDllLibPpt().RelativeRectangle_get_X.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_X.restype=c_float
@@ -22,13 +28,22 @@ class RelativeRectangle (SpireObject) :
 
     @X.setter
     def X(self, value:float):
+        """
+        Sets the X-coordinate of the rectangle's origin.
+        
+        Args:
+            value: The relative X-position percentage to set.
+        """
         GetDllLibPpt().RelativeRectangle_set_X.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().RelativeRectangle_set_X,self.Ptr, value)
 
     @property
     def Y(self)->float:
         """
-
+        Gets the Y-coordinate of the rectangle's origin.
+        
+        Returns:
+            float: The relative Y-position as a percentage.
         """
         GetDllLibPpt().RelativeRectangle_get_Y.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_Y.restype=c_float
@@ -43,7 +58,10 @@ class RelativeRectangle (SpireObject) :
     @property
     def Width(self)->float:
         """
-
+        Gets the Width of the rectangle.
+        
+        Returns:
+            float: The relative Width as a percentage.
         """
         GetDllLibPpt().RelativeRectangle_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_Width.restype=c_float
@@ -58,7 +76,10 @@ class RelativeRectangle (SpireObject) :
     @property
     def Height(self)->float:
         """
-
+        Gets the Height of the rectangle.
+        
+        Returns:
+            float: The relative Height as a percentage.
         """
         GetDllLibPpt().RelativeRectangle_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_Height.restype=c_float
@@ -73,7 +94,10 @@ class RelativeRectangle (SpireObject) :
     @property
     def Left(self)->float:
         """
-
+        Sets the Left of the rectangle.
+        
+        Args:
+            value: The relative Left percentage to set.
         """
         GetDllLibPpt().RelativeRectangle_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_Left.restype=c_float
@@ -88,7 +112,10 @@ class RelativeRectangle (SpireObject) :
     @property
     def Top(self)->float:
         """
-
+        Gets the Top of the rectangle.
+        
+        Returns:
+            float: The relative Top as a percentage.
         """
         GetDllLibPpt().RelativeRectangle_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_Top.restype=c_float
@@ -103,7 +130,10 @@ class RelativeRectangle (SpireObject) :
     @property
     def Right(self)->float:
         """
-
+        Gets the Right of the rectangle.
+        
+        Returns:
+            float: The relative Right as a percentage.
         """
         GetDllLibPpt().RelativeRectangle_get_Right.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_Right.restype=c_float
@@ -118,7 +148,10 @@ class RelativeRectangle (SpireObject) :
     @property
     def Bottom(self)->float:
         """
-
+        Gets the Bottom of the rectangle.
+        
+        Returns:
+            float: The relative Bottom as a percentage.
         """
         GetDllLibPpt().RelativeRectangle_get_Bottom.argtypes=[c_void_p]
         GetDllLibPpt().RelativeRectangle_get_Bottom.restype=c_float
@@ -134,7 +167,13 @@ class RelativeRectangle (SpireObject) :
 
     def Transform(self ,rect:RectangleF)->RectangleF:
         """
-
+        Transforms a RectangleF using the current relative rectangle values.
+        
+        Args:
+            rect: The source rectangle to transform.
+        
+        Returns:
+            RectangleF: The transformed rectangle.
         """
         intPtrrect:c_void_p = rect.Ptr
 
@@ -149,7 +188,13 @@ class RelativeRectangle (SpireObject) :
 
     def Transform(self ,rect:'RelativeRectangle')->'RelativeRectangle':
         """
-
+        Transforms another RelativeRectangle using the current relative rectangle values.
+        
+        Args:
+            rect: The source relative rectangle to transform.
+        
+        Returns:
+            RelativeRectangle: The transformed relative rectangle.
         """
         intPtrrect:c_void_p = rect.Ptr
 

spire/presentation/Section.py

@@ -8,7 +8,8 @@ import abc
 
 class Section (SpireObject) :
     """
-
+    Represents a logical grouping of slides in a presentation.
+    Sections help organize slides into named groups for better management.
     """
 #    @property
 #
@@ -28,10 +29,10 @@ class Section (SpireObject) :
 
     def GetSlides(self)->List['ISlide']:
         """
-    <summary>
-        get slides in this section.
-    </summary>
-    <returns>Array of ISlide</returns>
+        Retrieves all slides contained within this section.
+        
+        Returns:
+            List[ISlide]: A list of slide objects belonging to this section.
         """
         GetDllLibPpt().Section_GetSlides.argtypes=[c_void_p]
         GetDllLibPpt().Section_GetSlides.restype=IntPtrArray
@@ -43,11 +44,11 @@ class Section (SpireObject) :
 
     def Move(self ,index:int,slide:'ISlide'):
         """
-    <summary>
-        Move the position of slide in section.
-    </summary>
-    <param name="index">the target position.</param>
-    <param name="slide">the slide which needs moved.</param>
+        Relocates a slide to a new position within this section.
+        
+        Args:
+            index: Target position index (0-based).
+            slide: Slide object to be moved.
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -57,12 +58,14 @@ class Section (SpireObject) :
 
     def Insert(self ,index:int,slide:'ISlide')->'ISlide':
         """
-    <summary>
-        Insert slide into section.
-    </summary>
-    <param name="index">the target position.</param>
-    <param name="slide">the target slide.</param>
-    <returns></returns>
+        Inserts a slide at the specified position within this section.
+        
+        Args:
+            index: Target insertion position (0-based).
+            slide: Slide object to insert.
+            
+        Returns:
+            ISlide: The inserted slide object.
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -75,6 +78,12 @@ class Section (SpireObject) :
 
 
     def AddRange(self ,slides:'IList'):
+        """
+        Adds multiple slides to the end of this section.
+        
+        Args:
+            slides: List of slide objects to add.
+        """
         slide_ptrs = [s.Ptr for s in slides]
 
         num_slides = len(slide_ptrs)
@@ -86,10 +95,10 @@ class Section (SpireObject) :
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        remove slide at some position
-    </summary>
-    <param name="index">the target position.</param>
+        Removes the slide at the specified position.
+        
+        Args:
+            index: Position index of slide to remove (0-based).
         """
         
         GetDllLibPpt().Section_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -98,10 +107,10 @@ class Section (SpireObject) :
 
     def Remove(self ,slide:'ISlide'):
         """
-    <summary>
-        Remove a slide.
-    </summary>
-    <param name="slide">target slide.</param>
+        Removes a specific slide from this section.
+        
+        Args:
+            slide: Slide object to remove.
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -111,11 +120,11 @@ class Section (SpireObject) :
 
     def RemoveRange(self ,startIndex:int,count:int):
         """
-    <summary>
-        Remove a range of slides.
-    </summary>
-    <param name="startIndex">start index.</param>
-    <param name="count">the count of slides.</param>
+        Removes a range of consecutive slides.
+        
+        Args:
+            startIndex: Starting position index (0-based).
+            count: Number of slides to remove.
         """
         
         GetDllLibPpt().Section_RemoveRange.argtypes=[c_void_p ,c_int,c_int]
@@ -125,9 +134,10 @@ class Section (SpireObject) :
 
     def Name(self)->str:
         """
-    <summary>
-        Get or set the name of this section.
-    </summary>
+        Gets or sets the display name of the section.
+        
+        Returns:
+            str: Current section name.
         """
         GetDllLibPpt().Section_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().Section_get_Name.restype=c_void_p
@@ -145,7 +155,10 @@ class Section (SpireObject) :
 
     def Id(self)->str:
         """
-
+        Gets or sets the unique identifier for the section.
+        
+        Returns:
+            str: Unique section identifier.
         """
         GetDllLibPpt().Section_get_Id.argtypes=[c_void_p]
         GetDllLibPpt().Section_get_Id.restype=c_void_p
@@ -162,9 +175,10 @@ class Section (SpireObject) :
     @property
     def Index(self)->int:
         """
-    <summary>
-        Get the position of this section in section list.
-    </summary>
+        Gets the position index of this section in the parent collection.
+        
+        Returns:
+            int: Zero-based index position.
         """
         GetDllLibPpt().Section_get_Index.argtypes=[c_void_p]
         GetDllLibPpt().Section_get_Index.restype=c_int

spire/presentation/SectionList.py

@@ -8,14 +8,16 @@ import abc
 
 class SectionList (SpireObject) :
     """
-
+    Represents a collection of sections in a presentation.
+    Manages the organization and ordering of slide groups.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Get the count of sections in this section list.
-    </summary>
+        Gets the total number of sections in the collection.
+        
+        Returns:
+            int: Count of sections.
         """
         GetDllLibPpt().SectionList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().SectionList_get_Count.restype=c_int
@@ -25,11 +27,13 @@ class SectionList (SpireObject) :
 
     def get_Item(self ,index:int)->'Section':
         """
-    <summary>
-        Get the section by index.
-    </summary>
-    <param name="index">the target index.</param>
-    <returns>the target section</returns>
+        Retrieves a section by its index position.
+        
+        Args:
+            index: Zero-based section index.
+            
+        Returns:
+            Section: Section object at specified position.
         """
         
         GetDllLibPpt().SectionList_get_Item.argtypes=[c_void_p ,c_int]
@@ -42,13 +46,15 @@ class SectionList (SpireObject) :
 
     def Add(self ,sectionName:str,slide:'ISlide')->'Section':
         """
-    <summary>
-        Add section by name and slide.
-            Note: Only effect on .pptx/.potx file format,invalid other file format
-    </summary>
-    <param name="sectionName">the name of section.</param>
-    <param name="slide">the slide contained in the section.</param>
-    <returns></returns>
+        Creates a new section containing a slide.
+        Note: Only works with .pptx/.potx file formats.
+        
+        Args:
+            sectionName: Name for the new section.
+            slide: Initial slide to include.
+            
+        Returns:
+            Section: Newly created section object.
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -63,12 +69,14 @@ class SectionList (SpireObject) :
 
     def Insert(self ,sectionIndex:int,sectionName:str)->'Section':
         """
-    <summary>
-        Insert section with section name and section index.
-    </summary>
-    <param name="sectionIndex">section index.</param>
-    <param name="sectionName">section name.</param>
-    <returns></returns>
+        Inserts a new section at the specified position.
+        
+        Args:
+            sectionIndex: Target insertion position.
+            sectionName: Name for the new section.
+            
+        Returns:
+            Section: Newly created section object.
         """
         
         sectionNamePtr = StrToPtr(sectionName)
@@ -82,13 +90,14 @@ class SectionList (SpireObject) :
 
     def Append(self ,sectionName:str)->'Section':
         """
-    <summary>
-        Append section with section name at the end.
-    </summary>
-    <param name="sectionName">section name.</param>
-    <returns></returns>
-        """
+        Adds a new section to the end of the collection.
         
+        Args:
+            sectionName: Name for the new section.
+            
+        Returns:
+            Section: Newly created section object.
+        """
         sectionNamePtr = StrToPtr(sectionName)
         GetDllLibPpt().SectionList_Append.argtypes=[c_void_p ,c_char_p]
         GetDllLibPpt().SectionList_Append.restype=c_void_p
@@ -100,11 +109,13 @@ class SectionList (SpireObject) :
 
     def IndexOf(self ,section:'Section')->int:
         """
-    <summary>
-        Get the index of the section.
-    </summary>
-    <param name="section">The target section.</param>
-    <returns></returns>
+        Gets the index position of a section.
+        
+        Args:
+            section: Target section object.
+            
+        Returns:
+            int: Zero-based index position.
         """
         intPtrsection:c_void_p = section.Ptr
 
@@ -116,12 +127,12 @@ class SectionList (SpireObject) :
 
     def MoveSlide(self ,section:'Section',index:int,slide:'ISlide'):
         """
-    <summary>
-        Move the position of slide in the section.
-    </summary>
-    <param name="section">The target section.</param>
-    <param name="index">The target position.</param>
-    <param name="slide">The target slide.</param>
+        Moves a slide within a specific section.
+        
+        Args:
+            section: Target section containing the slide.
+            index: New position index for the slide.
+            slide: Slide object to relocate.
         """
         intPtrsection:c_void_p = section.Ptr
         intPtrslide:c_void_p = slide.Ptr
@@ -132,13 +143,15 @@ class SectionList (SpireObject) :
 
     def InsertSlide(self ,section:'Section',index:int,slide:'ISlide')->'ISlide':
         """
-    <summary>
-        Insert slide into the section at position.
-    </summary>
-    <param name="section">The target section.</param>
-    <param name="index">The target position.</param>
-    <param name="slide">The target slide.</param>
-    <returns></returns>
+        Inserts a slide into a section at a specific position.
+        
+        Args:
+            section: Target section for insertion.
+            index: Insertion position index.
+            slide: Slide object to insert.
+            
+        Returns:
+            ISlide: Inserted slide object.
         """
         intPtrsection:c_void_p = section.Ptr
         intPtrslide:c_void_p = slide.Ptr
@@ -153,11 +166,11 @@ class SectionList (SpireObject) :
 
     def RemoveSlide(self ,section:'Section',index:int):
         """
-    <summary>
-        Remove the slide at some position in the section.
-    </summary>
-    <param name="section">The target section.</param>
-    <param name="index">The position of target slide.</param>
+        Removes a slide from a section.
+        
+        Args:
+            section: Section containing the slide.
+            index: Position index of slide to remove.
         """
         intPtrsection:c_void_p = section.Ptr
 
@@ -167,20 +180,17 @@ class SectionList (SpireObject) :
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        Remove section at some position.
-    </summary>
-    <param name="index">position in section list.</param>
-        """
+        Deletes a section by its index position.
         
+        Args:
+            index: Position index of section to remove.
+        """
         GetDllLibPpt().SectionList_RemoveAt.argtypes=[c_void_p ,c_int]
         CallCFunction(GetDllLibPpt().SectionList_RemoveAt,self.Ptr, index)
 
     def RemoveAll(self):
         """
-    <summary>
-        Remove all section.
-    </summary>
+        Clears all sections from the collection.
         """
         GetDllLibPpt().SectionList_RemoveAll.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().SectionList_RemoveAll,self.Ptr)