auibook.TabFrame

Inheritance diagram for TabFrame:


digraph inheritancea37a4a33df {
rankdir=LR;
size="8.0, 12.0";
  "auibook.TabFrame" [style="setlinewidth(0.5)",URL="#auibook.TabFrame",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "wx._windows.PyWindow" -> "auibook.TabFrame" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._windows.PyWindow" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.Window" -> "wx._windows.PyWindow" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.EvtHandler" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.Object" -> "wx._core.EvtHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.Window" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.EvtHandler" -> "wx._core.Window" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.Object" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
}


Description

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 API

Methods

class TabFrame

Bases: wx._windows.PyWindow

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.

__init__()
Default class constructor. Used internally, do not call it in your code!
DoGetClientSize()

Overridden from wx.PyControl.

Returns the window client size.

DoGetSize()

Overridden from wx.PyControl.

Returns the window size.

DoSetSize(x, y, width, height, flags=3)

Overridden from wx.PyControl.

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 – the window x position;
  • y – the window y position;
  • width – the window width;
  • height – the window height;
  • flags – 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)
DoSizing()
Does the actual sizing of the tab control.
SetTabCtrlHeight(h)

Sets the tab control height.

Parameter:h – the tab area height.
Show(show=True)

Overridden from wx.PyControl.

Shows/hides the window.

Update()

Overridden from wx.PyControl.

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.

Table Of Contents

This Page