526954c596
Use "wxWindows licence" and not "wxWidgets licence" (the latter doesn't exist) and consistently spell "licence" using British spelling. See #12165. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64940 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
135 lines
4.4 KiB
C++
135 lines
4.4 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/kbdstate.h
|
|
// Purpose: documentation of wxKeyboardState
|
|
// Author: wxWidgets team
|
|
// Created: 2008-09-19
|
|
// RCS-ID: $Id$
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
Provides methods for testing the state of the keyboard modifier keys.
|
|
|
|
This class is used as a base class of wxKeyEvent and wxMouseState and,
|
|
hence, indirectly, of wxMouseEvent, so its methods may be used to get
|
|
information about the modifier keys which were pressed when the event
|
|
occurred.
|
|
|
|
This class is implemented entirely inline in @<wx/kbdstate.h@> and thus has
|
|
no linking requirements.
|
|
|
|
@nolibrary
|
|
@category{events}
|
|
|
|
@see wxKeyEvent, wxMouseState
|
|
*/
|
|
class wxKeyboardState
|
|
{
|
|
public:
|
|
/**
|
|
Constructor initializes the modifier key settings.
|
|
|
|
By default, no modifiers are active.
|
|
*/
|
|
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 ::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
|
|
test that none of the other modifiers is pressed:
|
|
|
|
@code
|
|
if ( ControlDown() && !AltDown() && !ShiftDown() && !MetaDown() )
|
|
... handle Ctrl-XXX ...
|
|
@endcode
|
|
|
|
and forgetting to do it can result in serious program bugs (e.g. program
|
|
not working with European keyboard layout where @c AltGr key which is
|
|
seen by the program as combination of CTRL and ALT is used). On the
|
|
other hand, you can simply write:
|
|
|
|
@code
|
|
if ( GetModifiers() == wxMOD_CONTROL )
|
|
... handle Ctrl-XXX ...
|
|
@endcode
|
|
|
|
with this function.
|
|
*/
|
|
int GetModifiers() const;
|
|
|
|
/**
|
|
Returns true if any modifiers at all are pressed.
|
|
|
|
This is equivalent to @c GetModifiers() @c != @c wxMOD_NONE.
|
|
*/
|
|
bool HasModifiers() const;
|
|
|
|
/**
|
|
Returns true if the Control key is pressed.
|
|
|
|
This function doesn't distinguish between right and left control keys.
|
|
|
|
In portable code you usually want to use CmdDown() to automatically
|
|
test for the more frequently used Command key (and not the rarely used
|
|
Control one) under Mac.
|
|
|
|
Notice that GetModifiers() should usually be used instead of this one.
|
|
*/
|
|
bool ControlDown() const;
|
|
|
|
/**
|
|
Returns true if the Shift key is pressed.
|
|
|
|
This function doesn't distinguish between right and left shift keys.
|
|
|
|
Notice that GetModifiers() should usually be used instead of this one.
|
|
*/
|
|
bool ShiftDown() const;
|
|
|
|
/**
|
|
Returns true if the Meta/Windows/Apple key is pressed.
|
|
|
|
This function tests the state of the key traditionally called Meta
|
|
under Unix systems, Windows keys under MSW and Apple, or Command, key
|
|
under Mac.
|
|
|
|
Notice that GetModifiers() should usually be used instead of this one.
|
|
|
|
@see CmdDown()
|
|
*/
|
|
bool MetaDown() const;
|
|
|
|
/**
|
|
Returns true if the Alt key is pressed.
|
|
|
|
Notice that GetModifiers() should usually be used instead of this one.
|
|
*/
|
|
bool AltDown() const;
|
|
|
|
/**
|
|
Returns true if the key used for command accelerators is pressed.
|
|
|
|
@c Cmd is a pseudo key which is Control for PC and Unix platforms but
|
|
Apple (or Command) key under Macs: it makes often sense to use it
|
|
instead of ControlDown() because @c Command key is used for the same
|
|
thing under Mac as @c Control elsewhere (even though @c Control still
|
|
exists, it is usually not used for the same purpose under Mac).
|
|
|
|
Notice that GetModifiers() should usually be used instead of this one.
|
|
*/
|
|
bool CmdDown() const;
|
|
};
|
|
|