wx.lib.agw.aui.auibook.TabFrame

TabFrame is an interesting case. It’s important that all child pages of the multi-notebook control are all actually children of that control (and not grandchildren). TabFrame facilitates this. There is one instance of TabFrame for each tab control inside the multi-notebook.

It’s important to know that TabFrame is not a real window, but it merely used to capture the dimensions/positioning of the internal tab control and it’s managed page windows.

Class Hierarchy

Inheritance diagram for class TabFrame:

Known Superclasses

wx.Window

Methods Summary

__init__	Default class constructor.
DoGetClientSize	Returns the window client size.
DoGetSize	Returns the window size.
DoSetSize	Sets the position and size of the window in pixels. The flags
DoSizing	Does the actual sizing of the tab control.
SetTabCtrlHeight	Sets the tab control height.
Show	Shows/hides the window.
Update	Calling this method immediately repaints the invalidated area of the window

Class API

---

class TabFrame(wx.Window)

TabFrame is an interesting case. It’s important that all child pages of the multi-notebook control are all actually children of that control (and not grandchildren). TabFrame facilitates this. There is one instance of TabFrame for each tab control inside the multi-notebook.

It’s important to know that TabFrame is not a real window, but it merely used to capture the dimensions/positioning of the internal tab control and it’s managed page windows.

Methods

---

__init__(self, parent)

Default class constructor. Used internally, do not call it in your code!

---

DoGetClientSize(self)

Returns the window client size.

Note

Overridden from wx.Control.

---

DoGetSize(self)

Returns the window size.

Note

Overridden from wx.Control.

---

DoSetSize(self, x, y, width, height, flags=wx.SIZE_AUTO)

Sets the position and size of the window in pixels. The flags parameter indicates the interpretation of the other params if they are equal to -1.

Parameters:

• x (integer) – the window x position;
• y (integer) – the window y position;
• width (integer) – the window width;
• height (integer) – the window height;
• flags (integer) – may have one of this bit set:

  Size Flags	Description
  wx.SIZE_AUTO	A -1 indicates that a class-specific default should be used.
  wx.SIZE_AUTO_WIDTH	A -1 indicates that a class-specific default should be used for the width.
  wx.SIZE_AUTO_HEIGHT	A -1 indicates that a class-specific default should be used for the height.
  wx.SIZE_USE_EXISTING	Existing dimensions should be used if -1 values are supplied.
  wx.SIZE_ALLOW_MINUS_ONE	Allow dimensions of -1 and less to be interpreted as real dimensions, not default values.
  wx.SIZE_FORCE	Normally, if the position and the size of the window are already the same as the parameters of this function, nothing is done. but with this flag a window resize may be forced even in this case (supported in wx 2.6.2 and later and only implemented for MSW and ignored elsewhere currently)

Note

Overridden from wx.Control.

---

DoSizing(self)

Does the actual sizing of the tab control.

---

SetTabCtrlHeight(self, h)

Sets the tab control height.

Parameters:h (integer) – the tab area height.

---

Show(self, show=True)

Shows/hides the window.

Parameters:show (bool) – True to show the window, False otherwise.

Note

Overridden from wx.Control, this method always returns False as TabFrame should never be phisically shown on screen.

---

Update(self)

Calling this method immediately repaints the invalidated area of the window and all of its children recursively while this would usually only happen when the flow of control returns to the event loop.

Note

Notice that this function doesn’t invalidate any area of the window so nothing happens if nothing has been invalidated (i.e. marked as requiring a redraw). Use Refresh first if you want to immediately redraw the window unconditionally.

Note

Overridden from wx.Control.