.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.aui.framemanager
.. highlight:: python
.. _wx.lib.agw.aui.framemanager.AuiCenterDockingGuide:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.aui.framemanager.AuiCenterDockingGuide**
==========================================================================================================================================
A docking guide window for multiple docking hint (diamond-shaped HUD).
|
|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>AuiCenterDockingGuide</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.aui.framemanager.AuiCenterDockingGuide_inheritance.png" alt="Inheritance diagram of AuiCenterDockingGuide" 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.aui.framemanager.AuiCenterDockingGuide.html" title="A docking guide window for multiple docking hint (diamond-shaped HUD)." alt="" coords="5,624,389,653"/> <area shape="rect" id="node2" href="wx.lib.agw.aui.framemanager.AuiDockingGuide.html" title="Base class for AuiSingleDockingGuide and AuiCenterDockingGuide." alt="" coords="27,547,367,576"/> <area shape="rect" id="node3" href="wx.Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="153,469,241,499"/> <area shape="rect" id="node4" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow is a common base class for wx.Dialog and wx.Frame." alt="" coords="118,392,277,421"/> <area shape="rect" id="node5" href="wx.NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="112,315,283,344"/> <area shape="rect" id="node6" href="wx.Window.html" title="wx.Window is the base class for all windows and represents any visible object on screen." alt="" coords="149,237,246,267"/> <area shape="rect" id="node7" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="132,160,263,189"/> <area shape="rect" id="node8" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="138,83,257,112"/> <area shape="rect" id="node9" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="92,5,180,35"/> <area shape="rect" id="node10" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="205,5,315,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.aui.framemanager.AuiDockingGuide`
|
|method_summary| Methods Summary
================================
================================================================================== ================================================================================
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.__init__` Default class constructor.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.AeroMove` Moves the docking guide window to the new position.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.CreateShapesWithStyle` Creates the docking guide window shape based on which docking bitmaps are used.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.HitTest` Checks if the mouse position is inside the target windows rect.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.OnEraseBackground` Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`AuiCenterDockingGuide`.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.OnPaint` Handles the ``wx.EVT_PAINT`` event for :class:`AuiCenterDockingGuide`.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.SetGuideShape` Sets the correct shape for the docking guide window.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.UpdateDockGuide` Updates the docking guides images depending on the mouse position, using focused
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.ValidateNotebookDocking` Sets whether a pane can be docked on top of another to create an automatic
================================================================================== ================================================================================
|
|api| Class API
===============
.. class:: AuiCenterDockingGuide(AuiDockingGuide)
A docking guide window for multiple docking hint (diamond-shaped HUD).
.. method:: __init__(self, parent)
Default class constructor.
Used internally, do not call it in your code!
:param `parent`: the :class:`AuiManager` parent.
.. method:: AeroMove(self, pos)
Moves the docking guide window to the new position.
:param wx.Point `pos`: the new docking guide position.
.. method:: CreateShapesWithStyle(self)
Creates the docking guide window shape based on which docking bitmaps are used.
.. method:: HitTest(self, x, y)
Checks if the mouse position is inside the target windows rect.
:param integer `x`: the `x` mouse position;
:param integer `y`: the `y` mouse position.
.. method:: OnEraseBackground(self, event)
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`AuiCenterDockingGuide`.
:param `event`: :class:`EraseEvent` to be processed.
.. note:: This is intentionally empty to reduce flickering while drawing.
.. method:: OnPaint(self, event)
Handles the ``wx.EVT_PAINT`` event for :class:`AuiCenterDockingGuide`.
:param `event`: a :class:`PaintEvent` to be processed.
.. method:: SetGuideShape(self, event=None)
Sets the correct shape for the docking guide window.
:param `event`: on wxGTK, a :class:`wx.WindowCreateEvent` event to process.
.. method:: UpdateDockGuide(self, pos)
Updates the docking guides images depending on the mouse position, using focused
images if the mouse is inside the docking guide or unfocused images if it is
outside.
:param wx.Point `pos`: the mouse position.
.. method:: ValidateNotebookDocking(self, valid)
Sets whether a pane can be docked on top of another to create an automatic
:class:`~wx.lib.agw.aui.auibook.AuiNotebook`.
:param bool `valid`: whether a pane can be docked on top to another to form an automatic
:class:`~wx.lib.agw.aui.auibook.AuiNotebook`.