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

spire/presentation/TextParagraphProperties.py

@@ -8,18 +8,18 @@ import abc
 
 class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     """
-    <summary>
-        Contains the paragraph's formatting properties.
-    </summary>
+    Contains formatting properties for paragraphs in presentations.
     """
     @property
 
     def Level(self)->'Int16':
         """
-    <summary>
-        Gets or sets a level of a paragraph.
-            Read/write <see cref="T:System.Int16" />.
-    </summary>
+        Gets or sets the outline level of the paragraph.
+        
+        Higher values indicate deeper nesting in the outline hierarchy.
+        
+        Returns:
+            Int16: Current outline level (0-based)
         """
         GetDllLibPpt().TextParagraphProperties_get_Level.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_Level.restype=c_void_p
@@ -37,10 +37,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def TextTextBulletType(self)->'TextBulletType':
         """
-    <summary>
-        Gets or sets the bullet type of a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TextBulletType" />.
-    </summary>
+        Gets or sets the bullet type for the paragraph.
+        
+        Returns:
+            TextBulletType: Current bullet style type
         """
         GetDllLibPpt().TextParagraphProperties_get_TextTextBulletType.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_TextTextBulletType.restype=c_int
@@ -56,10 +56,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def BulletChar(self)->int:
         """
-    <summary>
-        Gets or sets the bullet char of a paragraph.
-            Read/write <see cref="T:System.Char" />.
-    </summary>
+        Gets or sets the character used for bullet points.
+        
+        Returns:
+            int: Unicode character code for bullet symbol
         """
         GetDllLibPpt().TextParagraphProperties_get_BulletChar.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_BulletChar.restype=c_int
@@ -75,10 +75,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def BulletFont(self)->'TextFont':
         """
-    <summary>
-        Gets or sets the bullet font of a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TextFont" />.
-    </summary>
+        Gets or sets the font used for bullet characters.
+        
+        Returns:
+            TextFont: Font definition for bullets
         """
         GetDllLibPpt().TextParagraphProperties_get_BulletFont.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_BulletFont.restype=c_void_p
@@ -95,10 +95,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def BulletSize(self)->float:
         """
-    <summary>
-        Gets or sets the bullet height of a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the size of bullet characters.
+        
+        Returns:
+            float: Current bullet size in points
         """
         GetDllLibPpt().TextParagraphProperties_get_BulletSize.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_BulletSize.restype=c_float
@@ -114,10 +114,12 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def BulletColor(self)->'ColorFormat':
         """
-    <summary>
-        Gets the color format of a bullet of a paragraph.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ColorFormat" />.
-    </summary>
+        Gets the color of bullet characters.
+        
+        Read-only property.
+        
+        Returns:
+            ColorFormat: Color definition for bullets
         """
         GetDllLibPpt().TextParagraphProperties_get_BulletColor.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_BulletColor.restype=c_void_p
@@ -130,10 +132,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def NumberedBulletStartWith(self)->'Int16':
         """
-    <summary>
-        Gets or sets the first number which is used for group of numbered bullets.
-            Read/write <see cref="T:System.Int16" />.
-    </summary>
+        Gets or sets the starting number for numbered lists.
+        
+        Returns:
+            Int16: Starting number value
         """
         GetDllLibPpt().TextParagraphProperties_get_NumberedBulletStartWith.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_NumberedBulletStartWith.restype=c_void_p
@@ -151,10 +153,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def NumberedBulletStyle(self)->'NumberedBulletStyle':
         """
-    <summary>
-        Gets or sets the style of a numbered bullet.
-            Read/write <see cref="T:Spire.Presentation.NumberedBulletStyle" />.
-    </summary>
+        Gets or sets the numbering style for numbered lists.
+        
+        Returns:
+            NumberedBulletStyle: Current numbering style
         """
         GetDllLibPpt().TextParagraphProperties_get_NumberedBulletStyle.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_NumberedBulletStyle.restype=c_int
@@ -171,10 +173,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def Alignment(self)->'TextAlignmentType':
         """
-    <summary>
-        Gets or sets the text alignment in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TextAlignmentType" />.
-    </summary>
+        Gets or sets the horizontal alignment of text.
+        
+        Returns:
+            TextAlignmentType: Current text alignment
         """
         GetDllLibPpt().TextParagraphProperties_get_Alignment.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_Alignment.restype=c_int
@@ -190,10 +192,12 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def LineSpacing(self)->float:
         """
-    <summary>
-        Gets or sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the spacing between baselines.
+        
+        Positive values indicate percentage, negative values indicate points.
+        
+        Returns:
+            float: Current line spacing value
         """
         GetDllLibPpt().TextParagraphProperties_get_LineSpacing.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_LineSpacing.restype=c_float
@@ -208,10 +212,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def SpaceBefore(self)->float:
         """
-    <summary>
-        Gets or sets the amount of space before the first line in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the spacing before the paragraph.
+        
+        Returns:
+            float: Current spacing before paragraph in points
         """
         GetDllLibPpt().TextParagraphProperties_get_SpaceBefore.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_SpaceBefore.restype=c_float
@@ -226,10 +230,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def SpaceAfter(self)->float:
         """
-    <summary>
-        Gets or sets the amount of space after the last line in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the spacing after the paragraph.
+        
+        Returns:
+            float: Current spacing after paragraph in points
         """
         GetDllLibPpt().TextParagraphProperties_get_SpaceAfter.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_SpaceAfter.restype=c_float
@@ -245,10 +249,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def EastAsianLineBreak(self)->'TriState':
         """
-    <summary>
-        Indicates whether the East Asian line break is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether East Asian line break rules are applied.
+        
+        Returns:
+            TriState: Current East Asian line break setting
         """
         GetDllLibPpt().TextParagraphProperties_get_EastAsianLineBreak.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_EastAsianLineBreak.restype=c_int
@@ -265,10 +269,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def RightToLeft(self)->'TriState':
         """
-    <summary>
-        Indicates whether the Right to Left writing is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether text is rendered right-to-left.
+        
+        Returns:
+            TriState: Current right-to-left text setting
         """
         GetDllLibPpt().TextParagraphProperties_get_RightToLeft.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_RightToLeft.restype=c_int
@@ -285,10 +289,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def LatinLineBreak(self)->'TriState':
         """
-    <summary>
-        Indicates whether the Latin line break is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether Latin line break rules are applied.
+        
+        Returns:
+            TriState: Current Latin line break setting
         """
         GetDllLibPpt().TextParagraphProperties_get_LatinLineBreak.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_LatinLineBreak.restype=c_int
@@ -305,10 +309,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def HangingPunctuation(self)->'TriState':
         """
-    <summary>
-        Indicates whether the hanging punctuation is used in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Gets or sets whether hanging punctuation is enabled.
+        
+        Returns:
+            TriState: Current hanging punctuation setting
         """
         GetDllLibPpt().TextParagraphProperties_get_HangingPunctuation.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_HangingPunctuation.restype=c_int
@@ -324,10 +328,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def LeftMargin(self)->float:
         """
-    <summary>
-        Gets or sets the left margin in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the left margin of the paragraph.
+        
+        Returns:
+            float: Current left margin in points
         """
         GetDllLibPpt().TextParagraphProperties_get_LeftMargin.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_LeftMargin.restype=c_float
@@ -342,10 +346,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def RightMargin(self)->float:
         """
-    <summary>
-        Gets or sets the right margin in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the right margin of the paragraph.
+        
+        Returns:
+            float: Current right margin in points
         """
         GetDllLibPpt().TextParagraphProperties_get_RightMargin.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_RightMargin.restype=c_float
@@ -360,10 +364,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def Indent(self)->float:
         """
-    <summary>
-        Gets or sets text indentation in a paragraph.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the text indentation of the paragraph.
+        
+        Returns:
+            float: Current text indentation in points
         """
         GetDllLibPpt().TextParagraphProperties_get_Indent.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_Indent.restype=c_float
@@ -378,10 +382,10 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def DefaultTabSize(self)->float:
         """
-    <summary>
-        Gets or sets default tabulation size.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the default tabulation size.
+        
+        Returns:
+            float: Current default tab size in points
         """
         GetDllLibPpt().TextParagraphProperties_get_DefaultTabSize.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_DefaultTabSize.restype=c_float
@@ -397,10 +401,12 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def TabStopsList(self)->'TabStopCollection':
         """
-    <summary>
-        Gets tabulations of a paragraph.
-            Read-only <see cref="T:Spire.Presentation.Collections.TabStopCollection" />.
-    </summary>
+        Gets the collection of tab stops for the paragraph.
+        
+        Read-only property.
+        
+        Returns:
+            TabStopCollection: Collection of tab stop definitions
         """
         GetDllLibPpt().TextParagraphProperties_get_TabStopsList.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_TabStopsList.restype=c_void_p
@@ -413,10 +419,12 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def FontAlignment(self)->'FontAlignmentType':
         """
-    <summary>
-        Gets or sets a font alignment in a paragraph.
-            Read/write <see cref="T:Spire.Presentation.FontAlignmentType" />.
-    </summary>
+        Gets or sets the vertical font alignment.
+        
+        Controls how characters are positioned relative to the text baseline.
+        
+        Returns:
+            FontAlignmentType: Current font alignment setting
         """
         GetDllLibPpt().TextParagraphProperties_get_FontAlignment.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_FontAlignment.restype=c_int
@@ -433,10 +441,12 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def DefaultTextRangeProperties(self)->'DefaultTextRangeProperties':
         """
-    <summary>
-        Gets default portion format of a paragraph.
-            Read-only <see cref="P:Spire.Presentation.TextParagraphProperties.DefaultTextRangeProperties" />.
-    </summary>
+        Gets the default text formatting properties.
+        
+        Read-only property providing base formatting for text ranges.
+        
+        Returns:
+            DefaultTextRangeProperties: Default text formatting properties
         """
         GetDllLibPpt().TextParagraphProperties_get_DefaultTextRangeProperties.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_DefaultTextRangeProperties.restype=c_void_p
@@ -448,7 +458,12 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
     @property
     def CustomBulletColor(self)->bool:
         """
-
+        Gets or sets whether custom bullet color is enabled.
+        
+        When True, bullet color can be customized independently.
+        
+        Returns:
+            bool: True if custom bullet color is enabled, False otherwise
         """
         GetDllLibPpt().TextParagraphProperties_get_CustomBulletColor.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_CustomBulletColor.restype=c_bool
@@ -464,12 +479,12 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def IsBulletInheritFont(self)->'TriState':
         """
-    <summary>
-        Indicates whether the bullet has own font or inherits it from the first portion in the paragraph.
-            <b>NullableBool.True</b> if bullet has own font and <b>NullableBool.False</b> if bullet
-            inherits font from the first portion in the paragraph.
-            Read/write <see cref="T:Spire.Presentation.TriState" />.
-    </summary>
+        Determines if bullet inherits font from paragraph text.
+        
+        Returns:
+            TriState: 
+                - True: Bullet uses its own font
+                - False: Bullet inherits font from first text portion
         """
         GetDllLibPpt().TextParagraphProperties_get_IsBulletInheritFont.argtypes=[c_void_p]
         GetDllLibPpt().TextParagraphProperties_get_IsBulletInheritFont.restype=c_int
@@ -485,7 +500,13 @@ class TextParagraphProperties (  IActiveSlide, IActivePresentation) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if two TextParagraphProperties objects are equivalent.
+        
+        Args:
+            obj: TextParagraphProperties object to compare with current instance
+            
+        Returns:
+            bool: True if objects are equal, False otherwise
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/TextRange.py

@@ -6,9 +6,15 @@ from spire.presentation import *
 from ctypes import *
 
 class TextRange (  TextCharacterProperties) :
+    """
+    Represents a segment of formatted text within a presentation.
+    """
 
     @dispatch
     def __init__(self):
+        """
+        Initializes a new empty TextRange instance.
+        """
         GetDllLibPpt().TextRange_Create.argtypes=[c_wchar_p]
         GetDllLibPpt().TextRange_Create.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().TextRange_Create,None)
@@ -16,6 +22,12 @@ class TextRange (  TextCharacterProperties) :
 
     @dispatch
     def __init__(self,value:str):
+        """
+        Initializes a new TextRange instance with specified text.
+
+        Args:
+            value: The initial text content for the range.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().TextRange_Create.argtypes=[c_char_p]
         GetDllLibPpt().TextRange_Create.restype = c_void_p
@@ -28,10 +40,10 @@ class TextRange (  TextCharacterProperties) :
 
     def Format(self)->'DefaultTextRangeProperties':
         """
-    <summary>
-        Gets or sets text range's formatting.
-            Readonly <see cref="!:DefaultTextRunProperties" />.
-    </summary>
+        Gets the formatting properties of the text range.
+
+        Returns:
+            DefaultTextRangeProperties: Read-only formatting properties.
         """
         GetDllLibPpt().TextRange_get_Format.argtypes=[c_void_p]
         GetDllLibPpt().TextRange_get_Format.restype=c_void_p
@@ -43,10 +55,10 @@ class TextRange (  TextCharacterProperties) :
 
     def DisplayFormat(self)->'DefaultTextRangeProperties':
         """
-    <summary>
-        Gets or sets text range's Display formatting.
-            Readonly <see cref="!:DefaultTextRunProperties" />.
-    </summary>
+        Gets the display formatting properties of the text range.
+
+        Returns:
+            DefaultTextRangeProperties: Read-only display formatting properties.
         """
         GetDllLibPpt().TextRange_get_DisplayFormat.argtypes=[c_void_p]
         GetDllLibPpt().TextRange_get_DisplayFormat.restype=c_void_p
@@ -58,9 +70,10 @@ class TextRange (  TextCharacterProperties) :
 
     def Paragraph(self)->'TextParagraph':
         """
-    <summary>
-        Gets paragraph of text range.
-    </summary>
+        Gets the parent paragraph containing this text range.
+
+        Returns:
+            TextParagraph: The parent paragraph object.
         """
         from spire.presentation.TextParagraph import TextParagraph
         GetDllLibPpt().TextRange_get_Paragraph.argtypes=[c_void_p]
@@ -74,7 +87,10 @@ class TextRange (  TextCharacterProperties) :
 
     def Text(self)->str:
         """
+        Gets or sets the text content of the range.
 
+        Returns:
+            str: The current text content.
         """
         GetDllLibPpt().TextRange_get_Text.argtypes=[c_void_p]
         GetDllLibPpt().TextRange_get_Text.restype=c_void_p
@@ -92,7 +108,10 @@ class TextRange (  TextCharacterProperties) :
 
     def Field(self)->'Field':
         """
+        Gets the field associated with this text range (if applicable).
 
+        Returns:
+            Field: The associated field object, or None if not a field.
         """
         GetDllLibPpt().TextRange_get_Field.argtypes=[c_void_p]
         GetDllLibPpt().TextRange_get_Field.restype=c_void_p
@@ -104,7 +123,10 @@ class TextRange (  TextCharacterProperties) :
 
     def AddField(self ,fieldType:'FieldType'):
         """
+        Converts the text range into a field of specified type.
 
+        Args:
+            fieldType: The type of field to create.
         """
         intPtrfieldType:c_void_p = fieldType.Ptr
 
@@ -113,7 +135,7 @@ class TextRange (  TextCharacterProperties) :
 
     def RemoveField(self):
         """
-
+        Removes field formatting from the text range.
         """
         GetDllLibPpt().TextRange_RemoveField.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().TextRange_RemoveField,self.Ptr)
@@ -121,7 +143,13 @@ class TextRange (  TextCharacterProperties) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines if the current object is equal to another object.
+
+        Args:
+            obj: The object to compare with the current object.
 
+        Returns:
+            bool: True if the objects are equal; otherwise False.
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/TextShapeType.py

@@ -8,9 +8,52 @@ import abc
 
 class TextShapeType(Enum):
     """
-    <summary>
-        Represents text wrapping shape.
-    </summary>
+    Enum representing text wrapping shapes.
+    
+    Attributes:
+        UnDefined: Undefined shape
+        none: No wrapping shape
+        Plain: Plain shape
+        Stop: Stop shape
+        Triangle: Triangle shape
+        TriangleInverted: Inverted triangle shape
+        Chevron: Chevron shape
+        ChevronInverted: Inverted chevron shape
+        RingInside: Inside ring shape
+        RingOutside: Outside ring shape
+        ArchUp: Upward arch shape
+        ArchDown: Downward arch shape
+        Circle: Circle shape
+        Button: Button shape
+        ArchUpPour: Upward arch pour shape
+        ArchDownPour: Downward arch pour shape
+        CirclePour: Circle pour shape
+        ButtonPour: Button pour shape
+        CurveUp: Upward curve shape
+        CurveDown: Downward curve shape
+        CanUp: Upward can shape
+        CanDown: Downward can shape
+        Wave1: Wave type 1 shape
+        Wave2: Wave type 2 shape
+        DoubleWave1: Double wave type 1 shape
+        Wave4: Wave type 4 shape
+        Inflate: Inflate shape
+        Deflate: Deflate shape
+        InflateBottom: Bottom inflate shape
+        DeflateBottom: Bottom deflate shape
+        InflateTop: Top inflate shape
+        DeflateTop: Top deflate shape
+        DeflateInflate: Deflate-inflate shape
+        DeflateInflateDeflate: Deflate-inflate-deflate shape
+        FadeRight: Right fade shape
+        FadeLeft: Left fade shape
+        FadeUp: Upward fade shape
+        FadeDown: Downward fade shape
+        SlantUp: Upward slant shape
+        SlantDown: Downward slant shape
+        CascadeUp: Upward cascade shape
+        CascadeDown: Downward cascade shape
+        Custom: Custom shape
     """
     UnDefined = -1
     none = 0

spire/presentation/TextStrikethroughType.py

@@ -8,9 +8,13 @@ import abc
 
 class TextStrikethroughType(Enum):
     """
-    <summary>
-        Represents the type of text strikethrough.
-    </summary>
+    Enum representing text strikethrough types.
+    
+    Attributes:
+        UnDefined: Undefined strikethrough
+        none: No strikethrough
+        Single: Single line strikethrough
+        Double: Double line strikethrough
     """
     UnDefined = -1
     none = 0