Navigation

phoenix_title wx.lib.agw.shortcuteditor.Shortcut

Shortcut is a class containing the details for a shortcut, whether from a menu item, an accelerator or a user-defined shortcut. It behaves like a tree, with children and parents.


class_hierarchy Class Hierarchy

Inheritance diagram for class Shortcut:

method_summary Methods Summary

__init__

Default class constructor.

AppendItem

Appends a Shortcut item as a last child of its parent.

CheckAccelerator

Checks if a shortcut string entered by the user has already been taken by another entry

FromMenuItem

Constructs this Shortcut starting from a wx.Menu or wx.MenuItem.

Get

Returns an instance of Shortcut whose label matches the input label string.

GetAccelerator

Returns the string accelerator associated with this shortcut.

GetBitmap

Returns the bitmap associated with this Shortcut.

GetById

Returns an instance of Shortcut whose ID matches the input id.

GetFirstChild

Returns this Shortcut’s first child and an integer value ‘cookie’.

GetId

Returns this Shortcut ID.

GetImageIndex

Returns an integer index to be used in the ListShortcut own wx.ImageList.

GetLabel

Returns the string label associated with this shortcut.

GetNextChild

Returns this Shortcut’s next child.

HasChanged

Returns True if the current accelerator associated with this Shortcut is

IsTop

Returns True if this Shortcut is associated with a top-level wx.Menu,

Match

Matches this Shortcut label string against the filter input variable.

ResetVisibility

Set the status of this Shortcut and its parent as hidden in the

RestoreDefaults

Restore the original shortcut string for this Shortcut.

SetAccelerator

Sets the string accelerator associated with this shortcut.

SetBitmap

Sets the bitmap associated with this Shortcut.

ShowHierarchy

Set the status of this Shortcut ans its parent as shown in the

ToAcceleratorItem

Dumps this Shortcut into a tuple of 3 elements

ToMenuItem

Dumps this Shortcut into a wx.Menu or wx.MenuItem.

api Class API

class Shortcut(object)

Shortcut is a class containing the details for a shortcut, whether from a menu item, an accelerator or a user-defined shortcut. It behaves like a tree, with children and parents.


Methods

__init__(self, label='', accelerator='', bitmap=wx.NullBitmap, help='', menuItem=None, accelId=None)

Default class constructor.

Parameters:

  • label (string) – the shortcut label string;

  • accelerator (string) – the shortcut accelerator string;

  • bitmap – an instance of wx.Bitmap, to display along the shortcut label in the interface tree;

  • help (string) – the help string for this shortcut, to display in the interface tree;

  • menuItem – if this Shortcut is derived from a wx.MenuItem, the wx.MenuItem to which it should be associated;

  • accelId (integer) – if this Shortcut is derived from an accelerator in a AcceleratorTable or from a custom, developer-defined shortcut, it represents the ID it is associated with.


AppendItem(self, item)

Appends a Shortcut item as a last child of its parent.

Parameters:

item – an instance of Shortcut.


CheckAccelerator(self, item, shortcut, accelerator)

Checks if a shortcut string entered by the user has already been taken by another entry in the Shortcut hierarchy.

Parameters:

  • item – an instance of Shortcut;

  • shortcut – another instance of Shortcut, to compare with the previous item;

  • accelerator (string) – the user-edited accelerator string to check.

Returns:

An instance of Shortcut if the shortcut string entered by the user conflicts with an existing one, None otherwise.


FromMenuItem(self)

Constructs this Shortcut starting from a wx.Menu or wx.MenuItem.

The attributes needed to properly construct a Shortcut are the label, the accelerator string, the help string (optional) and the bitmap associated with it (optional).


Get(self, label, item=None)

Returns an instance of Shortcut whose label matches the input label string.

Parameters:

  • label (string) – the string label to compare against this Shortcut label;

  • item – an instance of Shortcut, used only to make this function reentrant (i.e. allow more than one enumeration on one and the same object simultaneously).

Returns:

An instance of Shortcut or None if no match was found.


GetAccelerator(self)

Returns the string accelerator associated with this shortcut.


GetBitmap(self)

Returns the bitmap associated with this Shortcut.

Note

You should always check if the returned bitmap is a valid one or not:

bitmap = shortcut.GetBitmap()
if bitmap.IsOk():
    DoSomething()

as the default bitmap associated with a Shortcut is NullBitmap.


GetById(self, id, item=None)

Returns an instance of Shortcut whose ID matches the input id.

Parameters:

  • id (integer) – an integer ID to compare against this Shortcut id;

  • item – an instance of Shortcut, used only to make this function reentrant (i.e. allow more than one enumeration on one and the same object simultaneously).

Returns:

An instance of Shortcut or None if no match was found.


GetFirstChild(self, item)

Returns this Shortcut’s first child and an integer value ‘cookie’. Call GetNextChild for the next child using this very ‘cookie’ return value as an input.

Parameters:

item – an instance of Shortcut.

Returns:

A tuple with the first value being an instance of Shortcut or None if there are no further children, and as second value an integer parameter ‘cookie’.

Note

This method returns None if there are no further children.


GetId(self)

Returns this Shortcut ID.


GetImageIndex(self)

Returns an integer index to be used in the ListShortcut own wx.ImageList.


GetLabel(self)

Returns the string label associated with this shortcut.


GetNextChild(self, item, cookie)

Returns this Shortcut’s next child.

Parameters:

  • item – an instance of Shortcut;

  • cookie (integer) – a parameter which is opaque for the application but is necessary for the library to make this function reentrant (i.e. allow more than one enumeration on one and the same object simultaneously).

Returns:

A tuple with the first value being an instance of Shortcut or None if there are no further children, and as second value an integer parameter ‘cookie’.

Note

This method returns None if there are no further children.


HasChanged(self)

Returns True if the current accelerator associated with this Shortcut is different from the original one, False otherwise.


IsTop(self)

Returns True if this Shortcut is associated with a top-level wx.Menu, (i.e., in the top wx.MenuBar level), False otherwise.


Match(self, filter='', item=None)

Matches this Shortcut label string against the filter input variable.

Parameters:

  • filter (string) – a string to match;

  • item – an instance of Shortcut: its label string is compared with the filter string to look for a match.

Returns:

An instance of Shortcut if the filter string is contained in the item label, None otherwise.

Note

The string-matching is case-insensitive.


ResetVisibility(self, item=None)

Set the status of this Shortcut and its parent as hidden in the ListShortcut tree hierarchy.

Parameters:

item – an instance of Shortcut, used only to make this function reentrant (i.e. allow more than one enumeration on one and the same object simultaneously).


RestoreDefaults(self, item=None)

Restore the original shortcut string for this Shortcut.

Parameters:

item – an instance of Shortcut, used only to make this function reentrant (i.e. allow more than one enumeration on one and the same object simultaneously).


SetAccelerator(self, accelerator)

Sets the string accelerator associated with this shortcut.

Parameters:

accelerator (string) – a string representing the shortcut string (accelerator).


SetBitmap(self, bitmap)

Sets the bitmap associated with this Shortcut.

Parameters:

bitmap – an instance of wx.Bitmap (can be invalid, i.e., NullBitmap).


ShowHierarchy(self, item)

Set the status of this Shortcut ans its parent as shown in the ListShortcut tree hierarchy.

Parameters:

item – an instance of Shortcut.


ToAcceleratorItem(self, table)

Dumps this Shortcut into a tuple of 3 elements:

  • flags: a bitmask of wx.ACCEL_ALT, wx.ACCEL_SHIFT, wx.ACCEL_CTRL, wx.ACCEL_CMD or wx.ACCEL_NORMAL used to specify which modifier keys are held down;

  • keyCode: the keycode to be detected (i.e., ord(‘b’), wx.WXK_F10, etc…);

  • cmdID: the menu or control command ID to use for the accelerator event.

Parameters:

table – a list of tuples, with the above specifications.


ToMenuItem(self, menuBar)

Dumps this Shortcut into a wx.Menu or wx.MenuItem.

The attributes needed to properly dump a Shortcut into a wx.Menu or wx.MenuBar are the label and the accelerator string.

Parameters:

menuBar – an instance of wx.MenuBar.