.. 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.aui.AuiDefaultDockArt:

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiDefaultDockArt**
==========================================================================================================================================

This is the default art provider for :ref:`wx.aui.AuiManager`. 
         

Dock art can be customized by creating a class derived from this one, or replacing this class entirely. 
          




|

|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>AuiDefaultDockArt</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.aui.AuiDefaultDockArt_inheritance.svg" alt="Inheritance diagram of AuiDefaultDockArt" 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.aui.AuiDefaultDockArt.html" title="This is the default art provider for wx.aui.AuiManager." alt="" coords="5,82,216,111"/> <area shape="rect" id="node2" href="wx.aui.AuiDockArt.html" title="wx.aui.AuiDockArt  is part of the ``AUI`` class framework." alt="" coords="31,5,191,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.aui.AuiDefaultDockArt.__init__`                                       
:meth:`~wx.aui.AuiDefaultDockArt.Clone`                                          Create a copy of this :ref:`wx.aui.AuiDockArt`  instance.
:meth:`~wx.aui.AuiDefaultDockArt.DrawBackground`                                 Draws a background.
:meth:`~wx.aui.AuiDefaultDockArt.DrawBorder`                                     Draws a border.
:meth:`~wx.aui.AuiDefaultDockArt.DrawCaption`                                    Draws a caption.
:meth:`~wx.aui.AuiDefaultDockArt.DrawGripper`                                    Draws a gripper.
:meth:`~wx.aui.AuiDefaultDockArt.DrawIcon`                                       
:meth:`~wx.aui.AuiDefaultDockArt.DrawPaneButton`                                 Draws a button in the pane's title bar.
:meth:`~wx.aui.AuiDefaultDockArt.DrawSash`                                       Draws a sash between two windows.
:meth:`~wx.aui.AuiDefaultDockArt.GetColour`                                      Get the colour of a certain setting.
:meth:`~wx.aui.AuiDefaultDockArt.GetFont`                                        Get a font setting.
:meth:`~wx.aui.AuiDefaultDockArt.GetMetric`                                      Get the value of a certain setting.
:meth:`~wx.aui.AuiDefaultDockArt.SetColour`                                      Set a certain setting with the value `colour`.
:meth:`~wx.aui.AuiDefaultDockArt.SetFont`                                        Set a font setting.
:meth:`~wx.aui.AuiDefaultDockArt.SetMetric`                                      Set a certain setting with the value `new_val`.
================================================================================ ================================================================================


|


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


.. class:: wx.aui.AuiDefaultDockArt(AuiDockArt)

   **Possible constructors**::

       AuiDefaultDockArt() -> None
       
   
   This is the default art provider for AuiManager.



   .. method:: __init__(self)



      :rtype: `None`     








   .. method:: Clone(self)

      Create a copy of this :ref:`wx.aui.AuiDockArt`  instance. 
                 

      :rtype: :ref:`wx.aui.AuiDockArt`








   .. method:: DrawBackground(self, dc : DC, window : Window, orientation : int, rect : Rect)

      Draws a background. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `window`: 
      :type `window`: wx.Window
      :param `orientation`: 
      :type `orientation`: int
      :param `rect`: 
      :type `rect`: wx.Rect




      :rtype: `None`     








   .. method:: DrawBorder(self, dc : DC, window : Window, rect : Rect, pane : AuiPaneInfo)

      Draws a border. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `window`: 
      :type `window`: wx.Window
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `pane`: 
      :type `pane`: wx.aui.AuiPaneInfo




      :rtype: `None`     








   .. method:: DrawCaption(self, dc : DC, window : Window, text : str, rect : Rect, pane : AuiPaneInfo)

      Draws a caption. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `window`: 
      :type `window`: wx.Window
      :param `text`: 
      :type `text`: string
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `pane`: 
      :type `pane`: wx.aui.AuiPaneInfo




      :rtype: `None`     








   .. method:: DrawGripper(self, dc : DC, window : Window, rect : Rect, pane : AuiPaneInfo)

      Draws a gripper. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `window`: 
      :type `window`: wx.Window
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `pane`: 
      :type `pane`: wx.aui.AuiPaneInfo




      :rtype: `None`     








   .. method:: DrawIcon(self, dc : DC, rect : Rect, pane : AuiPaneInfo)




                


      :param `dc`: 
      :type `dc`: wx.DC
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `pane`: 
      :type `pane`: wx.aui.AuiPaneInfo




      :rtype: `None`     







      .. wxdeprecated:: 
         Not intended for the public API.   








   .. method:: DrawPaneButton(self, dc : DC, window : Window, button : int, button_state : int, rect : Rect, pane : AuiPaneInfo)

      Draws a button in the pane's title bar. 
                 

      `button`  can be one of the values of **AuiButtonId**. `button_state`  can be one of the values of **AuiPaneButtonState**. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `window`: 
      :type `window`: wx.Window
      :param `button`: 
      :type `button`: int
      :param `button_state`: 
      :type `button_state`: int
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `pane`: 
      :type `pane`: wx.aui.AuiPaneInfo




      :rtype: `None`     








   .. method:: DrawSash(self, dc : DC, window : Window, orientation : int, rect : Rect)

      Draws a sash between two windows. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `window`: 
      :type `window`: wx.Window
      :param `orientation`: 
      :type `orientation`: int
      :param `rect`: 
      :type `rect`: wx.Rect




      :rtype: `None`     








   .. method:: GetColour(self, id : int)

      Get the colour of a certain setting. 
                 

      `id`  can be one of the colour values of **AuiPaneDockArtSetting**. 
                 


      :param `id`: 
      :type `id`: int




      :rtype: `Colour`     








   .. method:: GetFont(self, id : int)

      Get a font setting. 
                 


      :param `id`: 
      :type `id`: int




      :rtype: `Font`     








   .. method:: GetMetric(self, id : int)

      Get the value of a certain setting. 
                 

      `id`  can be one of the size values of **AuiPaneDockArtSetting**. 
                 


      :param `id`: 
      :type `id`: int




      :rtype: `int`








   .. method:: SetColour(self, id : int, colour : Colour)

      Set a certain setting with the value `colour`. 
                 

      `id`  can be one of the colour values of **AuiPaneDockArtSetting**. 
                 


      :param `id`: 
      :type `id`: int
      :param `colour`: 
      :type `colour`: wx.Colour




      :rtype: `None`     








   .. method:: SetFont(self, id : int, font : Font)

      Set a font setting. 
                 


      :param `id`: 
      :type `id`: int
      :param `font`: 
      :type `font`: wx.Font




      :rtype: `None`     








   .. method:: SetMetric(self, id : int, new_val : int)

      Set a certain setting with the value `new_val`. 
                 

      `id`  can be one of the size values of **AuiPaneDockArtSetting**. 
                 


      :param `id`: 
      :type `id`: int
      :param `new_val`: 
      :type `new_val`: int




      :rtype: `None`