wxPython/src/_accel.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _accel.i
   3 // Purpose:     SWIG interface for wxAcceleratorTable
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     03-July-1997
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17
  18 %typemap(in) (int n, const wxAcceleratorEntry* entries) {
  19     $2 = wxAcceleratorEntry_LIST_helper($input);
  20     if ($2) $1 = PyList_Size($input);
  21     else    $1 = 0;
  22 }
  23
  24 %typemap(freearg) wxAcceleratorEntry* entries {
  25      delete [] $1;
  26 }
  27
  28
  29
  30 //---------------------------------------------------------------------------
  31 %newgroup;
  32
  33 enum {
  34     wxACCEL_ALT,
  35     wxACCEL_CTRL,
  36     wxACCEL_SHIFT,
  37     wxACCEL_NORMAL,
  38     wxACCEL_CMD,
  39 };
  40
  41 DocStr(wxAcceleratorEntry,
  42 "A class used to define items in an `wx.AcceleratorTable`.  wxPython
  43 programs can choose to use wx.AcceleratorEntry objects, but using a
  44 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
  45 as well.  See `__init__` for details of the tuple values.
  46
  47 :see: `wx.AcceleratorTable`", "");
  48
  49 class wxAcceleratorEntry {
  50 public:
  51     DocCtorStr(
  52         wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmdID = 0/*, wxMenuItem *menuitem = NULL*/),
  53         "Construct a wx.AcceleratorEntry.",
  54         "
  55     :param flags: A bitmask of wx.ACCEL_ALT, wx.ACCEL_SHIFT,
  56                 wx.ACCEL_CTRL, wx.ACCEL_CMD,  or wx.ACCEL_NORMAL
  57                 used to specify which modifier keys are held down.
  58     :param keyCode: The keycode to be detected
  59     :param cmdID: The menu or control command ID to use for the
  60                 accellerator event.
  61 ");
  62     ~wxAcceleratorEntry();
  63
  64     DocDeclStr(
  65         void , Set(int flags, int keyCode, int cmd/*, wxMenuItem *menuItem = NULL*/),
  66         "(Re)set the attributes of a wx.AcceleratorEntry.
  67 :see `__init__`", "");
  68
  69
  70 //     void SetMenuItem(wxMenuItem *item);
  71 //     wxMenuItem *GetMenuItem() const;
  72
  73     DocDeclStr(
  74         int , GetFlags(),
  75         "Get the AcceleratorEntry's flags.", "");
  76
  77     DocDeclStr(
  78         int , GetKeyCode(),
  79         "Get the AcceleratorEntry's keycode.", "");
  80
  81     DocDeclStr(
  82         int , GetCommand(),
  83         "Get the AcceleratorEntry's command ID.", "");
  84 };
  85
  86
  87
  88
  89
  90 DocStr(wxAcceleratorTable,
  91 "An accelerator table allows the application to specify a table of
  92 keyboard shortcuts for menus or other commands. On Windows, menu or
  93 button commands are supported; on GTK, only menu commands are
  94 supported.", "
  95
  96 The object ``wx.NullAcceleratorTable`` is defined to be a table with
  97 no data, and is the initial accelerator table for a window.
  98
  99 An accelerator takes precedence over normal processing and can be a
 100 convenient way to program some event handling. For example, you can
 101 use an accelerator table to make a hotkey generate an event no matter
 102 which window within a frame has the focus.
 103
 104 For example::
 105
 106     aTable = wx.AcceleratorTable([(wx.ACCEL_ALT,  ord('X'), exitID),
 107                                   (wx.ACCEL_CTRL, ord('H'), helpID),
 108                                   (wx.ACCEL_CTRL, ord('F'), findID),
 109                                   (wx.ACCEL_NORMAL, wx.WXK_F3, findnextID)
 110                                   ])
 111     self.SetAcceleratorTable(aTable)
 112
 113
 114 :see: `wx.AcceleratorEntry`, `wx.Window.SetAcceleratorTable`
 115 ");
 116
 117 class wxAcceleratorTable : public wxObject {
 118 public:
 119     DocAStr(wxAcceleratorTable,
 120             "__init__(entries) -> AcceleratorTable",
 121             "Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
 122 items or or of 3-tuples (flags, keyCode, cmdID)
 123
 124 :see: `wx.AcceleratorEntry`", "");
 125     wxAcceleratorTable(int n, const wxAcceleratorEntry* entries);
 126     ~wxAcceleratorTable();
 127
 128     bool Ok() const;
 129 };
 130
 131
 132
 133 %immutable;
 134 const wxAcceleratorTable wxNullAcceleratorTable;
 135 %mutable;
 136
 137
 138 wxAcceleratorEntry *wxGetAccelFromString(const wxString& label);
 139
 140 //---------------------------------------------------------------------------