docs/latex/wx/accel.tex

   1 \section{\class{wxAcceleratorEntry}}\label{wxacceleratorentry}
   2
   3 An object used by an application wishing to create an \helpref{accelerator table}{wxacceleratortable}.
   4
   5 \wxheading{Derived from}
   6
   7 None
   8
   9 \wxheading{Include files}
  10
  11 <wx/accel.h>
  12
  13 \wxheading{See also}
  14
  15 \helpref{wxAcceleratorTable}{wxacceleratortable}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable}
  16
  17 \latexignore{\rtfignore{\wxheading{Members}}}
  18
  19 \membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryctor}
  20
  21 \func{}{wxAcceleratorEntry}{\void}
  22
  23 Default constructor.
  24
  25 \func{}{wxAcceleratorEntry}{\param{int}{ flags}, \param{int}{ keyCode}, \param{int}{ cmd}}
  26
  27 Constructor.
  28
  29 \wxheading{Parameters}
  30
  31 \docparam{flags}{One of wxACCEL\_ALT, wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates
  32 which modifier key is held down.}
  33
  34 \docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.}
  35
  36 \docparam{cmd}{The menu or control command identifier.}
  37
  38 \membersection{wxAcceleratorEntry::GetCommand}\label{wxacceleratorentrygetcommand}
  39
  40 \constfunc{int}{GetCommand}{\void}
  41
  42 Returns the command identifier for the accelerator table entry.
  43
  44 \membersection{wxAcceleratorEntry::GetFlags}\label{wxacceleratorentrygetflags}
  45
  46 \constfunc{int}{GetFlags}{\void}
  47
  48 Returns the flags for the accelerator table entry.
  49
  50 \membersection{wxAcceleratorEntry::GetKeyCode}\label{wxacceleratorentrygetkeycode}
  51
  52 \constfunc{int}{GetKeyCode}{\void}
  53
  54 Returns the keycode for the accelerator table entry.
  55
  56 \membersection{wxAcceleratorEntry::Set}\label{wxacceleratorentryset}
  57
  58 \func{void}{Set}{\param{int}{ flags}, \param{int}{ keyCode}, \param{int}{ cmd}}
  59
  60 Sets the accelerator entry parameters.
  61
  62 \wxheading{Parameters}
  63
  64 \docparam{flags}{One of wxACCEL\_ALT, wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates
  65 which modifier key is held down.}
  66
  67 \docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.}
  68
  69 \docparam{cmd}{The menu or control command identifier.}
  70
  71 \section{\class{wxAcceleratorTable}}\label{wxacceleratortable}
  72
  73 An accelerator table allows the application to specify a table of keyboard shortcuts for
  74 menus or other commands. On Windows, menu or button commands are supported; on GTK,
  75 only menu commands are supported.
  76
  77 The object {\bf wxNullAcceleratorTable} is defined to be a table with no data, and is the
  78 initial accelerator table for a window.
  79
  80 \wxheading{Derived from}
  81
  82 \helpref{wxObject}{wxobject}
  83
  84 \wxheading{Include files}
  85
  86 <wx/accel.h>
  87
  88 \wxheading{Predefined objects}
  89
  90 Objects:
  91
  92 {\bf wxNullAcceleratorTable}
  93
  94 \wxheading{Example}
  95
  96 {\small%
  97 \begin{verbatim}
  98   wxAcceleratorEntry entries[4];
  99   entries[0].Set(wxACCEL_CTRL,  (int) 'N',     ID_NEW_WINDOW);
 100   entries[1].Set(wxACCEL_CTRL,  (int) 'X',     wxID_EXIT);
 101   entries[2].Set(wxACCEL_SHIFT, (int) 'A',     ID_ABOUT);
 102   entries[3].Set(wxACCEL_NORMAL,  WXK_DELETE,    wxID_CUT);
 103   wxAcceleratorTable accel(4, entries);
 104   frame->SetAcceleratorTable(accel);
 105 \end{verbatim}
 106 }%
 107
 108 \wxheading{Remarks}
 109
 110 An accelerator takes precedence over normal processing and can be a convenient way to program some event handling.
 111 For example, you can use an accelerator table to enable a dialog with a multi-line text control to
 112 accept CTRL-Enter as meaning `OK' (but not in GTK+ at present).
 113
 114 \wxheading{See also}
 115
 116 \helpref{wxAcceleratorEntry}{wxacceleratorentry}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable}
 117
 118 \latexignore{\rtfignore{\wxheading{Members}}}
 119
 120 \membersection{wxAcceleratorTable::wxAcceleratorTable}\label{wxacceleratortablector}
 121
 122 \func{}{wxAcceleratorTable}{\void}
 123
 124 Default constructor.
 125
 126 \func{}{wxAcceleratorTable}{\param{const wxAcceleratorTable\& }{bitmap}}
 127
 128 Copy constructor, uses \helpref{reference counting}{trefcount}.
 129
 130 \func{}{wxAcceleratorTable}{\param{int}{ n}, \param{wxAcceleratorEntry}{ entries[]}}
 131
 132 Creates from an array of \helpref{wxAcceleratorEntry}{wxacceleratorentry} objects.
 133
 134 \func{}{wxAcceleratorTable}{\param{const wxString\&}{ resource}}
 135
 136 Loads the accelerator table from a Windows resource (Windows only).
 137
 138 \wxheading{Parameters}
 139
 140 \docparam{n}{Number of accelerator entries.}
 141
 142 \docparam{entries}{The array of entries.}
 143
 144 \docparam{resource}{Name of a Windows accelerator.}
 145
 146 \pythonnote{The wxPython constructor accepts a list of
 147 wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode,
 148 and cmd values like you would construct wxAcceleratorEntry objects with.}
 149
 150 \perlnote{The wxPerl constructor accepts a list of either
 151   Wx::AcceleratorEntry objects or references to 3-element arrays
 152   ( flags, keyCode, cmd ), like the parameters of Wx::AcceleratorEntry::new.}
 153
 154 \membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}}\label{wxacceleratortabledtor}
 155
 156 \func{}{\destruct{wxAcceleratorTable}}{\void}
 157
 158 Destroys the wxAcceleratorTable object.
 159 See \helpref{reference-counted object destruction}{refcountdestruct} for more info.
 160
 161 \membersection{wxAcceleratorTable::IsOk}\label{wxacceleratortableisok}
 162
 163 \constfunc{bool}{IsOk}{\void}
 164
 165 Returns true if the accelerator table is valid.
 166
 167 \membersection{wxAcceleratorTable::operator $=$}\label{wxacceleratortableassign}
 168
 169 \func{wxAcceleratorTable\& }{operator $=$}{\param{const wxAcceleratorTable\& }{accel}}
 170
 171 Assignment operator, using \helpref{reference counting}{trefcount}.
 172
 173 \wxheading{Parameters}
 174
 175 \docparam{accel}{Accelerator table to assign.}
 176
 177 \wxheading{Return value}
 178
 179 Returns reference to this object.