Class Hierarchy¶

Inheritance diagram for class Simplebook:

Methods Summary¶

Class API¶

class wx.Simplebook(BookCtrlBase)¶

Possible constructors:

Simplebook() -> None

Simplebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
           style=0, name='') -> None

Simplebook is a control showing exactly one of its several pages.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Use Create later to really create the control.

Return type:

None

---

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=’’)

Constructs a simple book control.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• name (string)

Return type:

None

---

---

Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name='')¶

Really create the window of an object created using default constructor.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• name (string)

Return type:

bool

Added in version 4.0/wxWidgets-3.0.2.

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:

variant (WindowVariant)

Return type:

wx.VisualAttributes

---

SetEffect(self, effect)¶

Set the same effect to use for both showing and hiding the pages.

This is the same as SetEffects(effect, effect) .

Parameters:

effect (ShowEffect)

Return type:

None

See also

SetEffectTimeout

---

SetEffectTimeout(self, timeout)¶

Set the same effect timeout to use for both showing and hiding the pages.

This is the same as SetEffectsTimeouts(timeout, timeout) .

Parameters:

timeout

Return type:

None

See also

SetEffect

---

SetEffects(self, showEffect, hideEffect)¶

Set the effects to use for showing and hiding the pages.

This method allows specifying the effects passed to wx.Window.ShowWithEffect and wx.Window.HideWithEffect respectively when the pages need to be shown or hidden.

By default, no effects are used, but as the pages are only changed by the program and not the user himself, it may be useful to use some visual effects to make the changes more noticeable.

Parameters:

• showEffect (ShowEffect) – The effect to use for showing the newly selected page.

• hideEffect (ShowEffect) – The effect to use for hiding the previously selected page.

Return type:

None

See also

SetEffectsTimeouts

---

SetEffectsTimeouts(self, showTimeout, hideTimeout)¶

Set the effect timeout to use for showing and hiding the pages.

This method allows configuring the timeout arguments passed to wx.Window.ShowWithEffect and wx.Window.HideWithEffect if a non-default effect is used.

If this method is not called, default, system-dependent timeout is used.

Parameters:

• showTimeout – Timeout of the show effect, in milliseconds.

• hideTimeout – Timeout of the hide effect, in milliseconds.

Return type:

None

See also

SetEffects

---

ShowNewPage(self, page)¶

Add a new page and show it immediately.

This is simply a thin wrapper around the base class wx.BookCtrlBase.AddPage method using empty label (which is unused by this class anyhow) and selecting the new page immediately.

Parameters:

page (wx.Window)

Return type:

bool