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

Inheritance diagram for class
Separator:
|
|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`.