X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/76e1c2debfe9558f79ab7c6cd2be1afc8b9d42c1..2fa2b11bbffc8995892369cedb9b208ca9a54d5b:/docs/latex/wx/accel.tex diff --git a/docs/latex/wx/accel.tex b/docs/latex/wx/accel.tex index 5f142d4706..40ae0b24dd 100644 --- a/docs/latex/wx/accel.tex +++ b/docs/latex/wx/accel.tex @@ -28,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.} @@ -61,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.} @@ -93,17 +93,17 @@ 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} -} +}% \wxheading{Remarks} 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} @@ -141,6 +141,10 @@ Loads the accelerator table from a Windows resource (Windows only). 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} @@ -151,7 +155,7 @@ Destroys the wxAcceleratorTable object. \constfunc{bool}{Ok}{\void} -Returns TRUE if the accelerator table is valid. +Returns true if the accelerator table is valid. \membersection{wxAcceleratorTable::operator $=$} @@ -167,7 +171,7 @@ counter. It is a fast operation. \wxheading{Return value} -Returns 'this' object. +Returns reference to this object. \membersection{wxAcceleratorTable::operator $==$} @@ -178,11 +182,11 @@ equal (a fast test). \wxheading{Parameters} -\docparam{accel}{Accelerator table to compare with 'this'} +\docparam{accel}{Accelerator table to compare with} \wxheading{Return value} -Returns TRUE if the accelerator tables were effectively equal, FALSE otherwise. +Returns true if the accelerator tables were effectively equal, false otherwise. \membersection{wxAcceleratorTable::operator $!=$} @@ -193,10 +197,10 @@ unequal (a fast test). \wxheading{Parameters} -\docparam{accel}{Accelerator table to compare with 'this'} +\docparam{accel}{Accelerator table to compare with} \wxheading{Return value} -Returns TRUE if the accelerator tables were unequal, FALSE otherwise. +Returns true if the accelerator tables were unequal, false otherwise.