.. wxPython Phoenix documentation This file was generated by Phoenix's sphinx generator and associated tools, do not edit by hand. Copyright: (c) 2011-2020 by Total Control Software License: wxWindows License .. include:: headings.inc .. _wx.richtext.RichTextStyleComboCtrl: ========================================================================================================================================== |phoenix_title| **wx.richtext.RichTextStyleComboCtrl** ========================================================================================================================================== This is a combo control that can display the styles in a :ref:`wx.richtext.RichTextStyleSheet`, and apply the selection to an associated :ref:`wx.richtext.RichTextCtrl`. See ``samples/richtext`` for an example of how to use it. .. seealso:: :ref:`wx.richtext.RichTextStyleListBox`, :ref:`RichTextCtrl Overview <richtextctrl overview>` | |class_hierarchy| Class Hierarchy ================================= .. raw:: html <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;"> <img id="toggleBlock-trigger" src="_static/images/closed.png"/> Inheritance diagram for class <strong>RichTextStyleComboCtrl</strong>: </div> <div id="toggleBlock-summary" style="display:block;"></div> <div id="toggleBlock-content" style="display:none;"> <p class="graphviz"> <center><img src="_static/images/inheritance/wx.richtext.RichTextStyleComboCtrl_inheritance.svg" alt="Inheritance diagram of RichTextStyleComboCtrl" usemap="#dummy" class="inheritance"/></center> <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script> <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.richtext.RichTextStyleComboCtrl.html" title="This is a combo control that can display the styles in a wx.richtext.RichTextStyleSheet, and apply the selection to an associated wx.richtext.RichTextCtrl." alt="" coords="48,389,331,418"/> <area shape="rect" id="node2" href="wx.ComboCtrl.html" title="A combo control is a generic combobox that allows totally custom popup." alt="" coords="125,313,254,341"/> <area shape="rect" id="node3" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="69,236,174,265"/> <area shape="rect" id="node4" href="wx.TextEntry.html" title="Common base class for single line text entry fields." alt="" coords="198,236,317,265"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window is the base class for all windows and represents any visible object on screen." alt="" coords="66,159,177,188"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node7" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map> </p> </div> | |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.richtext.RichTextStyleComboCtrl.__init__` Constructor. :meth:`~wx.richtext.RichTextStyleComboCtrl.Create` Creates the windows. :meth:`~wx.richtext.RichTextStyleComboCtrl.GetClassDefaultAttributes` :meth:`~wx.richtext.RichTextStyleComboCtrl.GetRichTextCtrl` Returns the :ref:`wx.richtext.RichTextCtrl` associated with this control. :meth:`~wx.richtext.RichTextStyleComboCtrl.GetStyleSheet` Returns the style sheet associated with this control. :meth:`~wx.richtext.RichTextStyleComboCtrl.SetRichTextCtrl` Associates the control with a :ref:`wx.richtext.RichTextCtrl`. :meth:`~wx.richtext.RichTextStyleComboCtrl.SetStyleSheet` Associates the control with a style sheet. :meth:`~wx.richtext.RichTextStyleComboCtrl.UpdateStyles` Updates the combo control from the associated style sheet. ================================================================================ ================================================================================ | |property_summary| Properties Summary ===================================== ================================================================================ ================================================================================ :attr:`~wx.richtext.RichTextStyleComboCtrl.RichTextCtrl` See :meth:`~wx.richtext.RichTextStyleComboCtrl.GetRichTextCtrl` and :meth:`~wx.richtext.RichTextStyleComboCtrl.SetRichTextCtrl` :attr:`~wx.richtext.RichTextStyleComboCtrl.StyleSheet` See :meth:`~wx.richtext.RichTextStyleComboCtrl.GetStyleSheet` and :meth:`~wx.richtext.RichTextStyleComboCtrl.SetStyleSheet` ================================================================================ ================================================================================ | |api| Class API =============== .. class:: wx.richtext.RichTextStyleComboCtrl(ComboCtrl) **Possible constructors**:: RichTextStyleComboCtrl(parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0) -> None RichTextStyleComboCtrl() -> None This is a combo control that can display the styles in a RichTextStyleSheet, and apply the selection to an associated RichTextCtrl. .. method:: __init__(self, *args, **kw) |overload| **Overloaded Implementations:** :html:`<hr class="overloadsep" /><br />` **__init__** `(self, parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0)` Constructor. :param `parent`: :type `parent`: wx.Window :param `id`: :type `id`: wx.WindowID :param `pos`: :type `pos`: wx.Point :param `size`: :type `size`: wx.Size :param `style`: :type `style`: long :rtype: `None` :html:`<hr class="overloadsep" /><br />` **__init__** `(self)` :rtype: `None` :html:`<hr class="overloadsep" /><br />` .. method:: Create(self, parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0) Creates the windows. :param `parent`: :type `parent`: wx.Window :param `id`: :type `id`: wx.WindowID :param `pos`: :type `pos`: wx.Point :param `size`: :type `size`: wx.Size :param `style`: :type `style`: long :rtype: `bool` .. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL) :param `variant`: :type `variant`: wx.WindowVariant :rtype: `VisualAttributes` .. method:: GetRichTextCtrl(self) Returns the :ref:`wx.richtext.RichTextCtrl` associated with this control. :rtype: :ref:`wx.richtext.RichTextCtrl` .. method:: GetStyleSheet(self) Returns the style sheet associated with this control. :rtype: :ref:`wx.richtext.RichTextStyleSheet` .. method:: SetRichTextCtrl(self, ctrl : RichTextCtrl) Associates the control with a :ref:`wx.richtext.RichTextCtrl`. :param `ctrl`: :type `ctrl`: wx.richtext.RichTextCtrl :rtype: `None` .. method:: SetStyleSheet(self, styleSheet : RichTextStyleSheet) Associates the control with a style sheet. :param `styleSheet`: :type `styleSheet`: wx.richtext.RichTextStyleSheet :rtype: `None` .. method:: UpdateStyles(self) Updates the combo control from the associated style sheet. :rtype: `None` .. attribute:: RichTextCtrl See :meth:`~wx.richtext.RichTextStyleComboCtrl.GetRichTextCtrl` and :meth:`~wx.richtext.RichTextStyleComboCtrl.SetRichTextCtrl` .. attribute:: StyleSheet See :meth:`~wx.richtext.RichTextStyleComboCtrl.GetStyleSheet` and :meth:`~wx.richtext.RichTextStyleComboCtrl.SetStyleSheet`