# encoding: utf-8
# module wx._richtext
# from D:\project\A_Board\.venv\Lib\site-packages\wx\_richtext.cp313-win_amd64.pyd
# by generator 1.147
# no doc

# imports
import sip as __sip
import wx._adv as __wx__adv
import wx._core as __wx__core
import wx._html as __wx__html


class RichTextObject(__wx__core.Object):
    """
    RichTextObject(parent=None) -> None
    
    This is the base for drawable rich text objects.
    """
    def AcceptsFocus(self): # real signature unknown; restored from __doc__
        """
        AcceptsFocus() -> bool
        
        Returns true if objects of this class can accept the focus, i.e. a
        call to SetFocusObject is possible.
        """
        return False

    def AdjustAttributes(self, attr, context): # real signature unknown; restored from __doc__
        """
        AdjustAttributes(attr, context) -> bool
        
        Adjusts the attributes for virtual attribute provision, collapsed
        borders, etc.
        """
        return False

    def AdjustAvailableSpace(self, dc, buffer, parentAttr, childAttr, availableParentSpace, availableContainerSpace): # real signature unknown; restored from __doc__
        """
        AdjustAvailableSpace(dc, buffer, parentAttr, childAttr, availableParentSpace, availableContainerSpace) -> wx.Rect
        
        Returns the rectangle which the child has available to it given
        restrictions specified in the child attribute, e.g.
        """
        pass

    def CalculateRange(self, start): # real signature unknown; restored from __doc__
        """
        CalculateRange(start) -> int
        
        Calculates the range of the object.
        """
        return 0

    def CanEditProperties(self): # real signature unknown; restored from __doc__
        """
        CanEditProperties() -> bool
        
        Returns true if we can edit the object's properties via a GUI.
        """
        return False

    def CanMerge(self, p_object, context): # real signature unknown; restored from __doc__
        """
        CanMerge(object, context) -> bool
        
        Returns true if this object can merge itself with the given one.
        """
        return False

    def CanSplit(self, context): # real signature unknown; restored from __doc__
        """
        CanSplit(context) -> bool
        
        Returns true if this object can potentially be split, by virtue of
        having different virtual attributes for individual sub-objects.
        """
        return False

    def Clone(self): # real signature unknown; restored from __doc__
        """
        Clone() -> RichTextObject
        
        Clones the object.
        """
        return RichTextObject

    def ConvertPixelsToTenthsMM(self, *__args): # real signature unknown; restored from __doc__ with multiple overloads
        """
        ConvertPixelsToTenthsMM(dc, pixels) -> int
        ConvertPixelsToTenthsMM(ppi, pixels, scale=1.0) -> int
        
        Convert units in pixels to tenths of a millimetre.
        """
        return 0

    def ConvertTenthsMMToPixels(self, *__args): # real signature unknown; restored from __doc__ with multiple overloads
        """
        ConvertTenthsMMToPixels(dc, units) -> int
        ConvertTenthsMMToPixels(ppi, units, scale=1.0) -> int
        
        Converts units in tenths of a millimetre to device units.
        """
        return 0

    def Copy(self, obj): # real signature unknown; restored from __doc__
        """
        Copy(obj) -> None
        
        Copies the object.
        """
        pass

    def DeleteRange(self, range): # real signature unknown; restored from __doc__
        """
        DeleteRange(range) -> bool
        
        Deletes the given range.
        """
        return False

    def Dereference(self): # real signature unknown; restored from __doc__
        """
        Dereference() -> None
        
        Reference-counting allows us to use the same object in multiple lists
        (not yet used).
        """
        pass

    def DoSplit(self, pos): # real signature unknown; restored from __doc__
        """
        DoSplit(pos) -> RichTextObject
        
        Do a split from pos, returning an object containing the second part,
        and setting the first part in 'this'.
        """
        return RichTextObject

    def Draw(self, dc, context, range, selection, rect, descent, style): # real signature unknown; restored from __doc__
        """
        Draw(dc, context, range, selection, rect, descent, style) -> bool
        
        Draw the item, within the given range.
        """
        return False

    def DrawBorder(self, dc, buffer, attr, borders, rect, flags=0): # real signature unknown; restored from __doc__
        """
        DrawBorder(dc, buffer, attr, borders, rect, flags=0) -> bool
        
        Draws a border.
        """
        return False

    def DrawBoxAttributes(self, dc, buffer, attr, boxRect, flags=0, obj=None): # real signature unknown; restored from __doc__
        """
        DrawBoxAttributes(dc, buffer, attr, boxRect, flags=0, obj=None) -> bool
        
        Draws the borders and background for the given rectangle and
        attributes.
        """
        return False

    def EditProperties(self, parent, buffer): # real signature unknown; restored from __doc__
        """
        EditProperties(parent, buffer) -> bool
        
        Edits the object's properties via a GUI.
        """
        return False

    def FindPosition(self, dc, context, index, forceLineStart): # real signature unknown; restored from __doc__
        """
        FindPosition(dc, context, index, forceLineStart) -> Tuple[bool, wx.Point, int]
        
        Finds the absolute position and row height for the given character
        position.
        """
        pass

    def GetAbsolutePosition(self): # real signature unknown; restored from __doc__
        """
        GetAbsolutePosition() -> wx.Point
        
        Returns the absolute object position, by traversing up the
        child/parent hierarchy.
        """
        pass

    def GetAttributes(self): # real signature unknown; restored from __doc__
        """
        GetAttributes() -> RichTextAttr
        
        Returns the object's attributes.
        """
        return RichTextAttr

    def GetAvailableContentArea(self, dc, context, outerRect): # real signature unknown; restored from __doc__
        """
        GetAvailableContentArea(dc, context, outerRect) -> wx.Rect
        
        Calculates the available content space in the given rectangle, given
        the margins, border and padding specified in the object's attributes.
        """
        pass

    def GetBestSize(self): # real signature unknown; restored from __doc__
        """
        GetBestSize() -> wx.Size
        
        Returns the best size, i.e. the ideal starting size for this object
        irrespective of available space.
        """
        pass

    def GetBottomMargin(self): # real signature unknown; restored from __doc__
        """
        GetBottomMargin() -> int
        
        Returns the bottom margin of the object, in pixels.
        """
        return 0

    def GetBoxRects(self, dc, buffer, attr): # real signature unknown; restored from __doc__
        """
        GetBoxRects(dc, buffer, attr) -> Tuple[bool, wx.Rect, wx.Rect, wx.Rect, wx.Rect, wx.Rect]
        
        Returns the various rectangles of the box model in pixels.
        """
        pass

    def GetBuffer(self): # real signature unknown; restored from __doc__
        """
        GetBuffer() -> RichTextBuffer
        
        Returns the containing buffer.
        """
        return RichTextBuffer

    def GetCachedSize(self): # real signature unknown; restored from __doc__
        """
        GetCachedSize() -> wx.Size
        
        Gets the cached object size as calculated by Layout.
        """
        pass

    def GetContainer(self): # real signature unknown; restored from __doc__
        """
        GetContainer() -> RichTextParagraphLayoutBox
        
        Returns the top-level container of this object.
        """
        return RichTextParagraphLayoutBox

    def GetDescent(self): # real signature unknown; restored from __doc__
        """
        GetDescent() -> int
        
        Returns the stored descent value.
        """
        return 0

    def GetFloatDirection(self): # real signature unknown; restored from __doc__
        """
        GetFloatDirection() -> int
        
        Returns the floating direction.
        """
        return 0

    def GetLeftMargin(self): # real signature unknown; restored from __doc__
        """
        GetLeftMargin() -> int
        
        Returns the left margin of the object, in pixels.
        """
        return 0

    def GetMaxSize(self): # real signature unknown; restored from __doc__
        """
        GetMaxSize() -> wx.Size
        
        Gets the maximum object size as calculated by Layout.
        """
        pass

    def GetMinSize(self): # real signature unknown; restored from __doc__
        """
        GetMinSize() -> wx.Size
        
        Gets the minimum object size as calculated by Layout.
        """
        pass

    def GetName(self): # real signature unknown; restored from __doc__
        """
        GetName() -> str
        
        Returns the identifying name for this object from the properties,
        using the "name" key.
        """
        return ""

    def GetNaturalSize(self): # real signature unknown; restored from __doc__
        """
        GetNaturalSize() -> TextAttrSize
        
        Gets the 'natural' size for an object.
        """
        return TextAttrSize

    def GetOwnRange(self): # real signature unknown; restored from __doc__
        """
        GetOwnRange() -> RichTextRange
        
        Returns the object's own range (valid if top-level).
        """
        return RichTextRange

    def GetOwnRangeIfTopLevel(self): # real signature unknown; restored from __doc__
        """
        GetOwnRangeIfTopLevel() -> RichTextRange
        
        Returns the object's own range only if a top-level object.
        """
        return RichTextRange

    def GetParent(self): # real signature unknown; restored from __doc__
        """
        GetParent() -> RichTextObject
        
        Returns a pointer to the parent object.
        """
        return RichTextObject

    def GetParentContainer(self): # real signature unknown; restored from __doc__
        """
        GetParentContainer() -> RichTextParagraphLayoutBox
        
        Returns the top-level container of this object.
        """
        return RichTextParagraphLayoutBox

    def GetPosition(self): # real signature unknown; restored from __doc__
        """
        GetPosition() -> wx.Point
        
        Returns the object position in pixels.
        """
        pass

    def GetProperties(self): # real signature unknown; restored from __doc__
        """
        GetProperties() -> RichTextProperties
        
        Returns the object's properties.
        """
        return RichTextProperties

    def GetPropertiesMenuLabel(self): # real signature unknown; restored from __doc__
        """
        GetPropertiesMenuLabel() -> str
        
        Returns the label to be used for the properties context menu item.
        """
        return ""

    def GetRange(self): # real signature unknown; restored from __doc__
        """
        GetRange() -> RichTextRange
        
        Returns the object's range.
        """
        return RichTextRange

    def GetRangeSize(self, range, size, descent, dc, context, flags, position=None, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        GetRangeSize(range, size, descent, dc, context, flags, position=wx.Point(0,0), parentSize=wx.DefaultSize, partialExtents=None) -> bool
        
        Returns the object size for the given range.
        """
        pass

    def GetRect(self): # real signature unknown; restored from __doc__
        """
        GetRect() -> wx.Rect
        
        Returns the rectangle enclosing the object.
        """
        pass

    def GetRightMargin(self): # real signature unknown; restored from __doc__
        """
        GetRightMargin() -> int
        
        Returns the right margin of the object, in pixels.
        """
        return 0

    def GetSelection(self, start, end): # real signature unknown; restored from __doc__
        """
        GetSelection(start, end) -> RichTextSelection
        
        Returns a selection object specifying the selections between start and
        end character positions.
        """
        return RichTextSelection

    def GetTextForRange(self, range): # real signature unknown; restored from __doc__
        """
        GetTextForRange(range) -> str
        
        Returns any text in this object for the given range.
        """
        return ""

    def GetTopMargin(self): # real signature unknown; restored from __doc__
        """
        GetTopMargin() -> int
        
        Returns the top margin of the object, in pixels.
        """
        return 0

    def GetTotalMargin(self, dc, buffer, attr): # real signature unknown; restored from __doc__
        """
        GetTotalMargin(dc, buffer, attr) -> Tuple[bool, int, int, int, int]
        
        Returns the total margin for the object in pixels, taking into account
        margin, padding and border size.
        """
        pass

    def GetXMLNodeName(self): # real signature unknown; restored from __doc__
        """
        GetXMLNodeName() -> str
        
        Returns the XML node name of this object.
        """
        return ""

    def HandlesChildSelections(self): # real signature unknown; restored from __doc__
        """
        HandlesChildSelections() -> bool
        
        Returns true if this object can handle the selections of its children,
        fOr example a table.
        """
        return False

    def HitTest(self, dc, context, pt, flags=0): # real signature unknown; restored from __doc__
        """
        HitTest(dc, context, pt, flags=0) -> Tuple[int, int, RichTextObject, RichTextObject]
        
        Hit-testing: returns a flag indicating hit test details, plus
        information about position.
        """
        pass

    def ImportFromXML(self, buffer, node, handler, recurse): # real signature unknown; restored from __doc__
        """
        ImportFromXML(buffer, node, handler, recurse) -> bool
        
        Imports this object from XML.
        """
        return False

    def Invalidate(self, invalidRange=None): # real signature unknown; restored from __doc__
        """
        Invalidate(invalidRange=RICHTEXT_ALL) -> None
        
        Invalidates the object at the given range.
        """
        pass

    def IsAtomic(self): # real signature unknown; restored from __doc__
        """
        IsAtomic() -> bool
        
        Returns true if no user editing can be done inside the object.
        """
        return False

    def IsComposite(self): # real signature unknown; restored from __doc__
        """
        IsComposite() -> bool
        
        Returns true if this object is composite.
        """
        return False

    def IsEmpty(self): # real signature unknown; restored from __doc__
        """
        IsEmpty() -> bool
        
        Returns true if the object is empty.
        """
        return False

    def IsFloatable(self): # real signature unknown; restored from __doc__
        """
        IsFloatable() -> bool
        
        Returns true if this class of object is floatable.
        """
        return False

    def IsFloating(self): # real signature unknown; restored from __doc__
        """
        IsFloating() -> bool
        
        Returns true if this object is currently floating.
        """
        return False

    def IsShown(self): # real signature unknown; restored from __doc__
        """
        IsShown() -> bool
        
        Returns true if the object will be shown, false otherwise.
        """
        return False

    def IsTopLevel(self): # real signature unknown; restored from __doc__
        """
        IsTopLevel() -> bool
        
        Returns true if this object is top-level, i.e. contains its own
        paragraphs, such as a text box.
        """
        return False

    def Layout(self, dc, context, rect, parentRect, style): # real signature unknown; restored from __doc__
        """
        Layout(dc, context, rect, parentRect, style) -> bool
        
        Lay the item out at the specified position with the given size
        constraint.
        """
        return False

    def LayoutToBestSize(self, dc, context, buffer, parentAttr, attr, availableParentSpace, availableContainerSpace, style): # real signature unknown; restored from __doc__
        """
        LayoutToBestSize(dc, context, buffer, parentAttr, attr, availableParentSpace, availableContainerSpace, style) -> bool
        
        Lays out the object first with a given amount of space, and then if no
        width was specified in attr, lays out the object again using the
        minimum size.
        """
        return False

    def Merge(self, p_object, context): # real signature unknown; restored from __doc__
        """
        Merge(object, context) -> bool
        
        Returns true if this object merged itself with the given one.
        """
        return False

    def Move(self, pt): # real signature unknown; restored from __doc__
        """
        Move(pt) -> None
        
        Moves the object recursively, by adding the offset from old to new.
        """
        pass

    def Reference(self): # real signature unknown; restored from __doc__
        """
        Reference() -> None
        
        Reference-counting allows us to use the same object in multiple lists (not yet used).
        """
        pass

    def SetAttributes(self, attr): # real signature unknown; restored from __doc__
        """
        SetAttributes(attr) -> None
        
        Sets the object's attributes.
        """
        pass

    def SetCachedSize(self, sz): # real signature unknown; restored from __doc__
        """
        SetCachedSize(sz) -> None
        
        Sets the cached object size as calculated by Layout.
        """
        pass

    def SetDescent(self, descent): # real signature unknown; restored from __doc__
        """
        SetDescent(descent) -> None
        
        Sets the stored descent value.
        """
        pass

    def SetMargins(self, *__args): # real signature unknown; restored from __doc__ with multiple overloads
        """
        SetMargins(margin) -> None
        SetMargins(leftMargin, rightMargin, topMargin, bottomMargin) -> None
        
        Set the margin around the object, in pixels.
        """
        pass

    def SetMaxSize(self, sz): # real signature unknown; restored from __doc__
        """
        SetMaxSize(sz) -> None
        
        Sets the maximum object size as calculated by Layout.
        """
        pass

    def SetMinSize(self, sz): # real signature unknown; restored from __doc__
        """
        SetMinSize(sz) -> None
        
        Sets the minimum object size as calculated by Layout.
        """
        pass

    def SetName(self, name): # real signature unknown; restored from __doc__
        """
        SetName(name) -> None
        
        Sets the identifying name for this object as a property using the
        "name" key.
        """
        pass

    def SetOwnRange(self, range): # real signature unknown; restored from __doc__
        """
        SetOwnRange(range) -> None
        
        Set the object's own range, for a top-level object with its own
        position space.
        """
        pass

    def SetParent(self, parent): # real signature unknown; restored from __doc__
        """
        SetParent(parent) -> None
        
        Sets the pointer to the parent object.
        """
        pass

    def SetPosition(self, pos): # real signature unknown; restored from __doc__
        """
        SetPosition(pos) -> None
        
        Sets the object position in pixels.
        """
        pass

    def SetProperties(self, props): # real signature unknown; restored from __doc__
        """
        SetProperties(props) -> None
        
        Sets the object's properties.
        """
        pass

    def SetRange(self, range): # real signature unknown; restored from __doc__
        """
        SetRange(range) -> None
        
        Sets the object's range within its container.
        """
        pass

    def Show(self, show): # real signature unknown; restored from __doc__
        """
        Show(show) -> None
        
        Call to show or hide this object.
        """
        pass

    def Split(self, context): # real signature unknown; restored from __doc__
        """
        Split(context) -> RichTextObject
        
        Returns the final object in the split objects if this object was split
        due to differences between sub-object virtual attributes.
        """
        return RichTextObject

    def UsesParagraphAttributes(self): # real signature unknown; restored from __doc__
        """
        UsesParagraphAttributes() -> bool
        
        Returns true if this object takes note of paragraph attributes (text
        and image objects don't).
        """
        return False

    def __init__(self, parent=None): # real signature unknown; restored from __doc__
        pass

    AbsolutePosition = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetAbsolutePosition() -> wx.Point

Returns the absolute object position, by traversing up the
child/parent hierarchy."""

    Attributes = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetAttributes() -> RichTextAttr

Returns the object's attributes."""

    BestSize = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetBestSize() -> wx.Size

Returns the best size, i.e. the ideal starting size for this object
irrespective of available space."""

    BottomMargin = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetBottomMargin() -> int

Returns the bottom margin of the object, in pixels."""

    Buffer = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetBuffer() -> RichTextBuffer

Returns the containing buffer."""

    CachedSize = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetCachedSize() -> wx.Size

Gets the cached object size as calculated by Layout."""

    Container = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetContainer() -> RichTextParagraphLayoutBox

Returns the top-level container of this object."""

    Descent = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetDescent() -> int

Returns the stored descent value."""

    FloatDirection = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetFloatDirection() -> int

Returns the floating direction."""

    LeftMargin = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetLeftMargin() -> int

Returns the left margin of the object, in pixels."""

    MaxSize = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetMaxSize() -> wx.Size

Gets the maximum object size as calculated by Layout."""

    MinSize = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetMinSize() -> wx.Size

Gets the minimum object size as calculated by Layout."""

    Name = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetName() -> str

Returns the identifying name for this object from the properties,
using the "name" key."""

    NaturalSize = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetNaturalSize() -> TextAttrSize

Gets the 'natural' size for an object."""

    OwnRange = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetOwnRange() -> RichTextRange

Returns the object's own range (valid if top-level)."""

    OwnRangeIfTopLevel = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetOwnRangeIfTopLevel() -> RichTextRange

Returns the object's own range only if a top-level object."""

    Parent = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetParent() -> RichTextObject

Returns a pointer to the parent object."""

    ParentContainer = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetParentContainer() -> RichTextParagraphLayoutBox

Returns the top-level container of this object."""

    Position = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetPosition() -> wx.Point

Returns the object position in pixels."""

    Properties = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetProperties() -> RichTextProperties

Returns the object's properties."""

    PropertiesMenuLabel = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetPropertiesMenuLabel() -> str

Returns the label to be used for the properties context menu item."""

    Range = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetRange() -> RichTextRange

Returns the object's range."""

    Rect = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetRect() -> wx.Rect

Returns the rectangle enclosing the object."""

    RightMargin = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetRightMargin() -> int

Returns the right margin of the object, in pixels."""

    TopMargin = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetTopMargin() -> int

Returns the top margin of the object, in pixels."""

    XMLNodeName = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """GetXMLNodeName() -> str

Returns the XML node name of this object."""