KComboBox Class Reference

#include <kcombobox.h>

Inheritance diagram for KComboBox:

Public Slots
void	rotateText (TDECompletionBase::KeyBindingType type)
virtual void	setCompletedText (const TQString &)
void	setCompletedItems (const TQStringList &items)
void	setCurrentItem (const TQString &item, bool insert=false, int index=-1)
void	setCurrentItem (int index)

Signals
void	returnPressed ()
void	returnPressed (const TQString &)
void	completion (const TQString &)
void	substringCompletion (const TQString &)
void	textRotation (TDECompletionBase::KeyBindingType)
void	completionModeChanged (TDEGlobalSettings::Completion)
void	aboutToShowContextMenu (TQPopupMenu *p)

Public Member Functions
	KComboBox (TQWidget *parent=0, const char *name=0)
	KComboBox (bool rw, TQWidget *parent=0, const char *name=0)
virtual	~KComboBox ()
void	setEditURL (const KURL &url)
void	insertURL (const KURL &url, int index=-1)
void	insertURL (const TQPixmap &pixmap, const KURL &url, int index=-1)
void	changeURL (const KURL &url, int index)
void	changeURL (const TQPixmap &pixmap, const KURL &url, int index)
int	cursorPosition () const
virtual void	setAutoCompletion (bool autocomplete)
bool	autoCompletion () const
virtual void	setContextMenuEnabled (bool showMenu)
bool	isContextMenuEnabled () const
void	setURLDropsEnabled (bool enable)
bool	isURLDropsEnabled () const
bool	contains (const TQString &text) const
void	setTrapReturnKey (bool trap)
bool	trapReturnKey () const
virtual bool	eventFilter (TQObject *, TQEvent *)
TDECompletionBox *	completionBox (bool create=true)
virtual void	setLineEdit (TQLineEdit *)
Public Member Functions inherited from TDECompletionBase
TDECompletion *	completionObject (bool hsig=true)
virtual void	setCompletionObject (TDECompletion *compObj, bool hsig=true)
virtual void	setHandleSignals (bool handle)
bool	isCompletionObjectAutoDeleted () const
void	setAutoDeleteCompletionObject (bool autoDelete)
void	setEnableSignals (bool enable)
bool	handleSignals () const
bool	emitSignals () const
virtual void	setCompletionMode (TDEGlobalSettings::Completion mode)
TDEGlobalSettings::Completion	completionMode () const
bool	setKeyBinding (KeyBindingType item, const TDEShortcut &key)
const TDEShortcut &	getKeyBinding (KeyBindingType item) const
void	useGlobalKeyBindings ()
virtual void	setCompletedText (const TQString &text)=0
virtual void	setCompletedItems (const TQStringList &items)=0
TDECompletion *	compObj () const

Protected Slots
virtual void	itemSelected (TQListBoxItem *)
virtual void	makeCompletion (const TQString &)

Protected Member Functions
virtual void	setCompletedText (const TQString &, bool)
virtual void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
virtual void	wheelEvent (TQWheelEvent *ev)
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from TDECompletionBase
KeyBindingMap	getKeyBindings () const
void	setDelegate (TDECompletionBase *delegate)
TDECompletionBase *	delegate () const

Additional Inherited Members
Public Types inherited from TDECompletionBase
enum	KeyBindingType
Public Attributes inherited from TDECompletionBase
	TextCompletion
	PrevCompletionMatch
	NextCompletionMatch
	SubstringCompletion

Detailed Description

An enhanced combo box.

A combined button, line-edit and a popup list widget.

Detail
This widget inherits from TQComboBox and implements the following additional functionalities: a completion object that provides both automatic and manual text completion as well as text rotation features, configurable key-bindings to activate these features, and a popup-menu item that can be used to allow the user to change the text completion mode on the fly.

To support these new features KComboBox emits a few additional signals such as completion( const TQString& ) and textRotation( KeyBindgingType ). The completion signal can be connected to a slot that will assist the user in filling out the remaining text while the rotation signal can be used to traverse through all possible matches whenever text completion results in multiple matches. Additionally, a returnPressed() and a returnPressed( const TQString& ) signals are emitted when the user presses the Enter/Return key.

KCombobox by default creates a completion object when you invoke the completionObject( bool ) member function for the first time or explicitly use setCompletionObject( TDECompletion*, bool ) to assign your own completion object. Additionally, to make this widget more functional, KComboBox will by default handle text rotation and completion events internally whenever a completion object is created through either one of the methods mentioned above. If you do not need this functionality, simply use setHandleSignals(bool) or alternatively set the boolean parameter in the setCompletionObject call to false.

Beware: The completion object can be deleted on you, especially if a call such as setEditable(false) is made. Store the pointer at your own risk, and consider using TQGuardedPtr<TDECompletion>.

The default key-bindings for completion and rotation is determined from the global settings in TDEStdAccel. These values, however, can be overridden locally by invoking TDECompletionBase::setKeyBinding(). The values can easily be reverted back to the default setting, by simply calling useGlobalSettings(). An alternate method would be to default individual key-bindings by usning setKeyBinding() with the default second argument.

A non-editable combobox only has one completion mode, CompletionAuto. Unlike an editable combobox the CompletionAuto mode, works by matching any typed key with the first letter of entries in the combobox. Please note that if you call setEditable( false ) to change an editable combobox to a non-editable one, the text completion object associated with the combobox will no longer exist unless you created the completion object yourself and assigned it to this widget or you called setAutoDeleteCompletionObject( false ). In other words do not do the following:

KComboBox* combo = new TDECompletionBox(true, this, "mywidget");
TDECompletion* comp = combo->completionObject();
combo->setEditable( false );
comp->clear(); // CRASH: completion object does not exist anymore.

A read-only KComboBox will have the same background color as a disabled KComboBox, but its foreground color will be the one used for the read-write mode. This differs from QComboBox's implementation and is done to give visual distinction between the three different modes: disabled, read-only, and read-write.

Usage
To enable the basic completion feature:

KComboBox *combo = new KComboBox( true, this, "mywidget" );
TDECompletion *comp = combo->completionObject();
// Connect to the return pressed signal - optional
connect(combo,TQ_SIGNAL(returnPressed(const TQString&)),comp,TQ_SLOT(addItem(const TQString&)));
 
// Provide the to be completed strings. Note that those are separate from the combo's
// contents.
comp->insertItems( someQStringList );

To use your own completion object:

KComboBox *combo = new KComboBox( this,"mywidget" );
KURLCompletion *comp = new KURLCompletion();
combo->setCompletionObject( comp );
// Connect to the return pressed signal - optional
connect(combo,TQ_SIGNAL(returnPressed(const TQString&)),comp,TQ_SLOT(addItem(const TQString&)));

Note that you have to either delete the allocated completion object when you don't need it anymore, or call setAutoDeleteCompletionObject( true );

Miscellaneous function calls:

// Tell the widget not to handle completion and rotation
combo->setHandleSignals( false );
// Set your own completion key for manual completions.
combo->setKeyBinding( TDECompletionBase::TextCompletion, TQt::End );
// Hide the context (popup) menu
combo->setContextMenuEnabled( false );

Author

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

Definition at line 151 of file kcombobox.h.

Constructor & Destructor Documentation

KComboBox() [1/2]

KComboBox::KComboBox	(	TQWidget *	parent = 0,
		const char *	name = 0
	)

Constructs a read-only or rather select-only combo box with a parent object and a name.

Parameters

parent	The parent object of this widget
name	The name of this widget

Definition at line 60 of file kcombobox.cpp.

KComboBox() [2/2]

KComboBox::KComboBox	(	bool	rw,
		TQWidget *	parent = 0,
		const char *	name = 0
	)

Constructs a "read-write" or "read-only" combo box depending on the value of the first argument( rw ) with a parent, a name.

Parameters

rw	When true, widget will be editable.
parent	The parent object of this widget.
name	The name of this widget.

Definition at line 66 of file kcombobox.cpp.

~KComboBox()

KComboBox::~KComboBox ( )

virtual

Destructor.

Definition at line 78 of file kcombobox.cpp.

Member Function Documentation

aboutToShowContextMenu

void KComboBox::aboutToShowContextMenu ( TQPopupMenu *  p )

signal

Emitted before the context menu is displayed.

The signal allows you to add your own entries into the context menu. Note that you MUST NOT store the pointer to the TQPopupMenu since it is created and deleted on demand. Otherwise, you can crash your app.

Parameters

p	the context menu about to be displayed

autoCompletion()

bool KComboBox::autoCompletion ( ) const

inline

Re-implemented from TQComboBox.

Returns true if the current completion mode is set to automatic. See its more comprehensive replacement completionMode().

Returns

true when completion mode is automatic.

Definition at line 253 of file kcombobox.h.

changeURL() [1/2]

void KComboBox::changeURL	(	const KURL &	url,
		int	index
	)

Replaces the item at position index with url.

KURL::prettyURL() is used so that the url is properly decoded for displaying.

Definition at line 213 of file kcombobox.cpp.

changeURL() [2/2]

void KComboBox::changeURL	(	const TQPixmap &	pixmap,
		const KURL &	url,
		int	index
	)

Replaces the item at position index with url and pixmap pixmap.

KURL::prettyURL() is used so that the url is properly decoded for displaying.

Definition at line 218 of file kcombobox.cpp.

completion

void KComboBox::completion ( const TQString &  )

signal

Emitted when the completion key is pressed.

The argument is the current text being edited.

Note that this signal is not available when the widget is non-editable or the completion mode is set to TDEGlobalSettings::CompletionNone.

completionBox()

TDECompletionBox * KComboBox::completionBox

(

bool

create = true

)

Returns

the completion-box, that is used in completion mode TDEGlobalSettings::CompletionPopup and TDEGlobalSettings::CompletionPopupAuto. This method will create a completion-box by calling KLineEdit::completionBox, if none is there, yet.

Parameters

create

Set this to false if you don't want the box to be created i.e. to test if it is available.

Definition at line 229 of file kcombobox.cpp.

completionModeChanged

void KComboBox::completionModeChanged ( TDEGlobalSettings::Completion  )

signal

Emitted whenever the completion mode is changed by the user through the context menu.

contains()

bool KComboBox::contains

(

const TQString &

text

)

const

Convenience method which iterates over all items and checks if any of them is equal to text.

If text is an empty string, false is returned.

Returns

true if an item with the string text is in the combobox.

Definition at line 94 of file kcombobox.cpp.

create()

void KComboBox::create ( WId  id = 0, bool  initializeWindow = true, bool  destroyOldWindow = true  )

protectedvirtual

Reimplemented for internal reasons, the API is not affected.

Definition at line 237 of file kcombobox.cpp.

cursorPosition()

int KComboBox::cursorPosition ( ) const

inline

Returns the current cursor position.

This method always returns a -1 if the combo-box is not editable (read-write).

Returns

Current cursor position.

Definition at line 230 of file kcombobox.h.

eventFilter()

bool KComboBox::eventFilter ( TQObject *  o, TQEvent *  ev  )

virtual

Re-implemented for internal reasons.

API not affected.

Definition at line 179 of file kcombobox.cpp.

insertURL() [1/2]

void KComboBox::insertURL	(	const KURL &	url,
		int	index = -1
	)

Inserts url at position index into the combobox.

The item will be appended if index is negative. KURL::prettyURL() is used so that the url is properly decoded for displaying.

Definition at line 203 of file kcombobox.cpp.

insertURL() [2/2]

void KComboBox::insertURL	(	const TQPixmap &	pixmap,
		const KURL &	url,
		int	index = -1
	)

Inserts url with the pixmap &p pixmap at position index into the combobox.

The item will be appended if index is negative. KURL::prettyURL() is used so that the url is properly decoded for displaying.

Definition at line 208 of file kcombobox.cpp.

isContextMenuEnabled()

bool KComboBox::isContextMenuEnabled ( ) const

inline

Returns true when the context menu is enabled.

Definition at line 277 of file kcombobox.h.

isURLDropsEnabled()

bool KComboBox::isURLDropsEnabled

(

)

const

Returns true when decoded URL drops are enabled.

Definition at line 138 of file kcombobox.cpp.

itemSelected

virtual void KComboBox::itemSelected ( TQListBoxItem *  )

inlineprotectedvirtualslot

Deprecated:

Definition at line 467 of file kcombobox.h.

makeCompletion

void KComboBox::makeCompletion ( const TQString &  text )

protectedvirtualslot

Completes text according to the completion mode.

Note: this method is not invoked if the completion mode is set to CompletionNone. Also if the mode is set to CompletionShell and multiple matches are found, this method will complete the text to the first match with a beep to inidicate that there are more matches. Then any successive completion key event iterates through the remaining matches. This way the rotation functionality is left to iterate through the list as usual.

Definition at line 156 of file kcombobox.cpp.

returnPressed [1/2]

void KComboBox::returnPressed ( )

signal

Emitted when the user presses the Enter key.

Note that this signal is only emitted when the widget is editable.

returnPressed [2/2]

void KComboBox::returnPressed ( const TQString &  )

signal

Emitted when the user presses the Enter key.

The argument is the current text being edited. This signal is just like returnPressed() except it contains the current text as its argument.

Note that this signal is only emitted when the widget is editable.

rotateText

void KComboBox::rotateText ( TDECompletionBase::KeyBindingType  type )

slot

Iterates through all possible matches of the completed text or the history list.

Depending on the value of the argument, this function either iterates through the history list of this widget or the all possible matches in whenever multiple matches result from a text completion request. Note that the all-possible-match iteration will not work if there are no previous matches, i.e. no text has been completed and the *nix shell history list rotation is only available if the insertion policy for this widget is set either QComobBox::AtTop or TQComboBox::AtBottom. For other insertion modes whatever has been typed by the user when the rotation event was initiated will be lost.

Parameters

type	The key-binding invoked.

Definition at line 172 of file kcombobox.cpp.

setAutoCompletion()

void KComboBox::setAutoCompletion ( bool  autocomplete )

virtual

Re-implemented from TQComboBox.

If true, the completion mode will be set to automatic. Otherwise, it is defaulted to the global setting. This method has been replaced by the more comprehensive setCompletionMode().

Parameters

autocomplete

Flag to enable/disable automatic completion mode.

Definition at line 108 of file kcombobox.cpp.

setCompletedItems

void KComboBox::setCompletedItems ( const TQStringList &  items )

slot

Sets items into the completion-box if completionMode() is CompletionPopup.

The popup will be shown immediately.

Definition at line 223 of file kcombobox.cpp.

setCompletedText [1/2]

void KComboBox::setCompletedText ( const TQString &  text )

virtualslot

Sets the completed text in the line-edit appropriately.

This function is a re-implementation of setCompletedText.

Definition at line 150 of file kcombobox.cpp.

setCompletedText() [2/2]

void KComboBox::setCompletedText ( const TQString &  text, bool  marked  )

protectedvirtual

Definition at line 144 of file kcombobox.cpp.

setContextMenuEnabled()

void KComboBox::setContextMenuEnabled ( bool  showMenu )

virtual

Enables or disable the popup (context) menu.

This method only works if this widget is editable, i.e. read-write and allows you to enable/disable the context menu. It does nothing if invoked for a none-editable combo-box. Note that by default the mode changer item is made visiable whenever the context menu is enabled. Use hideModechanger() if you want to hide this item. Also by default, the context menu is created if this widget is editable. Call this function with the argument set to false to disable the popup menu.

Parameters

showMenu

If true, show the context menu.

Definition at line 125 of file kcombobox.cpp.

setCurrentItem [1/2]

void KComboBox::setCurrentItem ( const TQString &  item, bool  insert = false, int  index = -1  )

slot

Selects the first item that matches item.

If there is no such item, it is inserted at position index if insert is true. Otherwise, no item is selected.

Definition at line 306 of file kcombobox.cpp.

setCurrentItem [2/2]

void KComboBox::setCurrentItem ( int  index )

inlineslot

Simply calls QComboBox' implementation.

Only here to not become shadowed.

Definition at line 460 of file kcombobox.h.

setEditURL()

void KComboBox::setEditURL

(

const KURL &

url

)

Sets url into the edit field of the combobox.

It uses KURL::prettyURL() so that the url is properly decoded for displaying.

Definition at line 198 of file kcombobox.cpp.

setLineEdit()

void KComboBox::setLineEdit ( TQLineEdit *  edit )

virtual

Re-implemented for internal reasons.

API remains unaffected. NOTE: Only editable comboboxes can have a line editor. As such any attempt to assign a line-edit to a non-editable combobox will simply be ignored.

Definition at line 249 of file kcombobox.cpp.

setTrapReturnKey()

void KComboBox::setTrapReturnKey

(

bool

trap

)

By default, KComboBox recognizes Key_Return and Key_Enter and emits the returnPressed() signals, but it also lets the event pass, for example causing a dialog's default-button to be called.

Call this method with trap equal to true to make KComboBox stop these events. The signals will still be emitted of course.

Only affects read-writable comboboxes.

See also

setTrapReturnKey()

Definition at line 184 of file kcombobox.cpp.

setURLDropsEnabled()

void KComboBox::setURLDropsEnabled

(

bool

enable

)

Enables/Disables handling of URL drops.

If enabled and the user drops an URL, the decoded URL will be inserted. Otherwise the default behavior of TQComboBox is used, which inserts the encoded URL.

Parameters

enable

If true, insert decoded URLs

Definition at line 132 of file kcombobox.cpp.

substringCompletion

void KComboBox::substringCompletion ( const TQString &  )

signal

Emitted when the shortcut for substring completion is pressed.

textRotation

void KComboBox::textRotation ( TDECompletionBase::KeyBindingType  )

signal

Emitted when the text rotation key-bindings are pressed.

The argument indicates which key-binding was pressed. In this case this can be either one of four values: PrevCompletionMatch, NextCompletionMatch, RotateUp or RotateDown. See setKeyBinding() for details.

Note that this signal is NOT emitted if the completion mode is set to CompletionNone.

trapReturnKey()

bool KComboBox::trapReturnKey

(

)

const

Returns

true if keyevents of Key_Return or Key_Enter will be stopped or if they will be propagated.

See also

setTrapReturnKey ()

Definition at line 192 of file kcombobox.cpp.

virtual_hook()

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

protectedvirtual

Definition at line 720 of file kcombobox.cpp.

wheelEvent()

void KComboBox::wheelEvent ( TQWheelEvent *  ev )

protectedvirtual

Reimplemented in KHistoryCombo.

Definition at line 243 of file kcombobox.cpp.

---

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

• kcombobox.h
• kcombobox.cpp