mirror of
https://bitbucket.org/smil3y/kde-workspace.git
synced 2025-02-23 18:32:50 +00:00
118 lines
3.4 KiB
C++
118 lines
3.4 KiB
C++
#ifndef GLOBALSHORTCUT_H
|
|
#define GLOBALSHORTCUT_H
|
|
/* Copyright (C) 2008 Michael Jansen <kde@michael-jansen.biz>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#include "kglobalshortcutinfo_p.h"
|
|
|
|
#include <QtCore/QObject>
|
|
|
|
|
|
class GlobalShortcutContext;
|
|
|
|
/**
|
|
* Represents a global shortcut.
|
|
*
|
|
* @internal
|
|
*
|
|
* \note This class can handle multiple keys (default and active). This
|
|
* feature isn't used currently. kde4 only allows setting one key per global
|
|
* shortcut.
|
|
*
|
|
* @author Michael Jansen <kde@michael-jansen.biz>
|
|
*/
|
|
class GlobalShortcut
|
|
{
|
|
public:
|
|
GlobalShortcut(const QString &uniqueName, const QString &friendlyName, GlobalShortcutContext *context);
|
|
GlobalShortcut();
|
|
|
|
~GlobalShortcut();
|
|
|
|
//! Returns the context the shortcuts belongs to
|
|
GlobalShortcutContext *context();
|
|
GlobalShortcutContext const *context() const;
|
|
|
|
//! Returns the default keys for this shortcut.
|
|
QList<int> defaultKeys() const;
|
|
|
|
//! Return the friendly display name for this shortcut.
|
|
QString friendlyName() const;
|
|
|
|
//! Check if the shortcut is active. It's keys are grabbed
|
|
bool isActive() const;
|
|
|
|
//! Check if the shortcut is fresh/new. Is an internal state
|
|
bool isFresh() const;
|
|
|
|
//! Check if the shortcut is present. It application is running.
|
|
bool isPresent() const;
|
|
|
|
//! Returns true if the shortcut is a session shortcut
|
|
bool isSessionShortcut() const;
|
|
|
|
//! Returns a list of keys associated with this shortcut.
|
|
QList<int> keys() const;
|
|
|
|
//! Activates the shortcut. The keys are grabbed.
|
|
void setActive();
|
|
|
|
//! Sets the default keys for this shortcut.
|
|
void setDefaultKeys(const QList<int>);
|
|
|
|
//! Sets the friendly name for the shortcut. For display.
|
|
void setFriendlyName(const QString &);
|
|
|
|
//! Sets the shortcut inactive. No longer grabs the keys.
|
|
void setInactive();
|
|
|
|
void setIsPresent(bool);
|
|
void setIsFresh(bool);
|
|
|
|
//! Sets the keys activated with this shortcut. The old keys are freed.
|
|
void setKeys(const QList<int>);
|
|
|
|
//! Returns the unique name aka id for the shortcuts.
|
|
QString uniqueName() const;
|
|
|
|
operator KGlobalShortcutInfo () const;
|
|
|
|
//! Remove this shortcut and it's siblings
|
|
void unRegister();
|
|
|
|
private:
|
|
//! means the associated application is present.
|
|
bool _isPresent;
|
|
|
|
//! means the shortcut is registered with GlobalShortcutsRegistry
|
|
bool _isRegistered;
|
|
|
|
//! means the shortcut is new
|
|
bool _isFresh;
|
|
|
|
//! The context the shortcut belongs too
|
|
GlobalShortcutContext *_context;
|
|
|
|
QString _uniqueName;
|
|
QString _friendlyName; //usually localized
|
|
|
|
QList<int> _keys;
|
|
QList<int> _defaultKeys;
|
|
};
|
|
|
|
#endif /* #ifndef GLOBALSHORTCUT_H */
|