class KComboBox

 An enhanced combo box. More...
Definition#include <kcombobox.h>
InheritsKCompletionBase (kdecore), QComboBox (qt)
Inherited byKFontCombo, KHistoryCombo
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Slots

Signals

Protected Methods

Protected Slots

Detailed Description

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

Detail

This widget inherits from QComboBox 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 set text completion modes on the fly based on their preference.

To support these new features KComboBox also emits a few more additional signals as well. The main ones are the completion( const QString& ) and textRotation( KeyBindgingType ) signals. The completion signal is intended to be connected to a slot that will assist the user in filling out the remaining text while the rotation signals is intended to be used to trasverse through all possible matches whenever text completion results in multiple matches. The returnPressed() and returnPressed( const QString& ) signal is emitted when the user presses the Enter/Return key.

This widget by default creates a completion object when you invoke the completionObject( bool ) member function for the first time or use setCompletionObject( KCompletion*, bool ) to assign your own completion object. Additionally, to make this widget more functional, KComboBox will by default handle the 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 KCompletionBase::setHandleSignals( bool ) or alternatively set the boolean parameter in the above methods to FALSE.

The default key-bindings for completion and rotation is determined from the global settings in KStdAccel. These values, however, can be overriden locally by invoking KCompletionBase::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.

Note that if this widget is not editable ( i.e. select-only ), then only one completion mode, CompletionAuto, will work. All the other modes are simply ignored. The CompletionAuto mode in this case allows you to automatically select an item from the list by trying to match the pressed keycode with the first letter of the enteries in the combo box.

Useage

To enable the basic completion feature: 


 KComboBox *combo = new KComboBox( true, this, "mywidget" );
 KCompletion *comp = combo->completionObject();
 // Connect to the return pressed signal - optional
 connect(combo,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&));

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,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&));

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( KCompletionBase::TextCompletion, Qt::End );
 // Hide the context (popup) menu
 combo->setContextMenuEnabled( false );
 // Temporarly disable signal emition
 combo->disableSignals();
 // Default the all key-bindings to their system-wide settings.
 combo->useGlobalKeyBindings();

void  returnPressed ()

[signal]

Emitted when the user presses the Enter key.

Note that this signal is only emitted if this widget is editable.

void  returnPressed ( const QString& )

[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 if this widget is editable.

void  completion ( const QString& )

[signal]

This signal is emitted when the completion key is pressed.

The argument is the current text being edited.

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

void  textRotation ( KCompletionBase::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 KCompletionBase::setKeyBinding() for details.

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

void  completionModeChanged ( KGlobalSettings::Completion )

[signal]

Emitted when the user changed the completion mode by using the popupmenu.

void  rotateText ( KCompletionBase::KeyBindingType )

[slot]

Iterate 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 QComboBox::AtBottom. For other insertion modes whatever has been typed by the user when the rotation event was initiated will be lost.

Parameters:
typeThe key-binding invoked.

void  setCompletedText ( const QString& )

[virtual slot]

Sets the completed text in the line-edit appropriately.

This function is an implementation for KCompletionBase::setCompletedText.

Reimplemented from KCompletionBase

void  setCompletedItems ( const QStringList& items )

[slot]

Sets items into the completion-box if completionMode() is CompletionPopup. The popup will be shown immediately.

void  itemSelected ( QListBoxItem* )

[protected virtual slot]

void  makeCompletion ( const QString& )

[protected virtual slot]

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.

void  slotAboutToShow ()

[protected slot]

void  slotCancelled ()

[protected slot]

void  keyPressEvent ( QKeyEvent* )

[protected virtual]

@reimplemented

Reimplemented from QComboBox

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

[protected virtual]

Reimplemented for internal reasons, the API is not affected.

Reimplemented from QWidget