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

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