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

spire/presentation/ImportDataFormat.py

@@ -8,9 +8,12 @@ import abc
 
 class ImportDataFormat(Enum):
     """
-    <summary>
-        Represents source file format.
-    </summary>
+    Specifies the source file format for importing data.
+
+    Attributes:
+        Ppt: Microsoft PowerPoint 97-2003 format (.ppt)
+        Pptx: Office Open XML Presentation format (.pptx)
+        Odp: OpenDocument Presentation format (.odp)
     """
     Ppt = 0
     Pptx = 1

spire/presentation/KnownColors.py

@@ -8,9 +8,8 @@ import abc
 
 class KnownColors(Enum):
     """
-    <summary>
-        Represents predefined color presets.
-    </summary>
+    Represents predefined color presets.
+    
     """
     none = -1
     AliceBlue = 0

spire/presentation/LightRig.py

@@ -8,17 +8,18 @@ import abc
 
 class LightRig (SpireObject) :
     """
-    <summary>
-        Represents LightRig.
-    </summary>
+    Represents a lighting configuration for 3D objects.
+
+    This class defines how light sources are arranged to illuminate 3D shapes in presentations,
+    including light direction, preset configurations, and rotation settings.
     """
     @property
-
     def Direction(self)->'LightingDirectionType':
         """
-    <summary>
-        Light direction
-            Read/write <see cref="T:Spire.Presentation.LightingDirectionType" /></summary>
+        Gets or sets the primary direction of the light source.
+
+        Returns:
+            LightingDirectionType: Current light direction
         """
         GetDllLibPpt().LightRig_get_Direction.argtypes=[c_void_p]
         GetDllLibPpt().LightRig_get_Direction.restype=c_int
@@ -28,6 +29,12 @@ class LightRig (SpireObject) :
 
     @Direction.setter
     def Direction(self, value:'LightingDirectionType'):
+        """
+        Sets the primary direction of the light source.
+
+        Args:
+            value: New lighting direction to apply
+        """
         GetDllLibPpt().LightRig_set_Direction.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().LightRig_set_Direction,self.Ptr, value.value)
 
@@ -35,11 +42,10 @@ class LightRig (SpireObject) :
 
     def PresetType(self)->'PresetLightRigType':
         """
-    <summary>
-        Represents a preset light right that can be applied to a shape. 
-            The light rig represents a group of lights oriented
-            in a specific way relative to a 3D scene.
-            Read/write <see cref="T:Spire.Presentation.PresetLightRigType" /></summary>
+        Gets or sets the predefined lighting configuration type.
+
+        Returns:
+            PresetLightRigType: Current preset light configuration
         """
         GetDllLibPpt().LightRig_get_PresetType.argtypes=[c_void_p]
         GetDllLibPpt().LightRig_get_PresetType.restype=c_int
@@ -49,17 +55,24 @@ class LightRig (SpireObject) :
 
     @PresetType.setter
     def PresetType(self, value:'PresetLightRigType'):
+        """
+        Sets the predefined lighting configuration type.
+
+        Args:
+            value: New preset light configuration to apply
+        """
         GetDllLibPpt().LightRig_set_PresetType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().LightRig_set_PresetType,self.Ptr, value.value)
 
 
     def SetRotation(self ,latitude:float,longitude:float,revolution:float):
         """
-    <summary>
-        A rotation is defined through the use of a latitude
-            coordinate, a longitude coordinate, and a revolution about the axis 
-            as the latitude and longitude coordinates.
-    </summary>
+        Defines the 3D rotation of the light rig using spherical coordinates.
+
+        Args:
+            latitude: Vertical angle in degrees (0-90)
+            longitude: Horizontal angle in degrees (0-360)
+            revolution: Rotation around the central axis in degrees (0-360)
         """
         
         GetDllLibPpt().LightRig_SetRotation.argtypes=[c_void_p ,c_float,c_float,c_float]
@@ -68,12 +81,10 @@ class LightRig (SpireObject) :
 
     def GetRotation(self)->List[float]:
         """
-    <summary>
-        A rotation is defined through the use of a latitude
-            coordinate, a longitude coordinate, and a revolution about the axis 
-            as the latitude and longitude coordinates.
-            first element in return array - latitude, second - longitude, third - revolution.
-    </summary>
+        Retrieves the current 3D rotation coordinates of the light rig.
+
+        Returns:
+            List[float]: Array containing [latitude, longitude, revolution] values
         """
         GetDllLibPpt().LightRig_GetRotation.argtypes=[c_void_p]
         GetDllLibPpt().LightRig_GetRotation.restype=IntPtrArray
@@ -84,7 +95,13 @@ class LightRig (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines if this light rig is equivalent to another object.
+
+        Args:
+            obj: The object to compare with
 
+        Returns:
+            bool: True if the objects represent the same light configuration
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/LightingDirectionType.py

@@ -8,9 +8,9 @@ import abc
 
 class LightingDirectionType(Enum):
     """
-    <summary>
-        Indicates light directions.
-    </summary>
+    Specifies the direction of light sources in 3D scenes.
+
+    This enumeration defines possible directions from which light can illuminate 3D objects in presentations.
     """
     none = -1
     TopLeft = 0

spire/presentation/LineCapStyle.py

@@ -8,9 +8,13 @@ import abc
 
 class LineCapStyle(Enum):
     """
-    <summary>
-        Represents the line cap style.
-    </summary>
+    Defines the decoration applied to the ends of lines.
+    
+    Attributes:
+        none: No line cap (system default)
+        Round: Rounded line ends
+        Square: Square line ends extending beyond endpoint
+        Flat: Flat line ends at endpoint (butt cap)
     """
     none = -1
     Round = 0

spire/presentation/LineDashStyleType.py

@@ -8,9 +8,22 @@ import abc
 
 class LineDashStyleType(Enum):
     """
-    <summary>
-        Represents the line dash style.
-    </summary>
+    Specifies the pattern used for dashed lines.
+    
+    Attributes:
+        none: No dash style (solid line)
+        Solid: Continuous solid line
+        Dot: Dotted pattern
+        Dash: Standard dash pattern
+        LargeDash: Longer dash pattern
+        DashDot: Alternating dashes and dots
+        LargeDashDot: Long dashes with dots
+        LargeDashDotDot: Long dashes with double dots
+        SystemDash: OS-default dash pattern
+        SystemDot: OS-default dot pattern
+        SystemDashDot: OS-default dash-dot pattern
+        SystemDashDotDot: OS-default dash-dot-dot pattern
+        Custom: User-defined pattern
     """
     none = -1
     Solid = 0

spire/presentation/LineEndLength.py

@@ -8,9 +8,13 @@ import abc
 
 class LineEndLength(Enum):
     """
-    <summary>
-        Represents the length of an arrowhead.
-    </summary>
+    Determines the size of arrowheads and line terminators.
+    
+    Attributes:
+        none: No arrowhead
+        Short: Small-sized arrowhead
+        Medium: Medium-sized arrowhead
+        Long: Large-sized arrowhead
     """
     none = -1
     Short = 0

spire/presentation/LineEndType.py

@@ -8,9 +8,16 @@ import abc
 
 class LineEndType(Enum):
     """
-    <summary>
-        Represents the style of an arrowhead.
-    </summary>
+    Specifies the style of arrowheads at line ends.
+    
+    Attributes:
+        UnDefined: Undefined arrowhead type. Value: -1.
+        none: No arrowhead. Value: 0.
+        TriangleArrowHead: Standard triangular arrowhead. Value: 1.
+        StealthArrow: Stealth (angled) arrowhead. Value: 2.
+        Diamond: Diamond-shaped arrowhead. Value: 3.
+        Oval: Oval-shaped arrowhead. Value: 4.
+        NoEnd: No end decoration. Value: 5.
     """
     UnDefined = -1
     none = 0

spire/presentation/LineEndWidth.py

@@ -8,9 +8,13 @@ import abc
 
 class LineEndWidth(Enum):
     """
-    <summary>
-        Represents the width of an arrowhead.
-    </summary>
+    Specifies the width of an arrowhead at the end of a line.
+    
+    Attributes:
+        none: No arrowhead width. Value: -1.
+        Narrow: Narrow arrowhead width. Value: 0.
+        Medium: Medium arrowhead width. Value: 1.
+        Wide: Wide arrowhead width. Value: 2.
     """
     none = -1
     Narrow = 0

spire/presentation/LineFillFormat.py

@@ -8,18 +8,16 @@ import abc
 
 class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
     """
-    <summary>
-        Represents properties for lines filling.
-    </summary>
+    Represents properties for filling lines with colors, gradients, or patterns.
     """
     @property
 
     def FillType(self)->'FillFormatType':
         """
-    <summary>
         Gets or sets the fill type.
-            Read/write <see cref="P:Spire.Presentation.Drawing.LineFillFormat.FillType" />.
-    </summary>
+
+        Returns:
+            FillFormatType: The current fill type.
         """
         GetDllLibPpt().LineFillFormat_get_FillType.argtypes=[c_void_p]
         GetDllLibPpt().LineFillFormat_get_FillType.restype=c_int
@@ -29,6 +27,12 @@ class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
 
     @FillType.setter
     def FillType(self, value:'FillFormatType'):
+        """
+        Sets the fill type.
+
+        Args:
+            value (FillFormatType): The new fill type to set.
+        """
         GetDllLibPpt().LineFillFormat_set_FillType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().LineFillFormat_set_FillType,self.Ptr, value.value)
 
@@ -36,10 +40,10 @@ class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
 
     def SolidFillColor(self)->'ColorFormat':
         """
-    <summary>
         Gets the color of a solid fill.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ColorFormat" />.
-    </summary>
+
+        Returns:
+            ColorFormat: The solid fill color object.
         """
         GetDllLibPpt().LineFillFormat_get_SolidFillColor.argtypes=[c_void_p]
         GetDllLibPpt().LineFillFormat_get_SolidFillColor.restype=c_void_p
@@ -52,10 +56,10 @@ class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
 
     def Gradient(self)->'GradientFillFormat':
         """
-    <summary>
         Gets the gradient fill format.
-            Read-only <see cref="P:Spire.Presentation.Drawing.LineFillFormat.Gradient" />.
-    </summary>
+
+        Returns:
+            GradientFillFormat: The gradient fill object.
         """
         GetDllLibPpt().LineFillFormat_get_Gradient.argtypes=[c_void_p]
         GetDllLibPpt().LineFillFormat_get_Gradient.restype=c_void_p
@@ -68,10 +72,10 @@ class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
 
     def Pattern(self)->'PatternFillFormat':
         """
-    <summary>
         Gets the pattern fill format.
-            Read-only <see cref="P:Spire.Presentation.Drawing.LineFillFormat.Pattern" />.
-    </summary>
+
+        Returns:
+            PatternFillFormat: The pattern fill object.
         """
         GetDllLibPpt().LineFillFormat_get_Pattern.argtypes=[c_void_p]
         GetDllLibPpt().LineFillFormat_get_Pattern.restype=c_void_p
@@ -84,10 +88,10 @@ class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
 
     def RotateWithShape(self)->'TriState':
         """
-    <summary>
-        Indicates whether the fill should be rotated with a shape.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets whether the fill rotates with the shape.
+
+        Returns:
+            TriState: Current rotation behavior setting.
         """
         GetDllLibPpt().LineFillFormat_get_RotateWithShape.argtypes=[c_void_p]
         GetDllLibPpt().LineFillFormat_get_RotateWithShape.restype=c_int
@@ -97,13 +101,25 @@ class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
 
     @RotateWithShape.setter
     def RotateWithShape(self, value:'TriState'):
+        """
+        Sets whether the fill should rotate with the shape.
+
+        Args:
+            value (TriState): New rotation behavior setting.
+        """
         GetDllLibPpt().LineFillFormat_set_RotateWithShape.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().LineFillFormat_set_RotateWithShape,self.Ptr, value.value)
 
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines if this object equals another object.
+
+        Args:
+            obj (SpireObject): The object to compare.
 
+        Returns:
+            bool: True if objects are equal, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -114,7 +130,10 @@ class LineFillFormat (  PptObject, IActiveSlide, IActivePresentation) :
 
     def GetHashCode(self)->int:
         """
+        Generates a hash code for this object.
 
+        Returns:
+            int: The computed hash code.
         """
         GetDllLibPpt().LineFillFormat_GetHashCode.argtypes=[c_void_p]
         GetDllLibPpt().LineFillFormat_GetHashCode.restype=c_int

spire/presentation/LineJoinType.py

@@ -8,9 +8,13 @@ import abc
 
 class LineJoinType(Enum):
     """
-    <summary>
-        Represents the lines join style.
-    </summary>
+    Specifies how lines are joined at connection points.
+    
+    Attributes:
+        none: No specific join style. Value: -1.
+        Round: Rounded line joins. Value: 0.
+        Bevel: Beveled (angled) line joins. Value: 1.
+        Miter: Sharp angular line joins. Value: 2.
     """
     none = -1
     Round = 0

spire/presentation/LinearGradientFill.py

@@ -8,15 +8,17 @@ import abc
 
 class LinearGradientFill (SpireObject) :
     """
-
+    Represents a linear gradient fill for shapes and objects.
     """
     @property
     def Angle(self)->float:
         """
-    <summary>
         Gets or sets the angle of a gradient.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        
+        Args:
+            value (float): The rotation angle in degrees (0-360 range)
+        Returns:
+            float: Current gradient angle
         """
         GetDllLibPpt().LinearGradientFill_get_Angle.argtypes=[c_void_p]
         GetDllLibPpt().LinearGradientFill_get_Angle.restype=c_float
@@ -25,6 +27,12 @@ class LinearGradientFill (SpireObject) :
 
     @Angle.setter
     def Angle(self, value:float):
+        """
+        Sets the rotation angle for the linear gradient.
+        
+        Args:
+            value (float): Rotation angle in degrees (0-360 range)
+        """
         GetDllLibPpt().LinearGradientFill_set_Angle.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().LinearGradientFill_set_Angle,self.Ptr, value)
 
@@ -32,10 +40,10 @@ class LinearGradientFill (SpireObject) :
 
     def IsScaled(self)->'TriState':
         """
-    <summary>
-        Indicates whether a gradient is scaled.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Determines if gradient scaling is enabled relative to fill area.
+        
+        Returns:
+            TriState: Current scaling state (True, False, or Inherit)
         """
         GetDllLibPpt().LinearGradientFill_get_IsScaled.argtypes=[c_void_p]
         GetDllLibPpt().LinearGradientFill_get_IsScaled.restype=c_int
@@ -45,6 +53,12 @@ class LinearGradientFill (SpireObject) :
 
     @IsScaled.setter
     def IsScaled(self, value:'TriState'):
+        """
+        Enables or disables gradient scaling relative to fill area.
+        
+        Args:
+            value (TriState): Scaling state to apply
+        """
         GetDllLibPpt().LinearGradientFill_set_IsScaled.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().LinearGradientFill_set_IsScaled,self.Ptr, value.value)
 

spire/presentation/LocaleFonts.py

@@ -8,18 +8,18 @@ import abc
 
 class LocaleFonts (SpireObject) :
     """
-    <summary>
-        Fonts collection.
-    </summary>
+    Represents a collection of fonts for different language locales.
+    
+    This class manages font settings for different character sets used in multilingual documents.
     """
     @property
 
     def LatinFont(self)->'TextFont':
         """
-    <summary>
-        Gets or sets the Latin font.
-            Read/write <see cref="T:Spire.Presentation.TextFont" />.
-    </summary>
+        Gets or sets the font used for Latin characters.
+        
+        Returns:
+            TextFont: The font used for Latin character set.
         """
         GetDllLibPpt().LocaleFonts_get_LatinFont.argtypes=[c_void_p]
         GetDllLibPpt().LocaleFonts_get_LatinFont.restype=c_void_p
@@ -30,6 +30,12 @@ class LocaleFonts (SpireObject) :
 
     @LatinFont.setter
     def LatinFont(self, value:'TextFont'):
+        """
+        Sets the font used for Latin characters.
+        
+        Args:
+            value (TextFont): The font to use for Latin character set.
+        """
         GetDllLibPpt().LocaleFonts_set_LatinFont.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().LocaleFonts_set_LatinFont,self.Ptr, value.Ptr)
 
@@ -37,10 +43,10 @@ class LocaleFonts (SpireObject) :
 
     def EastAsianFont(self)->'TextFont':
         """
-    <summary>
-        Gets or sets the East Asian font.
-            Read/write <see cref="T:Spire.Presentation.TextFont" />.
-    </summary>
+        Gets or sets the font used for East Asian characters.
+        
+        Returns:
+            TextFont: The font used for East Asian character set.
         """
         GetDllLibPpt().LocaleFonts_get_EastAsianFont.argtypes=[c_void_p]
         GetDllLibPpt().LocaleFonts_get_EastAsianFont.restype=c_void_p
@@ -51,6 +57,12 @@ class LocaleFonts (SpireObject) :
 
     @EastAsianFont.setter
     def EastAsianFont(self, value:'TextFont'):
+        """
+        Sets the font used for East Asian characters.
+        
+        Args:
+            value (TextFont): The font to use for East Asian character set.
+        """
         GetDllLibPpt().LocaleFonts_set_EastAsianFont.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().LocaleFonts_set_EastAsianFont,self.Ptr, value.Ptr)
 
@@ -58,10 +70,10 @@ class LocaleFonts (SpireObject) :
 
     def ComplexScriptFont(self)->'TextFont':
         """
-    <summary>
-        Gets or sets the complex script font.
-            Read/write <see cref="T:Spire.Presentation.TextFont" />.
-    </summary>
+        Gets or sets the font used for complex script characters.
+        
+        Returns:
+            TextFont: The font used for complex script character set.
         """
         GetDllLibPpt().LocaleFonts_get_ComplexScriptFont.argtypes=[c_void_p]
         GetDllLibPpt().LocaleFonts_get_ComplexScriptFont.restype=c_void_p
@@ -72,13 +84,25 @@ class LocaleFonts (SpireObject) :
 
     @ComplexScriptFont.setter
     def ComplexScriptFont(self, value:'TextFont'):
+        """
+        Sets the font used for complex script characters.
+        
+        Args:
+            value (TextFont): The font to use for complex script character set.
+        """
         GetDllLibPpt().LocaleFonts_set_ComplexScriptFont.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().LocaleFonts_set_ComplexScriptFont,self.Ptr, value.Ptr)
 
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current LocaleFonts 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
 

spire/presentation/MasterTheme.py

@@ -7,19 +7,15 @@ from ctypes import *
 import abc
 
 class MasterTheme (  Theme) :
-    """
-    <summary>
-        Represents a master theme.
-    </summary>
-    """
+    """Represents a master theme containing color, font, and format schemes."""
     @property
 
     def ColorScheme(self)->'ColorScheme':
         """
-    <summary>
-        Gets the color scheme.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ColorScheme" />.
-    </summary>
+        Gets the color scheme for the master theme.
+        
+        Returns:
+            ColorScheme: Read-only color scheme object
         """
         GetDllLibPpt().MasterTheme_get_ColorScheme.argtypes=[c_void_p]
         GetDllLibPpt().MasterTheme_get_ColorScheme.restype=c_void_p
@@ -32,10 +28,10 @@ class MasterTheme (  Theme) :
 
     def FontScheme(self)->'FontScheme':
         """
-    <summary>
-        Gets the font scheme.
-            Read-only <see cref="T:Spire.Presentation.FontScheme" />.
-    </summary>
+        Gets the font scheme for the master theme.
+        
+        Returns:
+            FontScheme: Read-only font scheme object
         """
         GetDllLibPpt().MasterTheme_get_FontScheme.argtypes=[c_void_p]
         GetDllLibPpt().MasterTheme_get_FontScheme.restype=c_void_p
@@ -48,10 +44,10 @@ class MasterTheme (  Theme) :
 
     def FormatScheme(self)->'FormatScheme':
         """
-    <summary>
-        Gets the shape format scheme.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatScheme" />.
-    </summary>
+        Gets the shape format scheme for the master theme.
+        
+        Returns:
+            FormatScheme: Read-only format scheme object
         """
         GetDllLibPpt().MasterTheme_get_FormatScheme.argtypes=[c_void_p]
         GetDllLibPpt().MasterTheme_get_FormatScheme.restype=c_void_p
@@ -64,11 +60,10 @@ class MasterTheme (  Theme) :
 
     def SlideColorSchemes(self)->'SlideColorSchemeCollection':
         """
-    <summary>
-        Gets the collection of additional color schemes.
-            These schemes don't affect presentation's look, they can be selected as main color scheme for a slide.
-            Read-only <see cref="T:Spire.Presentation.Collections.SlideColorSchemeCollection" />.
-    </summary>
+        Gets additional color schemes that can be applied to slides.
+        
+        Returns:
+            SlideColorSchemeCollection: Read-only collection of color schemes
         """
         GetDllLibPpt().MasterTheme_get_SlideColorSchemes.argtypes=[c_void_p]
         GetDllLibPpt().MasterTheme_get_SlideColorSchemes.restype=c_void_p
@@ -80,7 +75,13 @@ class MasterTheme (  Theme) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the current MasterTheme is equal to another object.
+        
+        Args:
+            obj (SpireObject): The object to compare with
+            
+        Returns:
+            bool: True if equal, otherwise False
         """
         intPtrobj:c_void_p = obj.Ptr