phoenix_title wx.lib.agw.flatnotebook.FlatNotebook

The FlatNotebook is a full implementation of the Notebook, and designed to be a drop-in replacement for Notebook. The API functions are similar so one can expect the function to behave in the same way.


class_hierarchy Class Hierarchy

Inheritance diagram for class FlatNotebook:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


sub_classes Known Subclasses

wx.lib.agw.flatnotebook.FlatNotebookCompatible


super_classes Known Superclasses

wx.Panel


method_summary Methods Summary

__init__

Default class constructor.

AddPage

Adds a page to the FlatNotebook.

AdvanceSelection

Cycles through the tabs.

AssignImageList

Assigns the image list for the page control.

DeleteAllPages

Deletes all the pages in the FlatNotebook.

DeletePage

Deletes the specified page, and the associated window.

DoGetBestSize

Gets the size which best suits the window: for a control, it would be the

EnableTab

Enables or disables a tab.

EnsureVisible

Ensures that a tab is visible.

GetActiveTabColour

Returns the active tab colour.

GetActiveTabTextColour

Get the active tab text colour.

GetAGWWindowStyleFlag

Returns the FlatNotebook window style.

GetBorderColour

Returns the border colour.

GetCurrentPage

Returns the currently selected notebook page or None if none is selected.

GetCustomPage

Returns a custom panel to show when there are no pages left in FlatNotebook.

GetEnabled

Returns whether a tab is enabled or not.

GetGradientColourBorder

Gets the tab border colour.

GetGradientColourFrom

Gets first gradient colour.

GetGradientColourTo

Gets second gradient colour.

GetImageList

Returns the associated image list.

GetNonActiveTabTextColour

Returns the non active tabs text colour.

GetPadding

Returns the amount of space around each page’s icon and label, in pixels.

GetPage

Returns the window at the given page position, or None.

GetPageBestSize

Return the page best size.

GetPageCount

Returns the number of pages in the FlatNotebook control.

GetPageImage

Returns the image index for the given page.

GetPageIndex

Returns the index at which the window is found.

GetPageShapeAngle

Returns the angle associated to a tab.

GetPageText

Returns the string for the given page.

GetPageTextColour

Returns the tab text colour if it has been set previously, or None otherwise.

GetPreviousSelection

Returns the previous selection.

GetSelection

Returns the currently selected page, or -1 if none was selected.

GetTabArea

Returns the associated page.

GetTabAreaColour

Returns the area behind the tabs colour.

GetTileOrientation

Returns the orientation when on tiling mode. This method can return

HasAGWFlag

Returns whether a flag is present in the FlatNotebook style.

HideTabs

Hides the tabs.

Init

Initializes all the class attributes.

InsertPage

Inserts a new page at the specified position.

OnDropTarget

Handles the drop action from a drag and drop operation.

OnNavigationKey

Handles the wx.EVT_NAVIGATION_KEY event for FlatNotebook.

RemovePage

Deletes the specified page, without deleting the associated window.

SetActiveTabColour

Sets the active tab colour.

SetActiveTabTextColour

Sets the text colour for the active tab.

SetAGWWindowStyleFlag

Sets the FlatNotebook window style flags.

SetAllPagesShapeAngle

Sets the angle associated to all the tab.

SetCustomPage

Sets a custom panel to show when there are no pages left in FlatNotebook.

SetGradientColourBorder

Sets the tab border colour.

SetGradientColourFrom

Sets the starting colour for the gradient.

SetGradientColours

Sets the gradient colours for the tab.

SetGradientColourTo

Sets the ending colour for the gradient.

SetImageList

Sets the image list for the page control.

SetNavigatorIcon

Set the icon used by the TabNavigatorWindow.

SetNonActiveTabTextColour

Sets the non active tabs text colour.

SetPadding

Sets the amount of space around each page’s icon and label, in pixels.

SetPageImage

Sets the image index for the given page.

SetPageShapeAngle

Sets the angle associated to a tab.

SetPageText

Sets the text for the given page.

SetPageTextColour

Sets the tab text colour individually.

SetRightClickMenu

Sets the popup menu associated to a right click on a tab.

SetSelection

Sets the selection for the given page.

SetTabAreaColour

Sets the area behind the tabs colour.

ShowCustomPage

Hides the custom panel which is shown when there are no pages left in FlatNotebook.

ShowTabs

Shows the tabs if hidden previously.

Tile

Shows pages in column/row mode (one panel after the other in columns/rows).


api Class API

class FlatNotebook(wx.Panel)

The FlatNotebook is a full implementation of the Notebook, and designed to be a drop-in replacement for Notebook. The API functions are similar so one can expect the function to behave in the same way.


Methods

__init__(self, parent, id=wx.ID_ANY,