.. 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.AuiDockingGuide:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.aui.framemanager.AuiDockingGuide**
==========================================================================================================================================
Base class for :class:`AuiSingleDockingGuide` and :class:`AuiCenterDockingGuide`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
AuiDockingGuide:
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.aui.framemanager.AuiCenterDockingGuide`, :class:`wx.lib.agw.aui.framemanager.AuiSingleDockingGuide`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Frame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuide.__init__` Default class constructor. Used internally, do not call it in your code!
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuide.HitTest` To be overridden by parent classes.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuide.ValidateNotebookDocking` To be overridden by parent classes.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: AuiDockingGuide(wx.Frame)
Base class for :class:`AuiSingleDockingGuide` and :class:`AuiCenterDockingGuide`.
.. method:: __init__(self, parent, id=wx.ID_ANY, title="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.FRAME_TOOL_WINDOW | wx.STAY_ON_TOP | wx.FRAME_NO_TASKBAR | wx.NO_BORDER, name="AuiDockingGuide")
Default class constructor. Used internally, do not call it in your code!
:param `parent`: the :class:`AuiManager` parent;
:param integer `id`: the window identifier. It may take a value of -1 to indicate a default value.
:param string `title`: the caption to be displayed on the frame's title bar.
:param wx.Point `pos`: the window position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform.
:param wx.Size `size`: the window size. A value of (-1, -1) indicates a default size, chosen by
either the windowing system or wxPython, depending on platform.
:param integer `style`: the window style.
:param string `name`: the name of the window. This parameter is used to associate a name with the
item, allowing the application user to set Motif resource values for individual windows.
.. method:: HitTest(self, x, y)
To be overridden by parent classes.
:param integer `x`: the `x` mouse position;
:param integer `y`: the `y` mouse position.
.. method:: ValidateNotebookDocking(self, valid)
To be overridden by parent classes.
:param bool `valid`: whether a pane can be docked on top to another to form an automatic
:class:`~wx.lib.agw.aui.auibook.AuiNotebook`.