.. 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

.. currentmodule:: wx.lib.agw.buttonpanel

.. highlight:: python



.. _wx.lib.agw.buttonpanel.Separator:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.buttonpanel.Separator**
==========================================================================================================================================

This class holds all the information to size and draw a separator inside
:class:`ButtonPanel`.



|

|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>Separator</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.lib.agw.buttonpanel.Separator_inheritance.png" alt="Inheritance diagram of Separator" 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.lib.agw.buttonpanel.Separator.html" title="This class holds all the information to size and draw a separator inside" alt="" coords="5,237,240,267"/> <area shape="rect" id="node2" href="wx.lib.agw.buttonpanel.Control.html" title="This class represents a base class for all pseudo controls used in" alt="" coords="15,160,231,189"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="67,83,179,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="23,5,105,35"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="130,5,233,35"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.lib.agw.buttonpanel.Control`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.agw.buttonpanel.Separator.__init__`                               Default class constructor.
:meth:`~wx.lib.agw.buttonpanel.Separator.Draw`                                   Draws the separator. Actually the drawing is done in :class:`BPArt`.
:meth:`~wx.lib.agw.buttonpanel.Separator.GetBestSize`                            Returns the separator best size.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: Separator(Control)

   This class holds all the information to size and draw a separator inside
   :class:`ButtonPanel`.

   .. method:: __init__(self, parent)

      Default class constructor.
      
      :param `parent`: the separator parent object, an instance of :class:`ButtonPanel`.


   .. method:: Draw(self, dc, rect)

      Draws the separator. Actually the drawing is done in :class:`BPArt`.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param wx.Rect `rect`: the separator client rectangle.


   .. method:: GetBestSize(self)

      Returns the separator best size.
      
      :return: An instance of :class:`wx.Size`.