.. include:: headings.inc



.. _CollapsiblePaneEvent:

==========================================================================================================================================
|phoenix_title|  **CollapsiblePaneEvent**
==========================================================================================================================================

This event class is used for the events generated by :ref:`CollapsiblePane`.          





.. _CollapsiblePaneEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`CollapsiblePaneEvent` parameter.

- EVT_COLLAPSIBLEPANE_CHANGED: The user expanded or collapsed the collapsible pane.  








         



.. seealso:: :ref:`CollapsiblePane`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **CollapsiblePaneEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/CollapsiblePaneEvent_inheritance.png" alt="Inheritance diagram of CollapsiblePaneEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node5" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="245,5,381,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> <area shape="rect" id="node4" href="CollapsiblePaneEvent.html" title="This event class is used for the events generated by CollapsiblePane." alt="" coords="429,5,608,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~CollapsiblePaneEvent.__init__`                                           The constructor is not normally used by the user code.
:meth:`~CollapsiblePaneEvent.GetCollapsed`                                       Returns ``True`` if the pane has been collapsed.
:meth:`~CollapsiblePaneEvent.SetCollapsed`                                       Sets this as a collapsed pane event (if `collapsed`  is ``True``) or as an expanded pane event (if `collapsed`  is ``False``).
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~CollapsiblePaneEvent.Collapsed`                                          See :meth:`~CollapsiblePaneEvent.GetCollapsed` and :meth:`~CollapsiblePaneEvent.SetCollapsed`
================================================================================ ================================================================================


|


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

.. class:: CollapsiblePaneEvent(CommandEvent)

   This event class is used for the events generated by CollapsiblePane.
   
   **Possible constructors**::

       CollapsiblePaneEvent(generator, id, collapsed)
       



   .. method:: __init__(self, generator, id, collapsed)

      The constructor is not normally used by the user code.                  


      :param `generator`: 
      :type `generator`: Object
      :param `id`: 
      :type `id`: int
      :param `collapsed`: 
      :type `collapsed`: bool







   .. method:: GetCollapsed(self)

      Returns ``True`` if the pane has been collapsed.                  

      :rtype: `bool`








   .. method:: SetCollapsed(self, collapsed)

      Sets this as a collapsed pane event (if `collapsed`  is ``True``) or as an expanded pane event (if `collapsed`  is ``False``).                  


      :param `collapsed`: 
      :type `collapsed`: bool







   .. attribute:: Collapsed

      See :meth:`~CollapsiblePaneEvent.GetCollapsed` and :meth:`~CollapsiblePaneEvent.SetCollapsed`