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

spire/presentation/TextStyle.py

@@ -8,18 +8,20 @@ import abc
 
 class TextStyle (  IActiveSlide, IActivePresentation) :
     """
-    <summary>
-        Summary description for TextStyle.
-    </summary>
+    Represents text styling properties for presentation elements.
+    
+    This class provides access to different levels of text formatting styles.
     """
 
     def GetListLevelTextStyle(self ,index:int)->'TextParagraphProperties':
-        """
-    <summary>
-        If level of style exist returns it, otherwise returns null.
-    </summary>
-    <param name="index">zero-based index of level.</param>
-    <returns>Formatting of level <see cref="T:Spire.Presentation.TextParagraphProperties" />. </returns>
+        """Retrieves paragraph properties for a specific list level if exists.
+        
+        Args:
+            index: Zero-based index of the text level (0-8 for PowerPoint)
+            
+        Returns:
+            TextParagraphProperties for the specified level if exists, 
+            otherwise None.
         """
         
         GetDllLibPpt().TextStyle_GetListLevelTextStyle.argtypes=[c_void_p ,c_int]
@@ -32,11 +34,13 @@ class TextStyle (  IActiveSlide, IActivePresentation) :
 
     def GetOrCreateListLevelTextStyle(self ,index:int)->'TextParagraphProperties':
         """
-    <summary>
-        If level of style exist returns it, otherwise create and returns it.
-    </summary>
-    <param name="index">zero-based index of level.</param>
-    <returns>Formatting of level <see cref="T:Spire.Presentation.TextParagraphProperties" />. </returns>
+        Retrieves or creates paragraph properties for a specific list level.
+        
+        Args:
+            index: Zero-based index of the text level (0-8 for PowerPoint)
+            
+        Returns:
+            Existing or newly created TextParagraphProperties for the level.
         """
         
         GetDllLibPpt().TextStyle_GetOrCreateListLevelTextStyle.argtypes=[c_void_p ,c_int]
@@ -50,9 +54,10 @@ class TextStyle (  IActiveSlide, IActivePresentation) :
 
     def DefaultParagraphStyle(self)->'TextParagraphProperties':
         """
-    <summary>
-        Default paragraph propertiies.
-    </summary>
+        Provides access to default paragraph formatting properties.
+        
+        Returns:
+            TextParagraphProperties object containing default formatting.
         """
         GetDllLibPpt().TextStyle_get_DefaultParagraphStyle.argtypes=[c_void_p]
         GetDllLibPpt().TextStyle_get_DefaultParagraphStyle.restype=c_void_p
@@ -63,8 +68,13 @@ class TextStyle (  IActiveSlide, IActivePresentation) :
 
 
     def Equals(self ,obj:'SpireObject')->bool:
-        """
-
+        """Determines whether this style equals another object.
+        
+        Args:
+            obj: The SpireObject to compare with
+            
+        Returns:
+            True if objects are equivalent, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/TextUnderlineType.py

@@ -8,9 +8,28 @@ import abc
 
 class TextUnderlineType(Enum):
     """
-    <summary>
-        Represents the type of text underline.
-    </summary>
+    Represents the type of text underline.
+
+    Attributes:
+        UnDefined: Undefined underline type.
+        none: No underline.
+        Words: Words underline.
+        Single: Single underline.
+        Double: Double underline.
+        Heavy: Heavy underline.
+        Dotted: Dotted underline.
+        HeavyDotted: Heavy dotted underline.
+        Dashed: Dashed underline.
+        HeavyDashed: Heavy dashed underline.
+        LongDashed: Long dashed underline.
+        HeavyLongDashed: Heavy long dashed underline.
+        DotDash: Dot-dash underline.
+        HeavyDotDash: Heavy dot-dash underline.
+        DotDotDash: Dot-dot-dash underline.
+        HeavyDotDotDash: Heavy dot-dot-dash underline.
+        Wavy: Wavy underline.
+        HeavyWavy: Heavy wavy underline.
+        DoubleWavy: Double wavy underline.
     """
     UnDefined = -1
     none = 0

spire/presentation/TextVerticalOverflowType.py

@@ -8,9 +8,13 @@ import abc
 
 class TextVerticalOverflowType(Enum):
     """
-    <summary>
-        Represents text vertical overflow type.
-    </summary>
+    Represents text vertical overflow type.
+
+    Attributes:
+        none: No overflow.
+        Overflow: Overflow behavior.
+        Ellipsis: Ellipsis behavior.
+        Clip: Clip behavior.
     """
     none = -1
     Overflow = 0

spire/presentation/Theme.py

@@ -8,18 +8,17 @@ import abc
 
 class Theme (  IActivePresentation) :
     """
-    <summary>
-        Represents a theme.
-    </summary>
+    Represents a theme with color schemes, font schemes, and format schemes.
+
     """
     @property
 
     def Name(self)->str:
         """
-    <summary>
-        Gets the name of a theme.
-            Read-only <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the name of the theme.
+
+        Returns:
+            str: Current name of the theme.
         """
         GetDllLibPpt().Theme_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().Theme_get_Name.restype=c_void_p
@@ -29,6 +28,12 @@ class Theme (  IActivePresentation) :
 
     @Name.setter
     def Name(self, value:str):
+        """
+        Sets the name of the theme.
+
+        Args:
+            value (str): New name to set.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().Theme_set_Name.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().Theme_set_Name,self.Ptr,valuePtr)
@@ -37,10 +42,10 @@ class Theme (  IActivePresentation) :
 
     def ColorScheme(self)->'ColorScheme':
         """
-    <summary>
-        Gets the color scheme.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ColorScheme" />.
-    </summary>
+        Gets the color scheme of the theme.
+
+        Returns:
+            ColorScheme: Current color scheme.
         """
         GetDllLibPpt().Theme_get_ColorScheme.argtypes=[c_void_p]
         GetDllLibPpt().Theme_get_ColorScheme.restype=c_void_p
@@ -53,10 +58,10 @@ class Theme (  IActivePresentation) :
 
     def FontScheme(self)->'FontScheme':
         """
-    <summary>
-        Gets the font scheme.
-            Read-only <see cref="T:Spire.Presentation.FontScheme" />.
-    </summary>
+        Gets the shape format scheme.
+
+        Returns:
+            FormatScheme: Current format scheme.
         """
         GetDllLibPpt().Theme_get_FontScheme.argtypes=[c_void_p]
         GetDllLibPpt().Theme_get_FontScheme.restype=c_void_p
@@ -69,10 +74,10 @@ class Theme (  IActivePresentation) :
 
     def FormatScheme(self)->'FormatScheme':
         """
-    <summary>
-        Gets the shape format scheme.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatScheme" />.
-    </summary>
+        Gets the parent presentation.
+
+        Returns:
+            Presentation: Parent presentation object.
         """
         GetDllLibPpt().Theme_get_FormatScheme.argtypes=[c_void_p]
         GetDllLibPpt().Theme_get_FormatScheme.restype=c_void_p
@@ -85,10 +90,13 @@ class Theme (  IActivePresentation) :
 
     def Presentation(self)->'Presentation':
         """
-    <summary>
-        Gets the parent presentation.
-            Read-only <see cref="T:Spire.Presentation.PresentationPptx" />.
-    </summary>
+        Determines if this theme equals another object.
+
+        Args:
+            obj (SpireObject): Object to compare with.
+
+        Returns:
+            bool: True if objects are equal, False otherwise.
         """
         GetDllLibPpt().Theme_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().Theme_get_Presentation.restype=c_void_p

spire/presentation/TileFlipMode.py

@@ -8,9 +8,14 @@ import abc
 
 class TileFlipMode(Enum):
     """
-    <summary>
-        Defines tile flipping mode.
-    </summary>
+    Defines tile flipping mode.
+    
+    Attributes:
+        UnDefined: Undefined flipping mode
+        none: No flipping
+        Horizontal: Horizontal flipping
+        Vertical: Vertical flipping
+        HorizontalAndVertical: Both horizontal and vertical flipping
     """
     UnDefined = -1
     none = 0

spire/presentation/TriState.py

@@ -8,9 +8,8 @@ import abc
 
 class TriState(Enum):
     """
-    <summary>
-        Represents triple boolean values.
-    </summary>
+    Represents triple boolean values.
+   
     """
     Null = -1
     TFalse = 0

spire/presentation/VerticalTextType.py

@@ -8,9 +8,17 @@ import abc
 
 class VerticalTextType(Enum):
     """
-    <summary>
-        Indicates vertical writing mode for a text.
-    </summary>
+    Specifies vertical writing modes for text.
+    
+    Attributes:
+        none: No vertical text
+        Horizontal: Regular horizontal text
+        Vertical: Vertical text (top-to-bottom)
+        Vertical270: Vertical text (bottom-to-top)
+        WordArtVertical: WordArt vertical text
+        EastAsianVertical: East Asian vertical text
+        MongolianVertical: Mongolian vertical text
+        WordArtVerticalRightToLeft: WordArt vertical right-to-left
     """
     none = -1
     Horizontal = 0

spire/presentation/VideoData.py

@@ -8,18 +8,16 @@ import abc
 
 class VideoData (SpireObject) :
     """
-    <summary>
-        Represents an image embedded into a presentation.
-    </summary>
+    Represents a video embedded into a presentation.
     """
     @property
 
     def ContentType(self)->str:
         """
-    <summary>
-        Gets a MIME type of an video, encoded in <see cref="P:Spire.Presentation.VideoData.Data" />.
-            Read-only <see cref="T:System.String" />.
-    </summary>
+        Get the MIME type of the video.
+        
+        Returns:
+            str: The MIME type string
         """
         GetDllLibPpt().VideoData_get_ContentType.argtypes=[c_void_p]
         GetDllLibPpt().VideoData_get_ContentType.restype=c_void_p
@@ -58,9 +56,10 @@ class VideoData (SpireObject) :
 
     def Stream(self)->'Stream':
         """
-    <summary>
-        Gets stream.
-    </summary>
+        Get the video data stream.
+        
+        Returns:
+            Stream: The stream object containing video data
         """
         GetDllLibPpt().VideoData_get_Stream.argtypes=[c_void_p]
         GetDllLibPpt().VideoData_get_Stream.restype=c_void_p
@@ -72,10 +71,10 @@ class VideoData (SpireObject) :
 
     def GetStream(self)->'Stream':
         """
-    <summary>
-        Gets stream from video.
-    </summary>
-    <returns></returns>
+        Get a stream containing the video data.
+        
+        Returns:
+            Stream: The stream object containing video data
         """
         GetDllLibPpt().VideoData_GetStream.argtypes=[c_void_p]
         GetDllLibPpt().VideoData_GetStream.restype=c_void_p
@@ -87,10 +86,10 @@ class VideoData (SpireObject) :
 
     def SaveToFile(self ,fileName:str):
         """
-    <summary>
-        Save video to disk.
-    </summary>
-    <param name="fileName"></param>
+        Save the video to a file.
+        
+        Args:
+            fileName (str): Path to save the video file
         """
         
         fileNamePtr = StrToPtr(fileName)

spire/presentation/VideoPlayMode.py

@@ -8,9 +8,13 @@ import abc
 
 class VideoPlayMode(Enum):
     """
-    <summary>
-        Indicates how a video is played.
-    </summary>
+    Specifies how a video should be played during a presentation.
+
+    Attributes:
+        Mixed: Mixed play mode
+        Auto: Play automatically
+        OnClick: Play when clicked
+        Presentation: Play as part of presentation
     """
     Mixed = -1
     Auto = 0

spire/presentation/_Presentation.py

@@ -8,9 +8,9 @@ import abc
 
 class _Presentation (  PptObject) :
     """
-    <summary>
-        Represents an Presentation document. 
-    </summary>
+    Represents a Presentation document.
+    
+    This class provides methods for loading and saving presentation files from streams or files.
     """
 #
 #    def GetBytes(self)->List['Byte']:
@@ -27,7 +27,10 @@ class _Presentation (  PptObject) :
 
     def GetStream(self)->'Stream':
         """
+        Gets the presentation content as a stream.
 
+        Returns:
+            Stream: A stream containing the presentation data.
         """
         GetDllLibPpt()._Presentation_GetStream.argtypes=[c_void_p]
         GetDllLibPpt()._Presentation_GetStream.restype=c_void_p
@@ -40,7 +43,11 @@ class _Presentation (  PptObject) :
 
     def LoadFromStream(self ,stream:Stream,fileFormat:FileFormat):
         """
+        Loads the presentation from a stream.
 
+        Args:
+            stream: The stream containing the presentation data.
+            fileFormat: The format of the presentation file.
         """
         intPtrstream:c_void_p = stream.Ptr
         enumfileFormat:c_int = fileFormat.value
@@ -52,7 +59,11 @@ class _Presentation (  PptObject) :
 
     def LoadFromFile(self ,file:str,fileFormat:FileFormat):
         """
+        Loads the presentation from a file.
 
+        Args:
+            file: The path to the presentation file.
+            fileFormat: The format of the presentation file.
         """
         enumfileFormat:c_int = fileFormat.value
 
@@ -64,7 +75,10 @@ class _Presentation (  PptObject) :
 
     def LoadFromFile(self ,file:str):
         """
+        Loads the presentation from a file.
 
+        Args:
+            file: The path to the presentation file.
         """
         
         filePtr = StrToPtr(file)
@@ -75,7 +89,11 @@ class _Presentation (  PptObject) :
 
     def LoadFromFile(self ,file:str,password:str):
         """
+        Loads a password-protected presentation from a file.
 
+        Args:
+            file: The path to the presentation file.
+            password: The password to open the presentation.
         """
         
         filePtr = StrToPtr(file)
@@ -87,7 +105,12 @@ class _Presentation (  PptObject) :
 
     def LoadFromFile(self ,file:str,fileFormat:FileFormat,password:str):
         """
+        Loads a password-protected presentation from a file.
 
+        Args:
+            file: The path to the presentation file.
+            fileFormat: The format of the presentation file.
+            password: The password to open the presentation.
         """
         enumfileFormat:c_int = fileFormat.value
 
@@ -100,7 +123,11 @@ class _Presentation (  PptObject) :
 
     def SaveToFile(self ,stream:Stream,fileFormat:FileFormat):
         """
+        Saves the presentation to a stream.
 
+        Args:
+            stream: The stream to save the presentation to.
+            fileFormat: The format to save the presentation in.
         """
         intPtrstream:c_void_p = stream.Ptr
         enumfileFormat:c_int = fileFormat.value
@@ -112,12 +139,12 @@ class _Presentation (  PptObject) :
 
     def LoadFromStream(self ,stream:Stream,fileFormat:FileFormat,password:str):
         """
-    <summary>
-        Opens the document from a stream.
-    </summary>
-    <param name="stream">The document stream.</param>
-    <param name="fileFormat">The file format</param>
-    <param name="password">The password.</param>
+        Loads a password-protected presentation from a stream.
+
+        Args:
+            stream: The stream containing the presentation data.
+            fileFormat: The format of the presentation file.
+            password: The password to open the presentation.
         """
         intPtrstream:c_void_p = stream.Ptr
         enumfileFormat:c_int = fileFormat.value
@@ -130,7 +157,11 @@ class _Presentation (  PptObject) :
 
     def SaveToFile(self ,file:str,fileFormat:FileFormat):
         """
+        Saves the presentation to a file.
 
+        Args:
+            file: The path to save the presentation to.
+            fileFormat: The format to save the presentation in.
         """
         enumfileFormat:c_int = fileFormat.value