• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
KKeySequence Class Reference

#include <kshortcut.h>

Public Types

enum  { MAX_KEYS = 4 }
 

Public Member Functions

 KKeySequence ()
 
 KKeySequence (const TQKeySequence &keySeq)
 
 KKeySequence (const KKey &key)
 
 KKeySequence (const KKeyNative &key)
 
 KKeySequence (const KKeySequence &keySeq)
 
 KKeySequence (const TQString &keySeq)
 
void clear ()
 
bool init (const TQKeySequence &keySeq)
 
bool init (const KKey &key)
 
bool init (const KKeyNative &key)
 
bool init (const KKeySequence &keySeq)
 
bool init (const TQString &key)
 
KKeySequence & operator= (const KKeySequence &seq)
 
uint count () const
 
const KKey & key (uint i) const
 
bool isTriggerOnRelease () const
 
bool setKey (uint i, const KKey &key)
 
bool isNull () const
 
bool startsWith (const KKeySequence &keySeq) const
 
int compare (const KKeySequence &keySeq) const
 
bool operator== (const KKeySequence &seq) const
 
bool operator!= (const KKeySequence &seq) const
 
bool operator< (const KKeySequence &seq) const
 
TQKeySequence qt () const
 
int keyCodeQt () const
 
TQString toString () const
 
TQString toStringInternal () const
 

Static Public Member Functions

static KKeySequence & null ()
 

Protected Attributes

uchar m_nKeys
 
uchar m_bTriggerOnRelease
 
KKey m_rgvar [MAX_KEYS]
 

Friends

class KKeyNative
 

Detailed Description

A KKeySequence object holds a sequence of up to 4 keys.

Ex: Ctrl+X,I

See Also
KKey
KShortcut

Definition at line 288 of file kshortcut.h.

Member Enumeration Documentation

anonymous enum

Defines the maximum length of the key sequence.

Definition at line 292 of file kshortcut.h.

Constructor & Destructor Documentation

KKeySequence::KKeySequence ( )

Create a new null key sequence.

See Also
isNull()
null()
clear()

Definition at line 211 of file kshortcut.cpp.

KKeySequence::KKeySequence ( const TQKeySequence &  keySeq)

Copies the given qt key sequence.

Parameters
keySeqthe qt key sequence to copy

Definition at line 212 of file kshortcut.cpp.

KKeySequence::KKeySequence ( const KKey &  key)

Create a new key sequence that only contains the given key.

Parameters
keythe key to add

Definition at line 213 of file kshortcut.cpp.

KKeySequence::KKeySequence ( const KKeyNative &  key)

Create a new key sequence that only contains the given key.

Parameters
keythe key to add
KKeySequence::KKeySequence ( const KKeySequence &  keySeq)

Copies the given key sequence.

Parameters
keySeqthe key sequence to copy

Definition at line 214 of file kshortcut.cpp.

KKeySequence::KKeySequence ( const TQString &  keySeq)

Creates a new key sequence that contains the given key sequence.

The description consists of comma-separated keys as required by KKey::KKey(const TQString&).

Parameters
keySeqthe description of the key
See Also
KKeyServer::Sym::init()
KKey::KKey(const TQString&)

Definition at line 215 of file kshortcut.cpp.

Member Function Documentation

void KKeySequence::clear ( )

Clears the key sequence.

The key sequence is null after calling this function.

See Also
isNull()

Definition at line 221 of file kshortcut.cpp.

int KKeySequence::compare ( const KKeySequence &  keySeq) const

Compares this object with the given key sequence.

Returns a negative number if the given KKeySequence is larger, 0 if they are equal and a positive number this KKeySequence is larger. Key sequences are compared by comparing the individual keys, starting from the beginning until an unequal key has been found. If a sequence contains more keys, it is considered larger.

Parameters
keySeqthe key sequence to compare to
Returns
a negative number if the given KKeySequence is larger, 0 if they are equal and a positive number this KKeySequence is larger
See Also
KKey::sequence

Definition at line 334 of file kshortcut.cpp.

uint KKeySequence::count ( ) const

Returns the number of key strokes of this sequence.

Returns
the number of key strokes
See Also
MAX_KEYS

Definition at line 289 of file kshortcut.cpp.

bool KKeySequence::init ( const TQKeySequence &  keySeq)

Copies the given qt key sequence over this key sequence.

Parameters
keySeqthe qt key sequence to copy
Returns
true if successful, false otherwise

Definition at line 227 of file kshortcut.cpp.

bool KKeySequence::init ( const KKey &  key)

Initializes the key sequence to only contain the given key.

Parameters
keythe key to set
Returns
true if successful, false otherwise

Definition at line 242 of file kshortcut.cpp.

bool KKeySequence::init ( const KKeyNative &  key)

Initializes the key sequence to only contain the given key.

Parameters
keythe key to set
Returns
true if successful, false otherwise
bool KKeySequence::init ( const KKeySequence &  keySeq)

Copies the given key sequence over this key sequence.

Parameters
keySeqthe key sequence to copy
Returns
true if successful, false otherwise

Definition at line 253 of file kshortcut.cpp.

bool KKeySequence::init ( const TQString &  key)

Initializes this key sequence to contain the given key sequence.

The description consists of comma-separated keys as required by KKey::KKey(const TQString&).

Parameters
keythe description of the key
Returns
true if successful, false otherwise
See Also
KKeyServer::Sym::init()
KKey::KKey(const TQString&)

Definition at line 268 of file kshortcut.cpp.

bool KKeySequence::isNull ( ) const

Returns true if the key sequence is null (after clear() or empty constructor).

Returns
true if the key sequence is null
See Also
clear()
null()

Definition at line 316 of file kshortcut.cpp.

const KKey & KKeySequence::key ( uint  i) const

Return the i'th key of this sequence, or a null key if there are less then i keys.

Parameters
ithe key to retrieve
Returns
the i'th key, or KKey::null() if there are less than i keys
See Also
MAX_KEYS

Definition at line 294 of file kshortcut.cpp.

int KKeySequence::keyCodeQt ( ) const

Returns the qt key code of the first key.

Returns
the qt key code of the first key
See Also
Qt::Key
KKey::keyCodeQt()

Definition at line 357 of file kshortcut.cpp.

KKeySequence & KKeySequence::null ( )
static

Returns a null key sequence.

Returns
the null key sequence
See Also
isNull()
clear()

Definition at line 390 of file kshortcut.cpp.

bool KKeySequence::operator!= ( const KKeySequence &  seq) const
inline

Compares the keys of both sequences.

See Also
compare()

Definition at line 463 of file kshortcut.h.

bool KKeySequence::operator< ( const KKeySequence &  seq) const
inline

Compares the keys of both sequences.

See Also
compare()

Definition at line 470 of file kshortcut.h.

KKeySequence& KKeySequence::operator= ( const KKeySequence &  seq)
inline

Copy the given key sequence into this sequence.

Definition at line 387 of file kshortcut.h.

bool KKeySequence::operator== ( const KKeySequence &  seq) const
inline

Compares the keys of both sequences.

See Also
compare()

Definition at line 456 of file kshortcut.h.

TQKeySequence KKeySequence::qt ( ) const

Converts this key sequence to a TQKeySequence.

Returns
the QKeySequence

Definition at line 347 of file kshortcut.cpp.

bool KKeySequence::setKey ( uint  i,
const KKey &  key 
)

Sets the i'th key of the sequence.

You can not introduce gaps in a sequence, so you must use an i <= count(). Also note that the maximum length of a key sequence is MAX_KEYS.

Parameters
ithe position of the new key (<= count(), <= MAX_KEYS)
keythe key to set
Returns
true if successful, false otherwise

Definition at line 305 of file kshortcut.cpp.

bool KKeySequence::startsWith ( const KKeySequence &  keySeq) const

Returns true if this key sequence begins with the given sequence.

Parameters
keySeqthe key sequence to search
Returns
true if this key sequence begins with the given sequence

Definition at line 321 of file kshortcut.cpp.

TQString KKeySequence::toString ( ) const

Returns the key sequence as a number of key presses as returned by KKey::toString(), separated by commas.

Returns
the string represenation of this key sequence
See Also
KKey::toString()

Definition at line 362 of file kshortcut.cpp.


The documentation for this class was generated from the following files:
  • kshortcut.h
  • kshortcut.cpp

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.6
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |