Package wx :: Package lib :: Package agw :: Module labelbook

[frames | no frames]

## Module wx.lib.agw.labelbook

    Description
    ===========

    LabelBook and FlatImageBook are a quasi-full implementations of the wx.Notebook,
    and designed to be a drop-in replacement for wx.Notebook. The API functions are
    similar so one can expect the function to behave in the same way.
    LabelBook anf FlatImageBook share their appearance with wx.Toolbook and
    wx.Listbook, while having more options for custom drawings, label positioning,
    mouse pointing and so on. Moreover, they retain also some visual characteristics
    of the Outlook address book.

    Some features:

      - They are generic controls;
      - Supports for left, right, top (FlatImageBook only), bottom (FlatImageBook
        only) book styles;
      - Possibility to draw images only, text only or both (FlatImageBook only);
      - Support for a "pin-button", that allows the user to shrink/expand the book
        tab area;
      - Shadows behind tabs (LabelBook only);
      - Gradient shading of the tab area (LabelBook only);
      - Web-like mouse pointing on tabs style (LabelBook only);
      - Many customizable colours (tab area, active tab text, tab borders, active
        tab, highlight) - LabelBook only.

    And much more. See the demo for a quasi-complete review of all the functionalities
    of LabelBook and FlatImageBook.

    Events
    ======

    LabelBook and FlatImageBook implement 4 events:

      - EVT_IMAGENOTEBOOK_PAGE_CHANGING;
      - EVT_IMAGENOTEBOOK_PAGE_CHANGED;
      - EVT_IMAGENOTEBOOK_PAGE_CLOSING;
      - EVT_IMAGENOTEBOOK_PAGE_CLOSED.

    Supported Platforms
    ===================

    LabelBook and FlatImageBook have been tested on the following platforms:
      * Windows (Windows XP);
      * Linux Ubuntu (Dapper 6.06)

    License And Version:
    ===================

    LabelBook and FlatImageBook are freeware and distributed under the wxPython license.

    Latest Revision: Andrea Gavana @ 15 Oct 2008, 22.30 GMT
    Version 0.1.

Classes
`FlatBookBase` | Base class for the containing window for LabelBook and FlatImageBook.
`FlatImageBook` | Default implementation of the image book, it is like a wx.Notebook, except that images are used to control the different pages.
`ImageContainer` | Base class for FlatImageBook image container.
`ImageContainerBase` | Base class for FlatImageBook image container.
`ImageInfo` | This class holds all the information (caption, image, etc...) belonging to a single tab in `ImageNotebook`.
`ImageNotebookEvent` | This events will be sent when a EVT_IMAGENOTEBOOK_PAGE_CHANGED, EVT_IMAGENOTEBOOK_PAGE_CHANGING, EVT_IMAGENOTEBOOK_PAGE_CLOSING, EVT_IMAGENOTEBOOK_PAGE_CLOSED is mapped in the parent.
`LabelBook` | An implementation of a notebook control - except that instead of having tabs to show labels, it labels to the right or left (arranged horozontally).
`LabelContainer` | Base class for LabelBook.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:52:21 2009 | http://epydoc.sf.net