Package wx :: Package lib :: Package agw :: Module flatnotebook :: Class PageContainer
[frames | no frames]

Type PageContainer

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


This class acts as a container for the pages you add to FlatNotebook.
Method Summary
  __init__(self, parent, id, pos, size, style)
Default class constructor.
  AddPage(self, caption, selected, imgindex)
Add a page to the FlatNotebook.
  AdvanceSelection(self, bForward)
Cycles through the tabs.
  AssignImageList(self, imglist)
Assigns the image list for the page control.
  CanFitToScreen(self, page)
Returns wheter a tab can fit in the left space in the screen or not.
  ClearFlag(self, flag)
Deletes a flag from the FlatNotebook style.
  DeleteAllPages(self)
Deletes all the pages.
  DeletePage(self, page)
Delete the specified page from FlatNotebook.
  DoDeletePage(self, page)
Does the actual page deletion.
  DoSetSelection(self, page)
Does the actual selection of a page.
  DrawDragHint(self)
Draws small arrow at the place that the tab will be placed.
  EnableTab(self, page, enabled)
Enables or disables a tab.
  FireEvent(self, selection)
Fires the wxEVT_FLATNOTEBOOK_PAGE_CHANGING and wxEVT_FLATNOTEBOOK_PAGE_CHANGED events called from other methods (from menu selection or Smart Tabbing).
  GetEnabled(self, page)
Returns whether a tab is enabled or not.
  GetImageList(self)
Returns the image list for the page control.
  GetLastVisibleTab(self)
Returns the last visible tab.
  GetNumOfVisibleTabs(self)
Returns the number of visible tabs.
  GetNumTabsCanScrollLeft(self)
Returns the number of tabs than can be scrolled left.
  GetPageCount(self)
Returns the number of tabs in the FlatNotebook control.
  GetPageImage(self, page)
Returns the image index associated to a page.
  GetPageText(self, page)
Returns the tab caption of the page.
  GetSelection(self)
Returns the current selected page.
  GetSingleLineBorderColour(self)
Returns the colour for the single line border.
  HasFlag(self, flag)
Returns whether a flag is present in the FlatNotebook style.
  HitTest(self, pt)
HitTest method for PageContainer.
  InsertPage(self, indx, text, selected, imgindex)
Inserts a new page at the specified position.
  IsDefaultTabs(self)
Returns whether a tab has a default style.
  IsTabVisible(self, page)
Returns whether a tab is visible or not.
  MoveTabPage(self, nMove, nMoveTo)
Moves a tab inside the same FlatNotebook.
  OnDropTarget(self, x, y, nTabPage, wnd_oldContainer)
Handles the drop action from a DND operation.
  OnEraseBackground(self, event)
Handles the wx.EVT_ERASE_BACKGROUND event for PageContainer (does nothing).
  OnKeyDown(self, event)
When the PageContainer has the focus tabs can be changed with the left/right arrow keys.
  OnKillFocus(self, event)
Handles the wx.EVT_KILL_FOCUS event for PageContainer.
  OnLeftDClick(self, event)
Handles the wx.EVT_LEFT_DCLICK event for PageContainer.
  OnLeftDown(self, event)
Handles the wx.EVT_LEFT_DOWN events for PageContainer.
  OnLeftUp(self, event)
Handles the wx.EVT_LEFT_UP events for PageContainer.
  OnMiddleDown(self, event)
Handles the wx.EVT_MIDDLE_DOWN events for PageContainer.
  OnMouseEnterWindow(self, event)
Handles the wx.EVT_ENTER_WINDOW event for PageContainer.
  OnMouseLeave(self, event)
Handles the wx.EVT_LEAVE_WINDOW event for PageContainer.
  OnMouseMove(self, event)
Handles the wx.EVT_MOTION for PageContainer.
  OnMouseWheel(self, event)
Scroll tabs when the mouse wheels.
  OnPaint(self, event)
Handles the wx.EVT_PAINT event for PageContainer.
  OnRightDown(self, event)
Handles the wx.EVT_RIGHT_DOWN events for PageContainer.
  OnSetFocus(self, event)
Handles the wx.EVT_SET_FOCUS event for PageContainer.
  OnSize(self, event)
Handles the wx.EVT_SIZE events for PageContainer.
  OnTabMenuSelection(self, event)
Handles the wx.EVT_MENU event for PageContainer.
  PopupTabsMenu(self)
Pops up the menu activated with the drop down arrow in the navigation area.
  RotateLeft(self)
  RotateRight(self)
  SetFocusedPage(self, pageIndex)
Sets/Unsets the focus on the appropriate page.
  SetImageList(self, imglist)
Sets the image list for the page control.
  SetPageImage(self, page, imgindex)
Sets the image index associated to a page.
  SetPageText(self, page, text)
Sets the tab caption of the page.
  SetSelection(self, page)
Sets the selected page.
  ShowTabTooltip(self, tabIdx)
Shows a tab tooltip.
  TabHasImage(self, tabIdx)
Returns whether a tab has an associated image index or not.

Property Summary

Instance Method Details

__init__(self, parent, id=-1, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=0)
(Constructor)

Default class constructor.
Overrides:
wx.Panel.__init__

AddPage(self, caption, selected=False, imgindex=-1)

Add a page to the FlatNotebook.
Parameters:
caption - Specifies the text for the new page.

selected - Specifies whether the page should be selected.

imgindex -

Specifies the optional image index for the new page.

Return value: True if successful, False otherwise.

AdvanceSelection(self, bForward=True)

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

AssignImageList(self, imglist)

Assigns the image list for the page control.

CanFitToScreen(self, page)

Returns wheter a tab can fit in the left space in the screen or not.

ClearFlag(self, flag)

Deletes a flag from the FlatNotebook style.

DeleteAllPages(self)

Deletes all the pages.

DeletePage(self, page)

Delete the specified page from FlatNotebook.

DoDeletePage(self, page)

Does the actual page deletion.

DoSetSelection(self, page)

Does the actual selection of a page.

DrawDragHint(self)

Draws small arrow at the place that the tab will be placed.

EnableTab(self, page, enabled=True)

Enables or disables a tab.

FireEvent(self, selection)

Fires the wxEVT_FLATNOTEBOOK_PAGE_CHANGING and wxEVT_FLATNOTEBOOK_PAGE_CHANGED events called from other methods (from menu selection or Smart Tabbing). Utility function.

GetEnabled(self, page)

Returns whether a tab is enabled or not.

GetImageList(self)

Returns the image list for the page control.

GetLastVisibleTab(self)

Returns the last visible tab.

GetNumOfVisibleTabs(self)

Returns the number of visible tabs.

GetNumTabsCanScrollLeft(self)

Returns the number of tabs than can be scrolled left.

GetPageCount(self)

Returns the number of tabs in the FlatNotebook control.

GetPageImage(self, page)

Returns the image index associated to a page.

GetPageText(self, page)

Returns the tab caption of the page.

GetSelection(self)

Returns the current selected page.

GetSingleLineBorderColour(self)

Returns the colour for the single line border.

HasFlag(self, flag)

Returns whether a flag is present in the FlatNotebook style.
Overrides:
wx.Window.HasFlag

HitTest(self, pt)

HitTest method for PageContainer. Returns the flag (if any) and the hit page (if any).
Overrides:
wx.Window.HitTest

InsertPage(self, indx, text, selected=True, imgindex=-1)

Inserts a new page at the specified position.
Parameters:
indx - Specifies the position of the new page.

text - Specifies the text for the new page.

imgindex -

Specifies the optional image index for the new page.

Return value: True if successful, False otherwise.

IsDefaultTabs(self)

Returns whether a tab has a default style.

IsTabVisible(self, page)

Returns whether a tab is visible or not.

MoveTabPage(self, nMove, nMoveTo)

Moves a tab inside the same FlatNotebook.

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

Handles the drop action from a DND operation.

OnEraseBackground(self, event)

Handles the wx.EVT_ERASE_BACKGROUND event for PageContainer (does nothing).

OnKeyDown(self, event)

When the PageContainer has the focus tabs can be changed with the left/right arrow keys.

OnKillFocus(self, event)

Handles the wx.EVT_KILL_FOCUS event for PageContainer.

OnLeftDClick(self, event)

Handles the wx.EVT_LEFT_DCLICK event for PageContainer.

OnLeftDown(self, event)

Handles the wx.EVT_LEFT_DOWN events for PageContainer.

OnLeftUp(self, event)

Handles the wx.EVT_LEFT_UP events for PageContainer.

OnMiddleDown(self, event)

Handles the wx.EVT_MIDDLE_DOWN events for PageContainer.

OnMouseEnterWindow(self, event)

Handles the wx.EVT_ENTER_WINDOW event for PageContainer.

OnMouseLeave(self, event)

Handles the wx.EVT_LEAVE_WINDOW event for PageContainer.

OnMouseMove(self, event)

Handles the wx.EVT_MOTION for PageContainer.

OnMouseWheel(self, event)

Scroll tabs when the mouse wheels.

OnPaint(self, event)

Handles the wx.EVT_PAINT event for PageContainer.

OnRightDown(self, event)

Handles the wx.EVT_RIGHT_DOWN events for PageContainer.

OnSetFocus(self, event)

Handles the wx.EVT_SET_FOCUS event for PageContainer.

OnSize(self, event)

Handles the wx.EVT_SIZE events for PageContainer.

OnTabMenuSelection(self, event)

Handles the wx.EVT_MENU event for PageContainer.

PopupTabsMenu(self)

Pops up the menu activated with the drop down arrow in the navigation area.

SetFocusedPage(self, pageIndex=-1)

Sets/Unsets the focus on the appropriate page. If pageIndex is defaulted, we have lost focus and no focus indicator is drawn.

SetImageList(self, imglist)

Sets the image list for the page control.

SetPageImage(self, page, imgindex)

Sets the image index associated to a page.

SetPageText(self, page, text)

Sets the tab caption of the page.

SetSelection(self, page)

Sets the selected page.

ShowTabTooltip(self, tabIdx)

Shows a tab tooltip.

TabHasImage(self, tabIdx)

Returns whether a tab has an associated image index or not.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:53:20 2009 http://epydoc.sf.net