wx.lib.flatnotebook.FlatNotebook

Package wx :: Package lib :: Module flatnotebook :: Class FlatNotebook

Type FlatNotebook

object --+                
         |                
    Object --+            
             |            
    EvtHandler --+        
                 |        
            Window --+    
                     |    
                 Panel --+
                         |
                        FlatNotebook

Display one or more windows in a notebook.

Events:

EVT_FLATNOTEBOOK_PAGE_CHANGING: sent when the active page in the notebook is changing
EVT_FLATNOTEBOOK_PAGE_CHANGED: sent when the active page in the notebook has changed
EVT_FLATNOTEBOOK_PAGE_CLOSING: sent when a page in the notebook is closing
EVT_FLATNOTEBOOK_PAGE_CLOSED: sent when a page in the notebook has been closed
EVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU: sent when the user clicks a tab in the notebook with the right mouse button

Method Summary
	`__init__(self, parent, id, pos, size, style, name)` Default class constructor.
	`AddPage(self, page, text, select, imageId)` Add a page to the `FlatNotebook`.
	`AdvanceSelection(self, forward)` Cycles through the tabs.
	`AssignImageList(self, imageList)` Assigns the image list for the page control.
	`DeleteAllPages(self)` Deletes all the pages.
	`DeletePage(self, page)` Deletes the specified page, and the associated window.
	`Enable(self, page, enabled)` Enables or disables a tab.
	`GetActiveTabColour(self)` Returns the active tab colour.
	`GetActiveTabTextColour(self)` Get the active tab text colour.
	`GetBorderColour(self)` Returns the border colour.
	`GetCurrentPage(self)` Returns the currently selected notebook page or None.
	`GetEnabled(self, page)` Returns whether a tab is enabled or not.
	`GetGradientColourBorder(self)` Gets the tab border colour.
	`GetGradientColourFrom(self)` Gets first gradient colour.
	`GetGradientColourTo(self)` Gets second gradient colour.
	`GetImageList(self)` Returns the associated image list.
	`GetNonActiveTabTextColour(self)` Returns the non active tabs text colour.
	`GetPadding(self)` Returns the amount of space around each page's icon and label, in pixels.
	`GetPage(self, page)` Returns the window at the given page position, or None.
	`GetPageBestSize(self)` Return the page best size.
	`GetPageCount(self)` Returns the number of pages in the `FlatNotebook` control.
	`GetPageImage(self, nPage)` Returns the image index for the given page.
	`GetPageIndex(self, win)` Returns the index at which the window is found.
	`GetPageShapeAngle(self, page_index)` Returns the angle associated to a tab.
	`GetPageText(self, nPage)` Returns the tab caption.
	`GetPreviousSelection(self)` Returns the previous selection.
	`GetSelection(self)` Returns the currently selected page, or -1 if none was selected.
	`GetTabArea(self)` Returns the associated page.
	`GetTabAreaColour(self)` Returns the area behind the tabs colour.
	`Init(self)` Initializes all the class attributes.
	`InsertPage(self, indx, page, text, select, imageId)` Inserts a new page at the specified position.
	`OnDropTarget(self, x, y, nTabPage, wnd_oldContainer)` Handles the drop action from a DND operation.
	`OnNavigationKey(self, event)` Handles the wx.EVT_NAVIGATION_KEY event for `FlatNotebook`.
	`RemovePage(self, page)` Deletes the specified page, without deleting the associated window.
	`SetActiveTabColour(self, color)` Sets the active tab colour.
	`SetActiveTabTextColour(self, textColour)` Sets the text colour for the active tab.
	`SetAllPagesShapeAngle(self, angle)` Sets the angle associated to all the tab.
	`SetGradientColourBorder(self, border)` Sets the tab border colour.
	`SetGradientColourFrom(self, fr)` Sets the starting colour for the gradient.
	`SetGradientColours(self, fr, to, border)` Sets the gradient colours for the tab.
	`SetGradientColourTo(self, to)` Sets the ending colour for the gradient.
	`SetImageList(self, imageList)` Sets the image list for the page control.
	`SetNonActiveTabTextColour(self, color)` Sets the non active tabs text colour.
	`SetPadding(self, padding)` Sets the amount of space around each page's icon and label, in pixels.
	`SetPageImage(self, page, image)` Sets the image index for the given page.
	`SetPageShapeAngle(self, page_index, angle)` Sets the angle associated to a tab.
	`SetPageText(self, page, text)` Sets the text for the given page.
	`SetRightClickMenu(self, menu)` Sets the popup menu associated to a right click on a tab.
	`SetSelection(self, page)` Sets the selection for the given page.
	`SetTabAreaColour(self, color)` Sets the area behind the tabs colour.
	`SetWindowStyleFlag(self, style)` Sets the `FlatNotebook` window style flags.

Property Summary

Instance Method Details

init(self, parent, id=-1, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=0, name='FlatNotebook')
(Constructor)

Default class constructor.

All the parameters are as in wxPython class construction, except the 'style': this can be assigned to whatever combination of FNB_* styles.

Overrides:: wx.Panel.__init__

AddPage(self, page, text, select=True, imageId=-1)

Add a page to the FlatNotebook.

Parameters:

page - Specifies the new page.

text - Specifies the text for the new page.

select - Specifies whether the page should be selected.

imageId -

Specifies the optional image index for the new page.

Return value: True if successful, False otherwise.

AdvanceSelection(self, forward=True)

Cycles through the tabs. The call to this function generates the page changing events.

AssignImageList(self, imageList)

Assigns the image list for the page control.

DeleteAllPages(self)

Deletes all the pages.

DeletePage(self, page)

Deletes the specified page, and the associated window. The call to this function generates the page changing events.

Enable(self, page, enabled=True)

Enables or disables a tab.

Overrides:: wx.Window.Enable

GetActiveTabColour(self)

Returns the active tab colour.

GetActiveTabTextColour(self)

Get the active tab text colour.

GetBorderColour(self)

Returns the border colour.

GetCurrentPage(self)

Returns the currently selected notebook page or None.

GetEnabled(self, page)

Returns whether a tab is enabled or not.

GetGradientColourBorder(self)

Gets the tab border colour.

GetGradientColourFrom(self)

Gets first gradient colour.

GetGradientColourTo(self)

Gets second gradient colour.

GetImageList(self)

Returns the associated image list.

GetNonActiveTabTextColour(self)

Returns the non active tabs text colour.

GetPadding(self)

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

GetPage(self, page)

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

GetPageBestSize(self)

Return the page best size.

GetPageCount(self)

Returns the number of pages in the FlatNotebook control.

GetPageImage(self, nPage)

Returns the image index for the given page. Image is an index into the image list which was set with SetImageList.

GetPageIndex(self, win)

Returns the index at which the window is found.

GetPageShapeAngle(self, page_index)

Returns the angle associated to a tab.

GetPageText(self, nPage)

Returns the tab caption.

GetPreviousSelection(self)

Returns the previous selection.

GetSelection(self)

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

GetTabArea(self)

Returns the associated page.

GetTabAreaColour(self)

Returns the area behind the tabs colour.

Init(self)

Initializes all the class attributes.

InsertPage(self, indx, page, text, select=True, imageId=-1)

Inserts a new page at the specified position.

Parameters:

indx - Specifies the position of the new page.

page - Specifies the new page.

text - Specifies the text for the new page.

select - Specifies whether the page should be selected.

imageId -

Specifies the optional image index for the new page.

Return value: True if successful, False otherwise.

OnDropTarget(self, x, y, nTabPage, wnd_oldContainer)

Handles the drop action from a DND operation.

OnNavigationKey(self, event)

Handles the wx.EVT_NAVIGATION_KEY event for FlatNotebook.

RemovePage(self, page)

Deletes the specified page, without deleting the associated window.

SetActiveTabColour(self, color)

Sets the active tab colour.

SetActiveTabTextColour(self, textColour)

Sets the text colour for the active tab.

SetAllPagesShapeAngle(self, angle)

Sets the angle associated to all the tab.

SetGradientColourBorder(self, border)

Sets the tab border colour.

SetGradientColourFrom(self, fr)

Sets the starting colour for the gradient.

SetGradientColours(self, fr, to, border)

Sets the gradient colours for the tab.

SetGradientColourTo(self, to)

Sets the ending colour for the gradient.

SetImageList(self, imageList)

Sets the image list for the page control.

SetNonActiveTabTextColour(self, color)

Sets the non active tabs text colour.

SetPadding(self, padding)

Sets the amount of space around each page's icon and label, in pixels. NB: only the horizontal padding is considered.

SetPageImage(self, page, image)

Sets the image index for the given page. Image is an index into the image list which was set with SetImageList.

SetPageShapeAngle(self, page_index, angle)

Sets the angle associated to a tab.

SetPageText(self, page, text)

Sets the text for the given page.

SetRightClickMenu(self, menu)

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

SetSelection(self, page)

Sets the selection for the given page. The call to this function generates the page changing events

SetTabAreaColour(self, color)

Sets the area behind the tabs colour.

SetWindowStyleFlag(self, style)

Sets the FlatNotebook window style flags.

Overrides:: wx.Window.SetWindowStyleFlag

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:07:18 2007

http://epydoc.sf.net