Package gui :: Package wizards :: Module wiz_objects :: Class Wiz_page
[hide private]
[frames] | no frames]

Class Wiz_page

source code


The wizard pages to be placed inside the wizard.

To inherit from this class, you must minimally supply the add_contents() method. This method should build the specific GUI elements. The following methods are also designed to be overwritten:

The following methods can be used by add_contents() to create standard GUI elements:

These are described in full detail in their docstrings.

Instance Methods [hide private]
EvtHandler
__init__(self, parent, height_desc=220)
Set up the window.
source code
 
_add_title(self, sizer)
Add the title to the dialog.
source code
 
_apply(self, event=None)
Apply the operation.
source code
wx.Sizer instance
_build_main_section(self, sizer)
Add the main part of the dialog.
source code
 
add_artwork(self, sizer)
Add the artwork to the dialog.
source code
 
add_contents(self, sizer)
Add the specific GUI elements (dummy method).
source code
 
add_desc(self, sizer, max_y=220)
Add the description to the dialog.
source code
 
on_apply(self)
To be over-ridden if an action is to be performed on hitting the apply button.
source code
 
on_back(self)
To be over-ridden if an action is to be performed just before moving back to the previous page.
source code
 
on_completion(self)
To be over-ridden if an action is to be performed just after executing self.on_execute().
source code
 
on_display(self)
To be over-ridden if an action is to be performed prior to displaying the page.
source code
 
on_display_post(self)
To be over-ridden if an action is to be performed after the execution of the on_display() method.
source code
 
on_execute(self)
To be over-ridden if an action is to be performed just before exiting the page.
source code
 
on_init(self)
To be over-ridden if an action is to be performed when a page is newly displayed.
source code
 
on_next(self)
To be over-ridden if an action is to be performed just before moving to the next page.
source code

Inherited from wx._windows.Panel: Create, SetFocusIgnoringChildren, __repr__

Inherited from wx._core.Window: AcceptsFocus, AcceptsFocusFromKeyboard, AddChild, AdjustForLayoutDirection, AlwaysShowScrollbars, AssociateHandle, CacheBestSize, CanAcceptFocus, CanAcceptFocusFromKeyboard, CanApplyThemeBorder, CanBeOutsideClientArea, CanScroll, CanSetTransparent, CaptureMouse, Center, CenterOnParent, Centre, CentreOnParent, ClearBackground, ClientToScreen, ClientToScreenXY, ClientToWindowSize, Close, ConvertDialogPointToPixels, ConvertDialogSizeToPixels, ConvertPixelPointToDialog, ConvertPixelSizeToDialog, DLG_PNT, DLG_SZE, Destroy, DestroyChildren, Disable, DissociateHandle, DragAcceptFiles, Enable, FindWindowById, FindWindowByLabel, FindWindowByName, Fit, FitInside, Freeze, GetAcceleratorTable, GetAdjustedBestSize, GetAutoLayout, GetBackgroundColour, GetBackgroundStyle, GetBestFittingSize, GetBestSize, GetBestSizeTuple, GetBestVirtualSize, GetBorder, GetCaret, GetCharHeight, GetCharWidth, GetChildren, GetClientAreaOrigin, GetClientRect, GetClientSize, GetClientSizeTuple, GetConstraints, GetContainingSizer, GetCursor, GetDefaultAttributes, GetDropTarget, GetEffectiveMinSize, GetEventHandler, GetExtraStyle, GetFont, GetForegroundColour, GetFullTextExtent, GetGrandParent, GetGtkWidget, GetHandle, GetHelpText, GetHelpTextAtPoint, GetId, GetLabel, GetLayoutDirection, GetMainWindowOfCompositeControl, GetMaxClientSize, GetMaxHeight, GetMaxSize, GetMaxWidth, GetMinClientSize, GetMinHeight, GetMinSize, GetMinWidth, GetName, GetNextSibling, GetParent, GetPopupMenuSelectionFromUser, GetPosition, GetPositionTuple, GetPrevSibling, GetRect, GetScreenPosition, GetScreenPositionTuple, GetScreenRect, GetScrollPos, GetScrollRange, GetScrollThumb, GetSize, GetSizeTuple, GetSizer, GetTextExtent, GetThemeEnabled, GetToolTip, GetToolTipString, GetTopLevelParent, GetUpdateClientRect, GetUpdateRegion, GetValidator, GetVirtualSize, GetVirtualSizeTuple, GetWindowBorderSize, GetWindowStyle, GetWindowStyleFlag, GetWindowVariant, HandleAsNavigationKey, HandleWindowEvent, HasCapture, HasExtraStyle, HasFlag, HasFocus, HasMultiplePages, HasScrollbar, HasTransparentBackground, Hide, HideWithEffect, HitTest, HitTestXY, InformFirstDirection, InheritAttributes, InheritsBackgroundColour, InitDialog, InvalidateBestSize, IsBeingDeleted, IsDoubleBuffered, IsEnabled, IsExposed, IsExposedPoint, IsExposedRect, IsFrozen, IsRetained, IsScrollbarAlwaysShown, IsShown, IsShownOnScreen, IsThisEnabled, IsTopLevel, Layout, LineDown, LineUp, Lower, MakeModal, Move, MoveAfterInTabOrder, MoveBeforeInTabOrder, MoveXY, Navigate, NavigateIn, PageDown, PageUp, PopEventHandler, PopupMenu, PopupMenuXY, PostCreate, PostSizeEvent, PostSizeEventToParent, ProcessWindowEvent, PushEventHandler, Raise, Refresh, RefreshRect, RegisterHotKey, ReleaseMouse, RemoveChild, RemoveEventHandler, Reparent, ScreenToClient, ScreenToClientXY, ScrollLines, ScrollPages, ScrollWindow, SendIdleEvents, SendSizeEvent, SendSizeEventToParent, SetAcceleratorTable, SetAutoLayout, SetBackgroundColour, SetBackgroundStyle, SetBestFittingSize, SetCanFocus, SetCaret, SetClientRect, SetClientSize, SetClientSizeWH, SetConstraints, SetContainingSizer, SetCursor, SetDimensions, SetDoubleBuffered, SetDropTarget, SetEventHandler, SetExtraStyle, SetFocus, SetFocusFromKbd, SetFont, SetForegroundColour, SetHelpText, SetHelpTextForId, SetId, SetInitialSize, SetLabel, SetLayoutDirection, SetMaxClientSize, SetMaxSize, SetMinClientSize, SetMinSize, SetName, SetOwnBackgroundColour, SetOwnFont, SetOwnForegroundColour, SetPosition, SetRect, SetScrollPos, SetScrollbar, SetSize, SetSizeHints, SetSizeHintsSz, SetSizeWH, SetSizer, SetSizerAndFit, SetThemeEnabled, SetToolTip, SetToolTipString, SetTransparent, SetValidator, SetVirtualSize, SetVirtualSizeHints, SetVirtualSizeHintsSz, SetVirtualSizeWH, SetWindowStyle, SetWindowStyleFlag, SetWindowVariant, ShouldInheritColours, Show, ShowWithEffect, Thaw, ToggleWindowStyle, TransferDataFromWindow, TransferDataToWindow, UnregisterHotKey, UnsetToolTip, Update, UpdateWindowUI, UseBgCol, Validate, WarpPointer, WindowToClientSize

Inherited from wx._core.EvtHandler: AddPendingEvent, Bind, Connect, DeletePendingEvents, Disconnect, GetEvtHandlerEnabled, GetNextHandler, GetPreviousHandler, IsUnlinked, ProcessEvent, ProcessEventLocally, ProcessPendingEvents, QueueEvent, SafelyProcessEvent, SetEvtHandlerEnabled, SetNextHandler, SetPreviousHandler, Unbind, Unlink

Inherited from wx._core.EvtHandler (private): _setOORInfo

Inherited from wx._core.Object: GetClassName, IsSameAs

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from wx._windows.Panel: GetClassDefaultAttributes

Inherited from wx._core.Window: FindFocus, GetCapture, NewControlId, ReleaseControlId, UnreserveControlId

Class Variables [hide private]
  art_spacing = 20
  divider = None
hash(x)
  height_element = 27
  image_path = u'/data/relax/tags/3.3.9/graphics/misc/relax.gif'
  main_text = ''
  setup_fail = False
  size_button = (100, 33)
  size_square_button = (33, 33)
  title = ''
Properties [hide private]

Inherited from wx._windows.Panel: thisown

Inherited from wx._core.Window: AcceleratorTable, AutoLayout, BackgroundColour, BackgroundStyle, BestSize, BestVirtualSize, Border, Caret, CharHeight, CharWidth, Children, ClientAreaOrigin, ClientRect, ClientSize, Constraints, ContainingSizer, Cursor, DefaultAttributes, DropTarget, EffectiveMinSize, Enabled, EventHandler, ExtraStyle, Font, ForegroundColour, GrandParent, GtkWidget, Handle, HelpText, Id, Label, LayoutDirection, MaxClientSize, MaxHeight, MaxSize, MaxWidth, MinClientSize, MinHeight, MinSize, MinWidth, Name, Parent, Position, Rect, ScreenPosition, ScreenRect, Shown, Size, Sizer, ThemeEnabled, ToolTip, ToolTipString, TopLevel, TopLevelParent, UpdateClientRect, UpdateRegion, Validator, VirtualSize, WindowStyle, WindowStyleFlag, WindowVariant

Inherited from wx._core.EvtHandler: EvtHandlerEnabled, NextHandler, PreviousHandler

Inherited from wx._core.Object: ClassName

Inherited from object: __class__

Method Details [hide private]

__init__(self, parent, height_desc=220)
(Constructor)

source code 

Set up the window.

Parameters:
  • parent (wx.object instance) - The parent GUI element.
  • height_desc (int or None) - The height in pixels of the description part of the wizard.
Returns: EvtHandler
Overrides: object.__init__

_add_title(self, sizer)

source code 

Add the title to the dialog.

Parameters:
  • sizer (wx.Sizer instance) - A sizer object.

_apply(self, event=None)

source code 

Apply the operation.

Parameters:
  • event (wx event) - The wx event.

_build_main_section(self, sizer)

source code 

Add the main part of the dialog.

Parameters:
  • sizer (wx.Sizer instance) - A sizer object.
Returns: wx.Sizer instance
The sizer object for the main part of the dialog.

add_artwork(self, sizer)

source code 

Add the artwork to the dialog.

Parameters:
  • sizer (wx.Sizer instance) - A sizer object.

add_contents(self, sizer)

source code 

Add the specific GUI elements (dummy method).

Parameters:
  • sizer (wx.Sizer instance) - A sizer object.

add_desc(self, sizer, max_y=220)

source code 

Add the description to the dialog.

Parameters:
  • sizer (wx.Sizer instance) - A sizer object.
  • max_y (int) - The maximum height, in number of pixels, for the description.

on_apply(self)

source code 

To be over-ridden if an action is to be performed on hitting the apply button.

This method will be called when clicking on the apply button.

on_back(self)

source code 

To be over-ridden if an action is to be performed just before moving back to the previous page.

This method is called when moving back to the previous page of the wizard.

on_completion(self)

source code 

To be over-ridden if an action is to be performed just after executing self.on_execute().

This method is called just after self.on_execute() has been called

on_display(self)

source code 

To be over-ridden if an action is to be performed prior to displaying the page.

This method will be called by the wizard class method _display_page() just after hiding all other pages but prior to displaying this page.

on_display_post(self)

source code 

To be over-ridden if an action is to be performed after the execution of the on_display() method.

This method will be called by the wizard class method _display_page() just after hiding all other pages but prior to displaying this page.

on_execute(self)

source code 

To be over-ridden if an action is to be performed just before exiting the page.

This method is called when terminating the wizard or hitting the apply button.

on_init(self)

source code 

To be over-ridden if an action is to be performed when a page is newly displayed.

This method will be called by the wizard class method _display_page() at the very end.

on_next(self)

source code 

To be over-ridden if an action is to be performed just before moving to the next page.

This method is called when moving to the next page of the wizard.