4f4c5fcfdf
This is a combination of running clang-tidy with modernize-use-nullptr check for some ports (GTK, X11, OSX) and manual changes to the ports for which it couldn't be used easily (MSW, DFB) and also manually updating the docs. Also replace NULL with null or nullptr in the comments as this is more consistent with the use of nullptr in the code and makes it simpler to grep for the remaining occurrences of NULL itself. And also use null in the assert messages. Only a few occurrences of "NULL" are still left in non-C files, mostly corresponding to unclear comments or string output which it might not be safe to change.
153 lines
4.8 KiB
C++
153 lines
4.8 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/accel.h
|
|
// Purpose: wxAcceleratorEntry and wxAcceleratorTable classes
|
|
// Author: Julian Smart, Robert Roebling, Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 31.05.01 (extracted from other files)
|
|
// Copyright: (c) wxWidgets team
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_ACCEL_H_BASE_
|
|
#define _WX_ACCEL_H_BASE_
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_ACCEL
|
|
|
|
#include "wx/object.h"
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxAcceleratorTable;
|
|
class WXDLLIMPEXP_FWD_CORE wxMenuItem;
|
|
class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// constants
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxAcceleratorEntry flags
|
|
enum wxAcceleratorEntryFlags
|
|
{
|
|
wxACCEL_NORMAL = 0x0000, // no modifiers
|
|
wxACCEL_ALT = 0x0001, // hold Alt key down
|
|
wxACCEL_CTRL = 0x0002, // hold Ctrl key down
|
|
wxACCEL_SHIFT = 0x0004, // hold Shift key down
|
|
#if defined(__WXMAC__)
|
|
wxACCEL_RAW_CTRL= 0x0008, //
|
|
#else
|
|
wxACCEL_RAW_CTRL= wxACCEL_CTRL,
|
|
#endif
|
|
wxACCEL_CMD = wxACCEL_CTRL
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// an entry in wxAcceleratorTable corresponds to one accelerator
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxAcceleratorEntry
|
|
{
|
|
public:
|
|
wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmd = 0,
|
|
wxMenuItem *item = nullptr)
|
|
: m_flags(flags)
|
|
, m_keyCode(keyCode)
|
|
, m_command(cmd)
|
|
, m_item(item)
|
|
{ }
|
|
|
|
// create accelerator corresponding to the specified string, return nullptr if
|
|
// string couldn't be parsed or a pointer to be deleted by the caller
|
|
static wxAcceleratorEntry *Create(const wxString& str);
|
|
|
|
void Set(int flags, int keyCode, int cmd, wxMenuItem *item = nullptr)
|
|
{
|
|
m_flags = flags;
|
|
m_keyCode = keyCode;
|
|
m_command = cmd;
|
|
m_item = item;
|
|
}
|
|
|
|
void SetMenuItem(wxMenuItem *item) { m_item = item; }
|
|
|
|
int GetFlags() const { return m_flags; }
|
|
int GetKeyCode() const { return m_keyCode; }
|
|
int GetCommand() const { return m_command; }
|
|
|
|
wxMenuItem *GetMenuItem() const { return m_item; }
|
|
|
|
bool operator==(const wxAcceleratorEntry& entry) const
|
|
{
|
|
return m_flags == entry.m_flags &&
|
|
m_keyCode == entry.m_keyCode &&
|
|
m_command == entry.m_command &&
|
|
m_item == entry.m_item;
|
|
}
|
|
|
|
bool operator!=(const wxAcceleratorEntry& entry) const
|
|
{ return !(*this == entry); }
|
|
|
|
bool IsOk() const
|
|
{
|
|
return m_keyCode != 0;
|
|
}
|
|
|
|
|
|
// string <-> wxAcceleratorEntry conversion
|
|
// ----------------------------------------
|
|
|
|
// returns a wxString for this accelerator.
|
|
// this function formats it using the <flags>-<keycode> format
|
|
// where <flags> maybe a hyphen-separated list of "shift|alt|ctrl"
|
|
wxString ToString() const { return AsPossiblyLocalizedString(true); }
|
|
|
|
// same as above but without translating, useful if the string is meant to
|
|
// be stored in a file or otherwise stored, instead of being shown to the
|
|
// user
|
|
wxString ToRawString() const { return AsPossiblyLocalizedString(false); }
|
|
|
|
// returns true if the given string correctly initialized this object
|
|
// (i.e. if IsOk() returns true after this call)
|
|
bool FromString(const wxString& str);
|
|
|
|
|
|
private:
|
|
wxString AsPossiblyLocalizedString(bool localized) const;
|
|
|
|
// common part of Create() and FromString()
|
|
static bool ParseAccel(const wxString& str, int *flags, int *keycode);
|
|
|
|
|
|
int m_flags; // combination of wxACCEL_XXX constants
|
|
int m_keyCode; // ASCII or virtual keycode
|
|
int m_command; // Command id to generate
|
|
|
|
// the menu item this entry corresponds to, may be null
|
|
wxMenuItem *m_item;
|
|
|
|
// for compatibility with old code, use accessors now!
|
|
friend class WXDLLIMPEXP_FWD_CORE wxMenu;
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// include wxAcceleratorTable class declaration, it is only used by the library
|
|
// and so doesn't have any published user visible interface
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#if defined(__WXUNIVERSAL__)
|
|
#include "wx/generic/accel.h"
|
|
#elif defined(__WXMSW__)
|
|
#include "wx/msw/accel.h"
|
|
#elif defined(__WXGTK__)
|
|
#include "wx/gtk/accel.h"
|
|
#elif defined(__WXMAC__)
|
|
#include "wx/osx/accel.h"
|
|
#elif defined(__WXQT__)
|
|
#include "wx/qt/accel.h"
|
|
#endif
|
|
|
|
extern WXDLLIMPEXP_DATA_CORE(wxAcceleratorTable) wxNullAcceleratorTable;
|
|
|
|
#endif // wxUSE_ACCEL
|
|
|
|
#endif
|
|
// _WX_ACCEL_H_BASE_
|