phoenix_title wx.lib.agw.labelbook.FlatImageBook

Default implementation of the image book, it is like a Notebook, except that images are used to control the different pages. This container is usually used for configuration dialogs etc.

Note

Currently, this control works properly for images of size 32x32 and bigger.


class_hierarchy Class Hierarchy

Inheritance diagram for class FlatImageBook:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


super_classes Known Superclasses

wx.lib.agw.labelbook.FlatBookBase


method_summary Methods Summary

__init__

Default class constructor.

CreateImageContainer

Creates the image container class for FlatImageBook.


api Class API

class FlatImageBook(FlatBookBase)

Default implementation of the image book, it is like a Notebook, except that images are used to control the different pages. This container is usually used for configuration dialogs etc.

Note

Currently, this control works properly for images of size 32x32 and bigger.


Methods

__init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, agwStyle=0, name="FlatImageBook")

Default class constructor.

Parameters:
  • parent – parent window. Must not be None;

  • id – window identifier. A value of -1 indicates a default value;

  • pos – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;

  • size – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform;

  • style – the underlying Panel window style;

  • agwStyle

    the AGW-specific window style. This can be a combination of the following bits:

    Window Styles

    Hex Value

    Description

    INB_BOTTOM

    0x1

    Place labels below the page area. Available only for FlatImageBook.

    INB_LEFT

    0x2

    Place labels on the left side. Available only for FlatImageBook.

    INB_RIGHT

    0x4

    Place labels on the right side.

    INB_TOP

    0x8

    Place labels above the page area.

    INB_BORDER

    0x10

    Draws a border around LabelBook or FlatImageBook.

    INB_SHOW_ONLY_TEXT

    0x20

    Shows only text labels and no images. Available only for LabelBook.

    INB_SHOW_ONLY_IMAGES

    0x40

    Shows only tab images and no label texts. Available only for LabelBook.

    INB_FIT_BUTTON

    0x80

    Displays a pin button to show/hide the book control.

    INB_DRAW_SHADOW

    0x100

    Draw shadows below the book tabs. Available only for LabelBook.

    INB_USE_PIN_BUTTON

    0x200

    Displays a pin button to show/hide the book control.

    INB_GRADIENT_BACKGROUND

    0x400

    Draws a gradient shading on the tabs background. Available only for LabelBook.

    INB_WEB_HILITE

    0x800

    On mouse hovering, tabs behave like html hyperlinks. Available only for LabelBook.

    INB_NO_RESIZE

    0x1000

    Don’t allow resizing of the tab area.

    INB_FIT_LABELTEXT

    0x2000

    Will fit the tab area to the longest text (or text+image if you have images) in all the tabs.

    INB_BOLD_TAB_SELECTION

    0x4000

    Show the selected tab text using a bold font.

  • name – the window name.



CreateImageContainer(self)

Creates the image container class for FlatImageBook.