KCompletionBase Class Reference

#include <kcompletion.h>

Inheritance diagram for KCompletionBase:

Public Types
typedef QMap< KeyBindingType, KShortcut >	KeyBindingMap
enum	KeyBindingType { TextCompletion, PrevCompletionMatch, NextCompletionMatch, SubstringCompletion }

Public Member Functions
	KCompletionBase ()
virtual	~KCompletionBase ()
KGlobalSettings::Completion	completionMode () const
KCompletion *	completionObject (bool hsig=true)
KCompletion *	compObj () const
bool	emitSignals () const
KShortcut	getKeyBinding (KeyBindingType item) const
bool	handleSignals () const
bool	isCompletionObjectAutoDeleted () const
void	setAutoDeleteCompletionObject (bool autoDelete)
virtual void	setCompletedItems (const QStringList &items, bool autoSuggest=true)=0
virtual void	setCompletedText (const QString &text)=0
virtual void	setCompletionMode (KGlobalSettings::Completion mode)
virtual void	setCompletionObject (KCompletion *compObj, bool hsig=true)
void	setEnableSignals (bool enable)
virtual void	setHandleSignals (bool handle)
bool	setKeyBinding (KeyBindingType item, const KShortcut &key)
void	useGlobalKeyBindings ()

Protected Member Functions
KCompletionBase *	delegate () const
KeyBindingMap	getKeyBindings () const
void	setDelegate (KCompletionBase *delegate)
virtual void	virtual_hook (int id, void *data)

Detailed Description

An abstract base class for adding a completion feature into widgets.

This is a convenience class that provides the basic functions needed to add text completion support into widgets. All that is required is an implementation for the pure virtual function setCompletedText. Refer to KLineEdit or KComboBox to see how easily such support can be added using this as a base class.

An abstract class for adding text completion support to widgets.

Author

Dawit Alemayehu adawi.nosp@m.t@kd.nosp@m.e.org

Definition at line 645 of file kcompletion.h.

Member Typedef Documentation

typedef QMap<KeyBindingType, KShortcut> KCompletionBase::KeyBindingMap

Definition at line 674 of file kcompletion.h.

Member Enumeration Documentation

enum KCompletionBase::KeyBindingType

Constants that represent the items whose short-cut key-binding is programmable.

The default key-bindings for these items are defined in KStandardShortcut.

Enumerator
TextCompletion	Text completion (by default Ctrl-E).
PrevCompletionMatch	Switch to previous completion (by default Ctrl-Up).
NextCompletionMatch	Switch to next completion (by default Ctrl-Down).
SubstringCompletion	Substring completion (by default Ctrl-T).

Definition at line 653 of file kcompletion.h.

Constructor & Destructor Documentation

KCompletionBase::KCompletionBase

(

)

Default constructor.

Definition at line 60 of file kcompletionbase.cpp.

KCompletionBase::~KCompletionBase ( )

virtual

Destructor.

Definition at line 73 of file kcompletionbase.cpp.

Member Function Documentation

KGlobalSettings::Completion KCompletionBase::completionMode

(

)

const

Returns the current completion mode.

The return values are of type KGlobalSettings::Completion. See setCompletionMode() for details.

Returns

the completion mode.

Definition at line 181 of file kcompletionbase.cpp.

KCompletion * KCompletionBase::completionObject

(

bool

hsig = true

)

Returns a pointer to the current completion object.

If the completion object does not exist, it is automatically created and by default handles all the completion signals internally unless hsig is set to false. It is also automatically destroyed when the destructor is called. You can change this default behavior using the setAutoDeleteCompletionObject and setHandleSignals member functions.

See also compObj.

Parameters

hsig	if true, handles completion signals internally.

Returns

a pointer the completion object.

Definition at line 96 of file kcompletionbase.cpp.

KCompletion * KCompletionBase::compObj

(

)

const

Returns a pointer to the completion object.

This method is only different from completionObject() in that it does not create a new KCompletion object even if the internal pointer is NULL. Use this method to get the pointer to a completion object when inheriting so that you won't inadvertently create it!!

Returns

the completion object or NULL if one does not exist.

Definition at line 220 of file kcompletionbase.cpp.

KCompletionBase * KCompletionBase::delegate ( ) const

protected

Returns the delegation object.

Returns

the delegation object, or 0 if there is none

See also

setDelegate()

Definition at line 91 of file kcompletionbase.cpp.

bool KCompletionBase::emitSignals

(

)

const

Returns true if the object emits the signals.

Returns

true if signals are emitted

Definition at line 162 of file kcompletionbase.cpp.

KShortcut KCompletionBase::getKeyBinding

(

KeyBindingType

item

)

const

Returns the key-binding used for the specified item.

This methods returns the key-binding used to activate the feature feature given by item. If the binding contains modifier key(s), the SUM of the modifier key and the actual key code are returned.

Parameters

item	the item to check

Returns

the key-binding used for the feature given by item.

See also

setKeyBinding

Definition at line 201 of file kcompletionbase.cpp.

KCompletionBase::KeyBindingMap KCompletionBase::getKeyBindings ( ) const

protected

Returns a key-binding map.

This method is the same as getKeyBinding() except it returns the whole keymap containing the key-bindings.

Returns

the key-binding used for the feature given by item.

Definition at line 226 of file kcompletionbase.cpp.

bool KCompletionBase::handleSignals

(

)

const

Returns true if the object handles the signals.

Returns

true if this signals are handled internally.

Definition at line 157 of file kcompletionbase.cpp.

bool KCompletionBase::isCompletionObjectAutoDeleted

(

)

const

Returns true if the completion object is deleted upon this widget's destruction.

See setCompletionObject() and enableCompletion() for details.

Returns

true if the completion object will be deleted automatically

Definition at line 135 of file kcompletionbase.cpp.

void KCompletionBase::setAutoDeleteCompletionObject

(

bool

autoDelete

)

Sets the completion object when this widget's destructor is called.

If the argument is set to true, the completion object is deleted when this widget's destructor is called.

Parameters

autoDelete

if true, delete completion object on destruction.

Definition at line 141 of file kcompletionbase.cpp.

virtual void KCompletionBase::setCompletedItems ( const QStringList &  items, bool  autoSuggest = true  )

pure virtual

A pure virtual function that must be implemented by all inheriting classes.

Parameters

items	the list of completed items
autoSuggest	if true, the first element of items is auto-completed (i.e. pre-selected).

virtual void KCompletionBase::setCompletedText ( const QString &  text )

pure virtual

A pure virtual function that must be implemented by all inheriting classes.

This function is intended to allow external completion implementations to set completed text appropriately. It is mostly relevant when the completion mode is set to CompletionAuto and CompletionManual modes. See KCompletionBase::setCompletedText. Does nothing in CompletionPopup mode, as all available matches will be shown in the popup.

Parameters

text	the completed text to be set in the widget.

void KCompletionBase::setCompletionMode ( KGlobalSettings::Completion  mode )

virtual

Sets the type of completion to be used.

The completion modes supported are those defined in KGlobalSettings(). See below.

Parameters

mode

Completion type: CompletionNone: Disables completion feature. CompletionAuto: Attempts to find a match & fills-in the remaining text. CompletionMan: Acts the same as the above except the action has to be manually triggered through pre-defined completion key. CompletionShell: Mimics the completion feature found in typical *nix shell environments. CompletionPopup: Shows all available completions at once, in a listbox popping up.

Reimplemented in KLineEdit.

Definition at line 167 of file kcompletionbase.cpp.

void KCompletionBase::setCompletionObject ( KCompletion *  compObj, bool  hsig = true  )

virtual

Sets up the completion object to be used.

This method assigns the completion object and sets it up to automatically handle the completion and rotation signals internally. You should use this function if you want to share one completion object among your widgets or need to use a customized completion object.

The object assigned through this method is not deleted when this object's destructor is invoked unless you explicitly call setAutoDeleteCompletionObject after calling this method. Be sure to set the bool argument to false, if you want to handle the completion signals yourself.

Parameters

compObj	a KCompletion() or a derived child object.
hsig	if true, handles completion signals internally.

Reimplemented in KLineEdit.

Definition at line 109 of file kcompletionbase.cpp.

void KCompletionBase::setDelegate ( KCompletionBase *  delegate )

protected

Sets or removes the delegation object.

If a delegation object is set, all function calls will be forwarded to the delegation object.

Parameters

delegate

the delegation object, or 0 to remove it

Definition at line 78 of file kcompletionbase.cpp.

void KCompletionBase::setEnableSignals

(

bool

enable

)

Sets the widget's ability to emit text completion and rotation signals.

Invoking this function with enable set to false will cause the completion & rotation signals not to be emitted. However, unlike setting the completion object to NULL using setCompletionObject, disabling the emition of the signals through this method does not affect the current completion object.

There is no need to invoke this function by default. When a completion object is created through completionObject or setCompletionObject, these signals are set to emit automatically. Also note that disabling this signals will not necessarily interfere with the objects ability to handle these events internally. See setHandleSignals.

Parameters

enable

if false, disables the emition of completion & rotation signals.

Definition at line 149 of file kcompletionbase.cpp.

void KCompletionBase::setHandleSignals ( bool  handle )

virtual

Enables this object to handle completion and rotation events internally.

This function simply assigns a boolean value that indicates whether it should handle rotation and completion events or not. Note that this does not stop the object from emitting signals when these events occur.

Parameters

handle

if true, handle completion & rotation internally.

Definition at line 127 of file kcompletionbase.cpp.

bool KCompletionBase::setKeyBinding	(	KeyBindingType	item,
		const KShortcut &	key
	)

Sets the key-binding to be used for manual text completion, text rotation in a history list as well as a completion list.

When the keys set by this function are pressed, a signal defined by the inheriting widget will be activated. If the default value or 0 is specified by the second parameter, then the key-binding as defined in the global setting should be used. This method returns false value for key is negative or the supplied key-binding conflicts with the ones set for one of the other features.

NOTE: To use a modifier key (Shift, Ctrl, Alt) as part of the key-binding simply simply sum up the values of the modifier and the actual key. For example, to use CTRL+E as a key binding for one of the items, you would simply supply "Qt::CtrlButton + Qt::Key_E" as the second argument to this function.

Parameters

item	the feature whose key-binding needs to be set: TextCompletion the manual completion key-binding. PrevCompletionMatch the previous match key for multiple completion. NextCompletionMatch the next match key for for multiple completion. SubstringCompletion the key for substring completion
key	key-binding used to rotate down in a list.

Returns

true if key-binding can successfully be set.

See also

getKeyBinding

Definition at line 186 of file kcompletionbase.cpp.

void KCompletionBase::useGlobalKeyBindings

(

)

Sets this object to use global values for key-bindings.

This method changes the values of the key bindings for rotation and completion features to the default values provided in KGlobalSettings.

NOTE: By default inheriting widgets should uses the global key-bindings so that there will be no need to call this method.

Definition at line 206 of file kcompletionbase.cpp.

void KCompletionBase::virtual_hook ( int  id, void *  data  )

protectedvirtual

Virtual hook, used to add new "virtual" functions while maintaining binary compatibility.

Unused in this class.

Definition at line 243 of file kcompletionbase.cpp.

---

The documentation for this class was generated from the following files:

• kcompletion.h
• kcompletionbase.cpp