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

spire/presentation/ActiveSlide.py

@@ -8,18 +8,17 @@ import abc
 
 class ActiveSlide (  PptObject, IActiveSlide) :
     """
-    <summary>
-         Represents common slide types.
-    </summary>
+    Represents common slide types in a presentation.
+    Provides access to slide content, properties, and formatting.
     """
     @property
 
     def Shapes(self)->'ShapeCollection':
         """
-    <summary>
-        Gets the shapes of a slide.
-            Read-only <see cref="T:Spire.Presentation.ShapeCollection" />.
-    </summary>
+        Gets the collection of shapes on the slide.
+
+        Returns:
+            ShapeCollection: Read-only collection of shapes.
         """
         GetDllLibPpt().ActiveSlide_get_Shapes.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_Shapes.restype=c_void_p
@@ -32,10 +31,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def Name(self)->str:
         """
-    <summary>
-        Gets or sets the name of a slide.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the name of the slide.
+
+        Returns:
+            str: The name of the slide.
         """
         GetDllLibPpt().ActiveSlide_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_Name.restype=c_void_p
@@ -53,10 +52,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def SlideID(self)->'int':
         """
-    <summary>
-        Gets the ID of a slide.
-            Read-only <see cref="T:System.UInt32" />.
-    </summary>
+        Gets the unique identifier of the slide.
+
+        Returns:
+            int: Read-only unique identifier of the slide.
         """
         GetDllLibPpt().ActiveSlide_get_SlideID.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_SlideID.restype=c_void_p
@@ -73,9 +72,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def Theme(self)->'Theme':
         """
-    <summary>
-        Gets a theme for this slide
-    </summary>
+        Gets the theme associated with this slide.
+
+        Returns:
+            Theme: The theme applied to this slide.
         """
         GetDllLibPpt().ActiveSlide_get_Theme.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_Theme.restype=c_void_p
@@ -87,10 +87,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def ApplyTheme(self ,scheme:'SlideColorScheme'):
         """
-    <summary>
-        Applies extra color scheme to a slide.
-    </summary>
-    <param name="scheme"></param>
+        Applies an additional color scheme to the slide.
+
+        Args:
+            scheme: Color scheme to apply to the slide.
         """
         intPtrscheme:c_void_p = scheme.Ptr
 
@@ -101,10 +101,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def TagsList(self)->'TagCollection':
         """
-    <summary>
-        Gets the slide's tags collection.
-            Read-only <see cref="T:Spire.Presentation.Collections.TagCollection" />.
-    </summary>
+        Gets the collection of tags associated with the slide.
+
+        Returns:
+            TagCollection: Read-only collection of tags.
         """
         GetDllLibPpt().ActiveSlide_get_TagsList.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_TagsList.restype=c_void_p
@@ -117,12 +117,12 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def Timeline(self)->'TimeLine':
         """
-    <summary>
-        Gets animation timeline object.
-            Read-only <see cref="T:Spire.Presentation.Drawing.Animation.TimeLine" />.
-    </summary>
+        Gets the animation timeline for the slide.
+
+        Returns:
+            TimeLine: Read-only animation timeline object.
         """
-        from spire.presentation import TimeLine
+        from spire.presentation.animation.TimeLine import TimeLine
         GetDllLibPpt().ActiveSlide_get_Timeline.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_Timeline.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ActiveSlide_get_Timeline,self.Ptr)
@@ -134,11 +134,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def SlideShowTransition(self)->'SlideShowTransition':
         """
-    <summary>
-        Gets the Transition object which contains information about
-            how the specified slide advances during a slide show.
-            Read-only <see cref="P:Spire.Presentation.ActiveSlide.SlideShowTransition" />.
-    </summary>
+        Gets transition settings for the slide during a slideshow.
+
+        Returns:
+            SlideShowTransition: Read-only transition settings object.
         """
         GetDllLibPpt().ActiveSlide_get_SlideShowTransition.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_SlideShowTransition.restype=c_void_p
@@ -151,10 +150,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def SlideBackground(self)->'SlideBackground':
         """
-    <summary>
-        Gets slide's background.
-            Read only <see cref="P:Spire.Presentation.ActiveSlide.SlideBackground" />.
-    </summary>
+        Gets the background settings of the slide.
+
+        Returns:
+            SlideBackground: Read-only background settings object.
         """
         GetDllLibPpt().ActiveSlide_get_SlideBackground.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_SlideBackground.restype=c_void_p
@@ -167,10 +166,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def DisplaySlideBackground(self)->'SlideBackground':
         """
-    <summary>
-        Gets slide's display background.
-            Read only <see cref="P:Spire.Presentation.ActiveSlide.DisplaySlideBackground" />.
-    </summary>
+        Gets the effective background settings displayed for the slide.
+
+        Returns:
+            SlideBackground: Read-only background settings object.
         """
         GetDllLibPpt().ActiveSlide_get_DisplaySlideBackground.argtypes=[c_void_p]
         GetDllLibPpt().ActiveSlide_get_DisplaySlideBackground.restype=c_void_p
@@ -182,7 +181,13 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines whether the specified object is equal to the current slide.
+
+        Args:
+            obj: The object to compare with the current slide.
 
+        Returns:
+            bool: True if the objects are equal, otherwise False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -195,7 +200,10 @@ class ActiveSlide (  PptObject, IActiveSlide) :
 
     def Presentation(self)->'Presentation':
         """
+        Gets the parent presentation that contains this slide.
 
+        Returns:
+            Presentation: The parent presentation object.
         """
         from spire.presentation import Presentation
         GetDllLibPpt().ActiveSlide_get_Presentation.argtypes=[c_void_p]

spire/presentation/AppException.py

@@ -8,7 +8,7 @@ import abc
 
 class AppException (SpireObject) :
     """
-    <summary>
-        Represents a standard internal exception type.
-    </summary>
+    Represents a standard internal exception type.
+    
+    This exception is raised for application-specific errors.
     """

spire/presentation/AudioCD.py

@@ -7,6 +7,10 @@ from ctypes import *
 import abc
 
 class AudioCD (SpireObject) :
+    """
+    Represents an audio CD object for presentations.
+
+    """
 
     @dispatch
     def __init__(self):
@@ -19,10 +23,7 @@ class AudioCD (SpireObject) :
     @property
     def StartTrack(self)->int:
         """
-    <summary>
         Gets or sets a start track index.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
         """
         GetDllLibPpt().AudioCD_get_StartTrack.argtypes=[c_void_p]
         GetDllLibPpt().AudioCD_get_StartTrack.restype=c_int
@@ -37,10 +38,8 @@ class AudioCD (SpireObject) :
     @property
     def StartTime(self)->int:
         """
-    <summary>
         Gets or sets a start track time.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+            
         """
         GetDllLibPpt().AudioCD_get_StartTime.argtypes=[c_void_p]
         GetDllLibPpt().AudioCD_get_StartTime.restype=c_int
@@ -55,10 +54,8 @@ class AudioCD (SpireObject) :
     @property
     def EndTrack(self)->int:
         """
-    <summary>
         Gets or sets a last track index
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+            
         """
         GetDllLibPpt().AudioCD_get_EndTrack.argtypes=[c_void_p]
         GetDllLibPpt().AudioCD_get_EndTrack.restype=c_int
@@ -73,10 +70,8 @@ class AudioCD (SpireObject) :
     @property
     def EndTime(self)->int:
         """
-    <summary>
         Gets or sets a last track time.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+           
         """
         GetDllLibPpt().AudioCD_get_EndTime.argtypes=[c_void_p]
         GetDllLibPpt().AudioCD_get_EndTime.restype=c_int

spire/presentation/AudioPlayMode.py

@@ -8,9 +8,13 @@ import abc
 
 class AudioPlayMode(Enum):
     """
-    <summary>
-        Indicates how a sound is played.
-    </summary>
+    Indicates how a sound is played.
+    
+    Attributes:
+        Mixed: Mixed mode.
+        Auto: Automatically determined play mode.
+        OnClick: Plays when clicked.
+        Presentation: Plays during the entire presentation.
     """
     Mixed = -1
     Auto = 0

spire/presentation/AudioVolumeType.py

@@ -8,9 +8,14 @@ import abc
 
 class AudioVolumeType(Enum):
     """
-    <summary>
-        Indicates audio volume.
-    </summary>
+    Indicates audio volume levels.
+    
+    Attributes:
+        Mixed: Mixed volume level.
+        Mute: Muted volume.
+        Low: Low volume.
+        Medium: Medium volume.
+        Loud: Loud volume.
     """
     Mixed = -1
     Mute = 0

spire/presentation/BaseShapeLocking.py

@@ -8,15 +8,16 @@ import abc
 
 class BaseShapeLocking (  PptObject) :
     """
-    <summary>
-        Represents a base class for shape locks 
-    </summary>
+    Base class for shape locking configurations.
+    
+    Attributes:
+        HasLocks (bool): Indicates if locks are applied to the shape.
     """
     @property
     def HasLocks(self)->bool:
-        """
-
-        """
+       
+        """Checks if any locking properties are set on the shape."""
+     
         GetDllLibPpt().BaseShapeLocking_get_HasLocks.argtypes=[c_void_p]
         GetDllLibPpt().BaseShapeLocking_get_HasLocks.restype=c_bool
         ret = CallCFunction(GetDllLibPpt().BaseShapeLocking_get_HasLocks,self.Ptr)

spire/presentation/Camera.py

@@ -8,17 +8,17 @@ import abc
 
 class Camera (SpireObject) :
     """
-    <summary>
-        Represents Camera.
-    </summary>
+    Represents a 3D camera in a presentation scene.
+    Controls the viewing perspective for 3D objects and scenes.
     """
     @property
 
     def PresetType(self)->'PresetCameraType':
         """
-    <summary>
-        Camera type
-            Read/write <see cref="P:Spire.Presentation.Camera.PresetType" /></summary>
+        Gets or sets the predefined camera type/preset.
+        
+        Returns:
+            PresetCameraType: The current camera preset configuration.
         """
         GetDllLibPpt().Camera_get_PresetType.argtypes=[c_void_p]
         GetDllLibPpt().Camera_get_PresetType.restype=c_int
@@ -28,15 +28,22 @@ class Camera (SpireObject) :
 
     @PresetType.setter
     def PresetType(self, value:'PresetCameraType'):
+        """
+        Sets the predefined camera type/preset.
+        
+        Args:
+            value (PresetCameraType): The new camera preset to apply.
+        """
         GetDllLibPpt().Camera_set_PresetType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().Camera_set_PresetType,self.Ptr, value.value)
 
     @property
     def FieldOfView(self)->float:
         """
-    <summary>
-        Camera field of view.
-            Read/write <see cref="T:System.Single" /></summary>
+        Gets or sets the camera's field of view angle in degrees.
+        
+        Returns:
+            float: The current field of view angle.
         """
         GetDllLibPpt().Camera_get_FieldOfView.argtypes=[c_void_p]
         GetDllLibPpt().Camera_get_FieldOfView.restype=c_float
@@ -51,9 +58,10 @@ class Camera (SpireObject) :
     @property
     def Zoom(self)->float:
         """
-    <summary>
-        Camera percentage zoom.
-            Read/write <see cref="T:System.Single" /></summary>
+        Gets or sets the camera zoom percentage.
+        
+        Returns:
+            float: The current zoom percentage.
         """
         GetDllLibPpt().Camera_get_Zoom.argtypes=[c_void_p]
         GetDllLibPpt().Camera_get_Zoom.restype=c_float
@@ -62,27 +70,36 @@ class Camera (SpireObject) :
 
     @Zoom.setter
     def Zoom(self, value:float):
+        """
+        Sets the camera zoom percentage.
+        
+        Args:
+            value (float): The new zoom percentage value.
+        """
         GetDllLibPpt().Camera_set_Zoom.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().Camera_set_Zoom,self.Ptr, value)
 
 
     def SetCameraRotation(self ,latitude:float,longitude:float,revolution:float):
         """
-    <summary>
-        A rotation is defined .
-    </summary>
-        """
+        Defines the camera rotation using three rotation angles.
         
+        Args:
+            latitude (float): Vertical rotation angle (up/down tilt)
+            longitude (float): Horizontal rotation angle (left/right pan)
+            revolution (float): Rotation around the view axis (twist)
+        """
         GetDllLibPpt().Camera_SetCameraRotation.argtypes=[c_void_p ,c_float,c_float,c_float]
         CallCFunction(GetDllLibPpt().Camera_SetCameraRotation,self.Ptr, latitude,longitude,revolution)
 
 
     def GetCameraRotations(self)->List[float]:
         """
-    <summary>
-        A rotation is defined. latitude, longitude, revolution.
-            Gets null if no rotation defined.
-    </summary>
+        Gets the current camera rotation angles.
+        
+        Returns:
+            List[float]: [latitude, longitude, revolution] angles as a list.
+            Returns None if no rotation is defined.
         """
         GetDllLibPpt().Camera_GetCameraRotations.argtypes=[c_void_p]
         GetDllLibPpt().Camera_GetCameraRotations.restype=IntPtrArray
@@ -93,7 +110,13 @@ class Camera (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if this camera is equal to another object.
+        
+        Args:
+            obj (SpireObject): The object to compare with.
+            
+        Returns:
+            bool: True if objects are equal, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr