Navigation

phoenix_title wx.lib.agw.multidirdialog.MultiDirDialog

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


class_hierarchy Class Hierarchy

Inheritance diagram for class MultiDirDialog:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


super_classes Known Superclasses

wx.Dialog


method_summary Methods Summary

__init__

Default class constructor.

BindEvents

Binds the events to specific methods.

CreateButtons

Creates the OK, Cancel and Make New Folder bitmap buttons.

GetPaths

Returns the folders selected by the user, or the default path.

LayoutItems

Layout the widgets using sizers.

OnCancel

Handles the wx.EVT_BUTTON event for the dialog.

OnClose

Handles the wx.EVT_CLOSE event for the dialog.

OnKeyUp

Handles the wx.EVT_CHAR_HOOK event for the dialog.

OnOk

Handles the wx.EVT_BUTTON event for the dialog.

OnSelChanged

Handles the wx.EVT_TREE_SEL_CHANGED event for the tree control associated

SetProperties

Sets few properties for the dialog.

SetupDirCtrl

Setup the internal GenericDirCtrl (icons, labels, etc…).

api Class API

class MultiDirDialog(wx.Dialog)

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


Methods

__init__(self, parent, message=_("Choose one or more folders:"), title=_("Browse For Folders"), defaultPath="", style=wx.DD_DEFAULT_STYLE, agwStyle=DD_MULTIPLE, pos=wx.DefaultPosition, size=wx.DefaultSize, name="multidirdialog")

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 underlying Dialog window style;

  • agwStyle –

    the AGW-specific dialog style; this can be a combination of the following bits:

    Window Styles

    Hex Value

    Description

    DD_NEW_DIR_BUTTON

    0x080

    Enable/disable the “Make new folder” button

    DD_DIR_MUST_EXIST

    0x200

    The dialog will allow the user to choose only an existing folder. When this style is not given, a “Create new directory” button is added to the dialog (on Windows) or some other way is provided to the user to type the name of a new folder.

    DD_MULTIPLE

    0x400

    Allows the selection of multiple folders.

  • pos – the dialog position;

  • size – the dialog size;

  • name – the dialog name.


BindEvents(self)

Binds the events to specific methods.


CreateButtons(self)

Creates the OK, Cancel and Make New Folder bitmap buttons.


GetPaths(self)

Returns the folders selected by the user, or the default path.


LayoutItems(self, message)

Layout the widgets using sizers.


OnCancel(self, event)

Handles the wx.EVT_BUTTON event for the dialog.

Parameters

event – a CommandEvent event to be processed.

Note

This method handles the Cancel button press.


OnClose(self, event)

Handles the wx.EVT_CLOSE event for the dialog.

Parameters

event – a CloseEvent event to be processed.


OnKeyUp(self, event)

Handles the wx.EVT_CHAR_HOOK event for the dialog.

Parameters

event – a KeyEvent event to be processed.


OnOk(self, event)

Handles the wx.EVT_BUTTON event for the dialog.

Parameters

event – a CommandEvent event to be processed.

Note

This method handles the OK button press.


OnSelChanged(self, event)

Handles the wx.EVT_TREE_SEL_CHANGED event for the tree control associated with MultiDirDialog.

Parameters

event – a TreeEvent event to be processed.


SetProperties(self, title)

Sets few properties for the dialog.

Parameters

title – the dialog title.


SetupDirCtrl(self, defaultPath)

Setup the internal GenericDirCtrl (icons, labels, etc…).

Parameters

defaultPath – the default path for MultiDirDialog, can be an empty string.