X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3972fb4919148d1ed67f897ea5beb67eedd662f6..94e2ed3b8db0220160c0b939782cd46914ec073a:/docs/latex/wx/accel.tex diff --git a/docs/latex/wx/accel.tex b/docs/latex/wx/accel.tex index 14aacf7843..fab1e2b05f 100644 --- a/docs/latex/wx/accel.tex +++ b/docs/latex/wx/accel.tex @@ -6,6 +6,10 @@ An object used by an application wishing to create an \helpref{accelerator table None +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxAcceleratorTable}{wxacceleratortable}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable} @@ -24,7 +28,7 @@ Constructor. \wxheading{Parameters} -\docparam{flags}{One of wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates +\docparam{flags}{One of wxACCEL\_ALT, wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates which modifier key is held down.} \docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.} @@ -57,7 +61,7 @@ Sets the accelerator entry parameters. \wxheading{Parameters} -\docparam{flags}{One of wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates +\docparam{flags}{One of wxACCEL\_ALT, wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates which modifier key is held down.} \docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.} @@ -77,6 +81,10 @@ initial accelerator table for a window. \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Example} {\small% @@ -85,7 +93,7 @@ initial accelerator table for a window. entries[0].Set(wxACCEL_CTRL, (int) 'N', ID_NEW_WINDOW); entries[1].Set(wxACCEL_CTRL, (int) 'X', wxID_EXIT); entries[2].Set(wxACCEL_SHIFT, (int) 'A', ID_ABOUT); - entries[3].Set(wxACCEL_NONE, WXK_DELETE, wxID_CUT); + entries[3].Set(wxACCEL_NORMAL, WXK_DELETE, wxID_CUT); wxAcceleratorTable accel(4, entries); frame->SetAcceleratorTable(accel); \end{verbatim} @@ -95,7 +103,7 @@ initial accelerator table for a window. An accelerator takes precedence over normal processing and can be a convenient way to program some event handling. For example, you can use an accelerator table to enable a dialog with a multi-line text control to -accept CTRL-Enter as meaning 'OK' (but not in GTK at present). +accept CTRL-Enter as meaning `OK' (but not in GTK at present). \wxheading{See also} @@ -129,6 +137,14 @@ Loads the accelerator table from a Windows resource (Windows only). \docparam{resource}{Name of a Windows accelerator.} +\pythonnote{The wxPython constructor accepts a list of +wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode, +and cmd values like you would construct wxAcceleratorEntry objects with.} + +\perlnote{The wxPerl constructor accepts a list of either + Wx::AcceleratorEntry objects or references to 3-element arrays + ( flags, keyCode, cmd ), like the parameters of Wx::AcceleratorEntry::new.} + \membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}} \func{}{\destruct{wxAcceleratorTable}}{\void} @@ -155,7 +171,7 @@ counter. It is a fast operation. \wxheading{Return value} -Returns 'this' object. +Returns reference to this object. \membersection{wxAcceleratorTable::operator $==$} @@ -166,7 +182,7 @@ equal (a fast test). \wxheading{Parameters} -\docparam{accel}{Accelerator table to compare with 'this'} +\docparam{accel}{Accelerator table to compare with} \wxheading{Return value} @@ -181,7 +197,7 @@ unequal (a fast test). \wxheading{Parameters} -\docparam{accel}{Accelerator table to compare with 'this'} +\docparam{accel}{Accelerator table to compare with} \wxheading{Return value}