Module MultiDirDialog :: Class MultiDirDialog
[hide private]
[frames] | no frames]

Class MultiDirDialog

source code

     object --+                    
              |                    
wx._core.Object --+                
                  |                
wx._core.EvtHandler --+            
                      |            
        wx._core.Window --+        
                          |        
 wx._windows.TopLevelWindow --+    
                              |    
             wx._windows.Dialog --+
                                  |
                                 MultiDirDialog

A different implementation of wx.DirDialog which allows multiple folders to be selected at once.

Instance Methods [hide private]
EvtHandler
__init__(self, parent, message=u'Choose a directory', title=u'Browse For Folders', defaultPath='', style=536878144, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), name='multidirdialog')
Default class constructor.
source code
 
SetupDirCtrl(self, defaultPath)
Setup the wx.GenericDirCtrl (icons, labels, etc...).
source code
 
SetProperties(self, title)
Sets few properties for the dialog.
source code
 
LayoutItems(self)
Layout the widgets using sizers.
source code
 
GetPaths(self)
Returns the folders selected by the user.
source code
 
RecurseTopDir(self, treeCtrl, item, itemText)
Recurse a directory tree to include the parent-folder.
source code
 
BindEvents(self)
Binds the events to specific methods.
source code
 
CreateButtons(self)
Creates the Ok, cancel and new folder bitmap buttons.
source code
 
OnOk(self, event)
Handles the Ok wx.EVT_BUTTON event for the dialog.
source code
 
OnCancel(self, event)
Handles the Cancel wx.EVT_BUTTON event for the dialog.
source code
 
OnClose(self, event)
User canceled the dialog.
source code
 
OnKeyUp(self, event)
Handles the wx.EVT_CHAR_HOOK event for the dialog.
source code
 
OnSelChanged(self, event)
Handles the wx.EVT_TREE_SEL_CHANGED event for the tree control associated with MultiDirDialog.
source code

Inherited from wx._windows.Dialog: Create, CreateButtonSizer, CreateSeparatedButtonSizer, CreateStdDialogButtonSizer, CreateTextSizer, EndModal, GetAffirmativeId, GetEscapeId, GetReturnCode, IsModal, SetAffirmativeId, SetEscapeId, SetReturnCode, ShowModal

Inherited from wx._windows.Dialog (private): _CreateButtonSizer

Inherited from wx._windows.TopLevelWindow: CenterOnScreen, CentreOnScreen, EnableCloseButton, GetDefaultItem, GetIcon, GetTitle, GetTmpDefaultItem, Iconize, IsActive, IsAlwaysMaximized, IsFullScreen, IsIconized, IsMaximized, MacGetMetalAppearance, MacGetTopLevelWindowRef, MacGetUnifiedAppearance, MacSetMetalAppearance, Maximize, RequestUserAttention, Restore, SetDefaultItem, SetIcon, SetIcons, SetShape, SetTitle, SetTmpDefaultItem, ShowFullScreen, __repr__

Inherited from wx._core.Window: AcceptsFocus, AcceptsFocusFromKeyboard, AddChild, AdjustForLayoutDirection, AssociateHandle, CacheBestSize, 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, GetMaxHeight, GetMaxSize, GetMaxWidth, GetMinHeight, GetMinSize, GetMinWidth, GetName, GetParent, GetPosition, GetPositionTuple, GetRect, GetScreenPosition, GetScreenPositionTuple, GetScreenRect, GetScrollPos, GetScrollRange, GetScrollThumb, GetSize, GetSizeTuple, GetSizer, GetTextExtent, GetThemeEnabled, GetToolTip, GetTopLevelParent, GetUpdateClientRect, GetUpdateRegion, GetValidator, GetVirtualSize, GetVirtualSizeTuple, GetWindowBorderSize, GetWindowStyle, GetWindowStyleFlag, GetWindowVariant, HasCapture, HasFlag, HasMultiplePages, HasScrollbar, HasTransparentBackground, Hide, HitTest, HitTestXY, InheritAttributes, InheritsBackgroundColour, InitDialog, InvalidateBestSize, IsBeingDeleted, IsDoubleBuffered, IsEnabled, IsExposed, IsExposedPoint, IsExposedRect, IsFrozen, IsRetained, IsShown, IsShownOnScreen, IsTopLevel, Layout, LineDown, LineUp, Lower, MakeModal, Move, MoveAfterInTabOrder, MoveBeforeInTabOrder, MoveXY, Navigate, OnPaint, PageDown, PageUp, PopEventHandler, PopupMenu, PopupMenuXY, PostCreate, PrepareDC, PushEventHandler, Raise, Refresh, RefreshRect, RegisterHotKey, ReleaseMouse, RemoveChild, RemoveEventHandler, Reparent, ScreenToClient, ScreenToClientXY, ScrollLines, ScrollPages, ScrollWindow, SendSizeEvent, SetAcceleratorTable, SetAutoLayout, SetBackgroundColour, SetBackgroundStyle, SetBestFittingSize, SetCaret, SetClientRect, SetClientSize, SetClientSizeWH, SetConstraints, SetContainingSizer, SetCursor, SetDimensions, SetDoubleBuffered, SetDropTarget, SetEventHandler, SetExtraStyle, SetFocus, SetFocusFromKbd, SetFont, SetForegroundColour, SetHelpText, SetHelpTextForId, SetId, SetInitialSize, SetLabel, SetLayoutDirection, SetMaxSize, 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, Thaw, ToggleWindowStyle, TransferDataFromWindow, TransferDataToWindow, UnregisterHotKey, Update, UpdateWindowUI, UseBgCol, Validate, WarpPointer, WindowToClientSize

Inherited from wx._core.EvtHandler: AddPendingEvent, Bind, Connect, Disconnect, GetEvtHandlerEnabled, GetNextHandler, GetPreviousHandler, ProcessEvent, ProcessPendingEvents, SetEvtHandlerEnabled, SetNextHandler, SetPreviousHandler, Unbind

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

Inherited from wx._core.Object: GetClassName, IsSameAs

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

Static Methods [hide private]

Inherited from wx._windows.Dialog: GetClassDefaultAttributes

Inherited from wx._core.Window: FindFocus, GetCapture, NewControlId, NextControlId, PrevControlId

Class Variables [hide private]

Inherited from wx._windows.Dialog: ButtonSizerFlags

Properties [hide private]

Inherited from wx._windows.Dialog: AffirmativeId, EscapeId, ReturnCode, thisown

Inherited from wx._windows.TopLevelWindow: DefaultItem, Icon, Title, TmpDefaultItem

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, MaxHeight, MaxSize, MaxWidth, MinHeight, MinSize, MinWidth, Name, Parent, Position, Rect, ScreenPosition, ScreenRect, Shown, Size, Sizer, ThemeEnabled, ToolTip, 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, message=u'Choose a directory', title=u'Browse For Folders', defaultPath='', style=536878144, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), name='multidirdialog')
(Constructor)

source code 

Default class constructor.

Parameters:
  • parent - the dialog parent widget;
  • message - the message to show on the dialog;
  • title - the dialog title;
  • defaultPath - the default path, or the empty string;
  • style - the custom dir dialog style;
  • pos - the dialog position;
  • size - the dialog size;
  • name - the dialog name.
Returns: EvtHandler
Overrides: object.__init__

RecurseTopDir(self, treeCtrl, item, itemText)

source code 

Recurse a directory tree to include the parent-folder.

Parameters:
  • treeCtrl - the tree control associated with wx.GenericDirCtrl;
  • item - the selected tree control item;
  • itemText - the selected tree control item text.