AGW Logo

agw_title ImageContainer

Base class for FlatImageBook image container.

hierarchy Inheritance Diagram

Inheritance diagram for: ImageContainer

Inheritance diagram of ImageContainer


supclasses Known Superclasses


method_summary Methods Summary

__init__Default class constructor.
CanDoBottomStyleAllows the parent to examine the children type.
OnEraseBackgroundHandles the wx.EVT_ERASE_BACKGROUND event for ImageContainer.
OnMouseLeaveWindowHandles the wx.EVT_LEAVE_WINDOW event for ImageContainer.
OnMouseLeftDownHandles the wx.EVT_LEFT_DOWN event for ImageContainer.
OnMouseLeftUpHandles the wx.EVT_LEFT_UP event for ImageContainer.
OnMouseMoveHandles the wx.EVT_MOTION event for ImageContainer.
OnPaintHandles the wx.EVT_PAINT event for ImageContainer.
OnSizeHandles the wx.EVT_SIZE event for ImageContainer.

API Class API

class ImageContainer(ImageContainerBase)[source]

Base class for FlatImageBook image container.



__init__(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, agwStyle=0, name="ImageContainer")[source]

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 wx.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.


CanDoBottomStyle()[source]

Allows the parent to examine the children type. Some implementation (such as LabelBook), does not support top/bottom images, only left/right.



OnEraseBackground(event)[source]

Handles the wx.EVT_ERASE_BACKGROUND event for ImageContainer.

Parameters:event – a wx.EraseEvent event to be processed.


OnMouseLeaveWindow(event)[source]

Handles the wx.EVT_LEAVE_WINDOW event for ImageContainer.

Parameters:event – a wx.MouseEvent event to be processed.


OnMouseLeftDown(event)[source]

Handles the wx.EVT_LEFT_DOWN event for ImageContainer.

Parameters:event – a wx.MouseEvent event to be processed.



OnMouseLeftUp(event)[source]

Handles the wx.EVT_LEFT_UP event for ImageContainer.

Parameters:event – a wx.MouseEvent event to be processed.



OnMouseMove(event)[source]

Handles the wx.EVT_MOTION event for ImageContainer.

Parameters:event – a wx.MouseEvent event to be processed.



OnPaint(event)[source]

Handles the wx.EVT_PAINT event for ImageContainer.

Parameters:event – a wx.PaintEvent event to be processed.


OnSize(event)[source]

Handles the wx.EVT_SIZE event for ImageContainer.

Parameters:event – a wx.SizeEvent event to be processed.
Tree

Table Of Contents

Previous topic

FlatImageBook

Next topic

ImageContainerBase