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

spire/presentation/{PictureData.py → drawing/PictureData.py}

@@ -8,18 +8,18 @@ import abc
 
 class PictureData (SpireObject) :
     """
-    <summary>
-        Represents a picture in a presentation.
-    </summary>
+    Represents an image in a presentation document.
+    
+    Provides access to embedded/linked image data and transformation effects.
     """
     @property
 
     def SourceEmbedImage(self)->'IImageData':
         """
-    <summary>
-        Gets or sets the embedded image.
-            Read/write <see cref="T:Spire.Presentation.Drawing.ImageData" />.
-    </summary>
+        Gets or sets the embedded image data.
+        
+        Returns:
+            IImageData: Embedded image object.
         """
         GetDllLibPpt().PictureData_get_SourceEmbedImage.argtypes=[c_void_p]
         GetDllLibPpt().PictureData_get_SourceEmbedImage.restype=c_void_p
@@ -32,10 +32,10 @@ class PictureData (SpireObject) :
 
     def Url(self)->str:
         """
-    <summary>
-        Gets of sets linked image's URL.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the URL for linked images.
+        
+        Returns:
+            str: URL string for externally linked images.
         """
         GetDllLibPpt().PictureData_get_Url.argtypes=[c_void_p]
         GetDllLibPpt().PictureData_get_Url.restype=c_void_p
@@ -47,10 +47,10 @@ class PictureData (SpireObject) :
 
     def ImageTransform(self)->'EffectDataCollection':
         """
-    <summary>
-        Gets the collection of image transform effects.
-            Read-only <see cref="P:Spire.Presentation.Drawing.PictureData.ImageTransform" />.
-    </summary>
+        Gets the collection of image transformation effects.
+        
+        Returns:
+            EffectDataCollection: Read-only collection of visual effects.
         """
         GetDllLibPpt().PictureData_get_ImageTransform.argtypes=[c_void_p]
         GetDllLibPpt().PictureData_get_ImageTransform.restype=c_void_p

spire/presentation/{PictureFillFormat.py → drawing/PictureFillFormat.py}

@@ -8,17 +8,15 @@ import abc
 
 class PictureFillFormat (  IActiveSlide) :
     """
-    <summary>
-        Represents a picture fill style.
-    </summary>
+    <Represents the fill formatting properties for a picture.
     """
     @property
     def Dpi(self)->int:
         """
-    <summary>
-        Gets or sets the dpi which is used to fill a picture.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets the DPI resolution used for rendering the picture fill.
+        
+        Returns:
+            int: The current DPI setting.
         """
         GetDllLibPpt().PictureFillFormat_get_Dpi.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_Dpi.restype=c_int
@@ -34,10 +32,10 @@ class PictureFillFormat (  IActiveSlide) :
 
     def FillType(self)->'PictureFillType':
         """
-    <summary>
-        Gets or sets the picture fill mode.
-            Read/write <see cref="P:Spire.Presentation.Drawing.PictureFillFormat.FillType" />.
-    </summary>
+        Gets or sets the picture fill mode (tiled or stretched).
+        
+        Returns:
+            PictureFillType: The current fill type.
         """
         GetDllLibPpt().PictureFillFormat_get_FillType.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_FillType.restype=c_int
@@ -54,9 +52,10 @@ class PictureFillFormat (  IActiveSlide) :
 
     def Picture(self)->'PictureShape':
         """
-    <summary>
-        Gets the picture.
-            Readonly <see cref="T:Spire.Presentation.PictureShape" /></summary>
+        Gets the source picture used for filling.
+        
+        Returns:
+            PictureShape: The source picture object.
         """
         GetDllLibPpt().PictureFillFormat_get_Picture.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_Picture.restype=c_void_p
@@ -69,7 +68,10 @@ class PictureFillFormat (  IActiveSlide) :
 
     def FillRectangle(self)->'RelativeRectangle':
         """
-
+        Gets the dimensions of the fill area as relative coordinates.
+        
+        Returns:
+            RelativeRectangle: The fill rectangle dimensions.
         """
         GetDllLibPpt().PictureFillFormat_get_FillRectangle.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_FillRectangle.restype=c_void_p
@@ -81,7 +83,10 @@ class PictureFillFormat (  IActiveSlide) :
     @property
     def HorizontalOffset(self)->float:
         """
-
+        Gets or sets the horizontal offset of the fill.
+        
+        Returns:
+            float: The current horizontal offset.
         """
         GetDllLibPpt().PictureFillFormat_get_HorizontalOffset.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_HorizontalOffset.restype=c_double
@@ -96,7 +101,10 @@ class PictureFillFormat (  IActiveSlide) :
     @property
     def VerticalOffset(self)->float:
         """
-
+        Gets the cropping position of the picture.
+        
+        Returns:
+            RectangleF: The crop rectangle in physical coordinates.
         """
         GetDllLibPpt().PictureFillFormat_get_VerticalOffset.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_VerticalOffset.restype=c_double
@@ -111,7 +119,10 @@ class PictureFillFormat (  IActiveSlide) :
     @property
     def ScaleX(self)->float:
         """
-
+        Gets the cropping position of the picture.
+        
+        Returns:
+            RectangleF: The crop rectangle in physical coordinates.
         """
         GetDllLibPpt().PictureFillFormat_get_ScaleX.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_ScaleX.restype=c_float
@@ -126,7 +137,7 @@ class PictureFillFormat (  IActiveSlide) :
     @property
     def ScaleY(self)->float:
         """
-
+        Gets or sets the vertical scale factor.
         """
         GetDllLibPpt().PictureFillFormat_get_ScaleY.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_ScaleY.restype=c_float
@@ -142,7 +153,7 @@ class PictureFillFormat (  IActiveSlide) :
 
     def Flip(self)->'TileFlipMode':
         """
-
+        Gets or sets the tile flip mode.
         """
         GetDllLibPpt().PictureFillFormat_get_Flip.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_Flip.restype=c_int
@@ -159,7 +170,7 @@ class PictureFillFormat (  IActiveSlide) :
 
     def Alignment(self)->'RectangleAlignment':
         """
-
+        Gets or sets the rectangle alignment.
         """
         GetDllLibPpt().PictureFillFormat_get_Alignment.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_Alignment.restype=c_int
@@ -176,9 +187,8 @@ class PictureFillFormat (  IActiveSlide) :
 
     def SourceRectangle(self)->'RelativeRectangle':
         """
-    <summary>
         Gets or sets the number of percents of real image.
-    </summary>
+    
         """
         GetDllLibPpt().PictureFillFormat_get_SourceRectangle.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_SourceRectangle.restype=c_void_p
@@ -196,7 +206,7 @@ class PictureFillFormat (  IActiveSlide) :
 
     def Slide(self)->'ActiveSlide':
         """
-
+        Gets the parent slide (read-only).
         """
         GetDllLibPpt().PictureFillFormat_get_Slide.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_get_Slide.restype=c_void_p
@@ -209,7 +219,7 @@ class PictureFillFormat (  IActiveSlide) :
 
     def Presentation(self)->'Presentation':
         """
-
+        Gets the parent presentation (read-only).
         """
         from spire.presentation import Presentation
         GetDllLibPpt().PictureFillFormat_get_Presentation.argtypes=[c_void_p]
@@ -222,10 +232,8 @@ class PictureFillFormat (  IActiveSlide) :
 
     def GetCropPosition(self)->'RectangleF':
         """
-    <summary>
         Gets the crop position of picture format.
-    </summary>
-    <returns></returns>
+    
         """
         GetDllLibPpt().PictureFillFormat_GetCropPosition.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_GetCropPosition.restype=c_void_p
@@ -237,10 +245,8 @@ class PictureFillFormat (  IActiveSlide) :
 
     def GetPicturePosition(self)->'RectangleF':
         """
-    <summary>
         Gets the picture position of picture format.
-    </summary>
-    <returns></returns>
+    
         """
         GetDllLibPpt().PictureFillFormat_GetPicturePosition.argtypes=[c_void_p]
         GetDllLibPpt().PictureFillFormat_GetPicturePosition.restype=c_void_p

spire/presentation/{PictureFillType.py → drawing/PictureFillType.py}

@@ -8,9 +8,11 @@ import abc
 
 class PictureFillType(Enum):
     """
-    <summary>
-        Indicates how picture will fill area.
-    </summary>
+    Specifies how a picture should fill its target area.
+    
+    Enumeration Members:
+        Tile (0): The picture is repeated to fill the area (tiled).
+        Stretch (1): The picture is stretched to fill the entire area.
     """
     Tile = 0
     Stretch = 1

spire/presentation/{PresetShadow.py → drawing/PresetShadow.py}

@@ -7,23 +7,29 @@ from ctypes import *
 import abc
 
 class PresetShadow (SpireObject) :
+    """
+    Represents a preset shadow effect for presentation elements.
+    
+    This class provides properties to configure the direction, distance, 
+    color, and preset type of shadow effects applied to slide objects.
+    """
 
     @dispatch
     def __init__(self):
+        """
+        Initializes a new instance of the PresetShadow class with default values.
+        """
         GetDllLibPpt().PresetShadow_CreatPresetShadow.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().PresetShadow_CreatPresetShadow)
         super(PresetShadow, self).__init__(intPtr)
-    """
-    <summary>
-        Represents a preset shadow effect.
-    </summary>
-    """
+   
     @property
     def Direction(self)->float:
         """
-    <summary>
-        Direction of shadow.
-    </summary>
+        Gets or sets the direction angle of the shadow effect.
+        
+        Returns:
+            float: The direction angle of the shadow in degrees
         """
         GetDllLibPpt().PresetShadow_get_Direction.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadow_get_Direction.restype=c_float
@@ -38,9 +44,10 @@ class PresetShadow (SpireObject) :
     @property
     def Distance(self)->float:
         """
-    <summary>
-        Distance of shadow.
-    </summary>
+        Gets or sets the distance of the shadow from the object.
+        
+        Returns:
+            float: The shadow distance value
         """
         GetDllLibPpt().PresetShadow_get_Distance.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadow_get_Distance.restype=c_double
@@ -56,9 +63,10 @@ class PresetShadow (SpireObject) :
 
     def ColorFormat(self)->'ColorFormat':
         """
-    <summary>
-        Color of shadow.
-    </summary>
+        Gets the color configuration of the shadow.
+        
+        Returns:
+            ColorFormat: The color format of the shadow
         """
         GetDllLibPpt().PresetShadow_get_ColorFormat.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadow_get_ColorFormat.restype=c_void_p
@@ -71,9 +79,10 @@ class PresetShadow (SpireObject) :
 
     def Preset(self)->'PresetShadowValue':
         """
-    <summary>
-        Preset.
-    </summary>
+        Gets or sets the predefined shadow effect type.
+        
+        Returns:
+            PresetShadowValue: The preset shadow type
         """
         GetDllLibPpt().PresetShadow_get_Preset.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadow_get_Preset.restype=c_int
@@ -89,7 +98,13 @@ class PresetShadow (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether this PresetShadow is equal to another 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/{PresetShadowNode.py → drawing/PresetShadowNode.py}

@@ -8,16 +8,18 @@ import abc
 
 class PresetShadowNode (  EffectNode) :
     """
-    <summary>
-        Represents a preset shadow effect.
-    </summary>
+    Represents a preset shadow effect node in a presentation effect chain.
+    
+    This class provides read-only access to preset shadow effect properties 
+    when applied as part of a node-based effect configuration.
     """
     @property
     def Direction(self)->float:
         """
-    <summary>
-        Direction of shadow.
-    </summary>
+        Gets the direction angle of the shadow effect.
+        
+        Returns:
+            float: The direction angle of the shadow in degrees
         """
         GetDllLibPpt().PresetShadowNode_get_Direction.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadowNode_get_Direction.restype=c_float
@@ -27,9 +29,10 @@ class PresetShadowNode (  EffectNode) :
     @property
     def Distance(self)->float:
         """
-    <summary>
-        Distance of shadow.
-    </summary>
+        Gets the distance of the shadow from the object.
+        
+        Returns:
+            float: The shadow distance value
         """
         GetDllLibPpt().PresetShadowNode_get_Distance.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadowNode_get_Distance.restype=c_double
@@ -40,9 +43,10 @@ class PresetShadowNode (  EffectNode) :
 
     def ShadowColor(self)->'Color':
         """
-    <summary>
-        Color of shadow.
-    </summary>
+        Gets the color of the shadow effect.
+        
+        Returns:
+            Color: The color configuration of the shadow
         """
         GetDllLibPpt().PresetShadowNode_get_ShadowColor.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadowNode_get_ShadowColor.restype=c_void_p
@@ -55,9 +59,10 @@ class PresetShadowNode (  EffectNode) :
 
     def Preset(self)->'PresetShadowValue':
         """
-    <summary>
-        Preset.
-    </summary>
+        Gets the predefined shadow effect type.
+        
+        Returns:
+            PresetShadowValue: The preset shadow type
         """
         GetDllLibPpt().PresetShadowNode_get_Preset.argtypes=[c_void_p]
         GetDllLibPpt().PresetShadowNode_get_Preset.restype=c_int

spire/presentation/{ReflectionEffect.py → drawing/ReflectionEffect.py}

@@ -8,9 +8,10 @@ import abc
 
 class ReflectionEffect (SpireObject) :
     """
-    <summary>
-        Represents a reflection effect.
-    </summary>
+    Represents a reflection effect that can be applied to visual elements.
+    
+    This class provides configurable properties to control the appearance of reflections,
+    including position, opacity, blur, alignment, and transformation parameters.
     """
 
     #def MakeReflection(self ,bitmap:'Bitmap',reflectionEffect:'ReflectionEffect')->'Bitmap':
@@ -30,9 +31,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def StartPosition(self)->float:
         """
-    <summary>
-        Specifies the start position (along the alpha gradient ramp) of the start alpha value (percents).
-    </summary>
+        Specifies the start position along the alpha gradient ramp for the reflection effect.
+        
+        Returns:
+            float: The start position as a percentage value (0-100).
         """
         GetDllLibPpt().ReflectionEffect_get_StartPosition.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_StartPosition.restype=c_float
@@ -47,9 +49,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def EndPosition(self)->float:
         """
-    <summary>
-        Specifies the end position (along the alpha gradient ramp) of the end alpha value (percents).
-    </summary>
+        Sets the start position along the alpha gradient ramp.
+        
+        Args:
+            value: The start position percentage (0-100) to set.
         """
         GetDllLibPpt().ReflectionEffect_get_EndPosition.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_EndPosition.restype=c_float
@@ -64,9 +67,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def FadeDirection(self)->float:
         """
-    <summary>
-        Specifies the direction to offset the reflection. (angle).
-    </summary>
+        Gets or sets the direction to offset the reflection.
+        
+        Returns:
+            float: Fade direction angle in degrees.
         """
         GetDllLibPpt().ReflectionEffect_get_FadeDirection.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_FadeDirection.restype=c_float
@@ -81,9 +85,9 @@ class ReflectionEffect (SpireObject) :
     @property
     def StartOpacity(self)->float:
         """
-    <summary>
-        Starting reflection opacity. (percents).
-    </summary>
+        Gets or sets the starting opacity of the reflection.
+        Returns:
+            float: Starting opacity as a percentage value.
         """
         GetDllLibPpt().ReflectionEffect_get_StartOpacity.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_StartOpacity.restype=c_float
@@ -98,9 +102,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def EndOpacity(self)->float:
         """
-    <summary>
-        End reflection opacity. (percents).
-    </summary>
+        Gets or sets the ending opacity of the reflection.
+        
+        Returns:
+            float: Ending opacity as a percentage value.
         """
         GetDllLibPpt().ReflectionEffect_get_EndOpacity.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_EndOpacity.restype=c_float
@@ -115,9 +120,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def BlurRadius(self)->float:
         """
-    <summary>
-        Blur radius.
-    </summary>
+        Gets or sets the blur radius of the reflection.
+        
+        Returns:
+            float: Blur radius value.
         """
         GetDllLibPpt().ReflectionEffect_get_BlurRadius.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_BlurRadius.restype=c_double
@@ -132,9 +138,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def Direction(self)->float:
         """
-    <summary>
-        Direction of reflection.
-    </summary>
+        Gets or sets the direction of the reflection.
+        
+        Returns:
+            float: Reflection direction angle in degrees.
         """
         GetDllLibPpt().ReflectionEffect_get_Direction.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_Direction.restype=c_float
@@ -149,9 +156,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def Distance(self)->float:
         """
-    <summary>
-        Distance of reflection.
-    </summary>
+        Gets or sets the distance of the reflection.
+        
+        Returns:
+            float: Reflection distance value.
         """
         GetDllLibPpt().ReflectionEffect_get_Distance.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_Distance.restype=c_double
@@ -167,9 +175,10 @@ class ReflectionEffect (SpireObject) :
 
     def Alignment(self)->'RectangleAlignment':
         """
-    <summary>
-        Rectangle alignment.
-    </summary>
+        Gets or sets the rectangle alignment of the reflection.
+        
+        Returns:
+            RectangleAlignment: The alignment setting for the reflection.
         """
         GetDllLibPpt().ReflectionEffect_get_Alignment.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_Alignment.restype=c_int
@@ -185,9 +194,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def HorizontalSkew(self)->float:
         """
-    <summary>
-        Specifies the horizontal skew angle.
-    </summary>
+        Gets or sets the horizontal skew angle.
+        
+        Returns:
+            float: Horizontal skew angle in degrees.
         """
         GetDllLibPpt().ReflectionEffect_get_HorizontalSkew.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_HorizontalSkew.restype=c_float
@@ -202,9 +212,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def VerticalSkew(self)->float:
         """
-    <summary>
-        Specifies the vertical skew angle.
-    </summary>
+        Gets or sets the vertical skew angle.
+       
+        Returns:
+            float: Vertical skew angle in degrees.
         """
         GetDllLibPpt().ReflectionEffect_get_VerticalSkew.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_VerticalSkew.restype=c_float
@@ -219,9 +230,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def RotateWithShape(self)->bool:
         """
-    <summary>
-        Specifies whether the reflection should rotate with the shape if the shape is rotated.
-    </summary>
+        Gets or sets whether the reflection rotates with the shape.
+        
+        Returns:
+            bool: True if reflection rotates with shape, False otherwise.
         """
         GetDllLibPpt().ReflectionEffect_get_RotateWithShape.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_RotateWithShape.restype=c_bool
@@ -236,9 +248,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def HorizontalScale(self)->float:
         """
-    <summary>
-        Specifies the horizontal scaling factor, negative scaling causes a flip. (percents)
-    </summary>
+        Gets or sets the horizontal scaling factor.
+       
+        Returns:
+            float: Horizontal scale as a percentage value.
         """
         GetDllLibPpt().ReflectionEffect_get_HorizontalScale.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_HorizontalScale.restype=c_float
@@ -253,9 +266,10 @@ class ReflectionEffect (SpireObject) :
     @property
     def VerticalScale(self)->float:
         """
-    <summary>
-        Specifies the vertical scaling factor, negative scaling causes a flip. (percents)
-    </summary>
+        Gets or sets the vertical scaling factor.
+        
+        Returns:
+            float: Vertical scale as a percentage value.
         """
         GetDllLibPpt().ReflectionEffect_get_VerticalScale.argtypes=[c_void_p]
         GetDllLibPpt().ReflectionEffect_get_VerticalScale.restype=c_float
@@ -270,7 +284,13 @@ class ReflectionEffect (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines if the current ReflectionEffect is equal to another object.
 
+        Args:
+            obj: The object to compare with the current object
+
+        Returns:
+            bool: True if the specified object is equal to the current object; otherwise, False
         """
         intPtrobj:c_void_p = obj.Ptr