X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0e0977894a66f5b3227d2864becaeae86a5e93c8..b8737371e220ef1920e6a3d2aed88c4bc2b04daf:/interface/wx/kbdstate.h diff --git a/interface/wx/kbdstate.h b/interface/wx/kbdstate.h index 9a99a7c217..36cd368a08 100644 --- a/interface/wx/kbdstate.h +++ b/interface/wx/kbdstate.h @@ -4,7 +4,7 @@ // Author: wxWidgets team // Created: 2008-09-19 // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -15,10 +15,11 @@ information about the modifier keys which were pressed when the event occurred. - This class is implemented entirely inline in @ and thus has + This class is implemented entirely inline in @ and thus has no linking requirements. - @category{misc} + @nolibrary + @category{events} @see wxKeyEvent, wxMouseState */ @@ -26,21 +27,24 @@ class wxKeyboardState { public: /** - Default constructor. + Constructor initializes the modifier key settings. By default, no modifiers are active. */ - wxKeyboardState(); + wxKeyboardState(bool controlDown = false, + bool shiftDown = false, + bool altDown = false, + bool metaDown = false); /** Return the bit mask of all pressed modifier keys. - + The return value is a combination of @c wxMOD_ALT, @c wxMOD_CONTROL, @c wxMOD_SHIFT and @c wxMOD_META bit masks. Additionally, @c wxMOD_NONE is defined as 0, i.e. corresponds to no modifiers (see HasModifiers()) - and @c wxMOD_CMD is either @c wxMOD_CONTROL (MSW and Unix) or @c - wxMOD_META (Mac), see CmdDown(). See @ref page_keymodifiers for the - full list of modifiers. + and @c wxMOD_CMD is either @c wxMOD_CONTROL (MSW and Unix) or + @c wxMOD_META (Mac), see CmdDown(). + See ::wxKeyModifier for the full list of modifiers. Notice that this function is easier to use correctly than, for example, ControlDown() because when using the latter you also have to remember to