|
|
An enhanced QLineEdit widget for inputting text.
This widget inherits from QLineEdit and implements the following additional functionalities: a completion object that provides both automatic and manual text completion as well as multiple match iteration 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 KLineEdit also emits a few more additional signals. These are: completion, previousMatch, nextMatch and returnPressed. The completion signal can be connected to a slot that will assist the user in filling out the remaining text. The two iteration signals are intended to be used to iterate through the list of all possible matches whenever there is more than one match for the given text. The returnPressed signal is the same as QLineEdit's except it provides the current text in the widget as its argument whenever appropriate.
This widget by default creates a completion object whenever you invoke
the member function completionObject for the first time. You can
also assign your own completion object through setCompletionObject
function if you want to control the kind of completion object that needs
to be used. Additionally, to make this widget more functional, KLineEdit
will automatically handle the iteration and completion signals internally
when a completion object is created through either one of the previously
defined methods. If you do not need this feature, simply use KCompletionBase::setHandleSignals or the boolean paramter when calling
setCompletionObject
, to turn it off.
The default key-bindings for the completion and iteration are determined from the global settings in KStdAccel. However, these values can be set locally overriding the global settings. Afterwards, simply invoking useGlobalKeyBindings allows you to immediately default the bindings back to the global settings again. Also if you are interested in only defaulting the key-bindings individually for each action, simply call the @ ref KCompletionBase::setKeyBinding method with only the first argument set to the appropriate feature. For example, after locally customizing the key-binding that invokes a manual completion simply calling setKeyBinding( KCompletionBase::TextCompletion ), without the second argument, will result in the completion key being set to 0. This will then force the key-event filter to use the global value.
NOTE: if the EchoMode for this widget is set to something other than QLineEdit::Normal, the completion mode will always be defaulted to KGlobal::CompletionNone. This is done purposefully to guard against protected entries such as passwords being cached in KCompletion's list. Hence, if the EchoMode is not QLineEdit::Normal, the completion mode is automatically disabled.
To enable the basic completion feature :
KLineEdit *edit = new KLineEdit( this, "mywidget" ); KCompletion *comp = edit->completionObject(); // Connect to the return pressed signal - optional connect(edit,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&));
To use a customized completion objects or your own completion object :
KLineEdit *edit = new KLineEdit( this,"mywidget" ); KURLCompletion *comp = new KURLCompletion(); edit->setCompletionObject( comp ); // Connect to the return pressed signal - optional connect(edit,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&));
Other miscelanous function calls :
// Tell the widget not to handle completion and // iteration internally. edit->setHandleSignals( false ); // Set your own completion key for manual completions. edit->setKeyBinding( KCompletionBase::TextCompletion, Qt::End ); // Hide the context (popup) menu edit->setEnableContextMenu( false ); // Temporarly disable signal emitions // (both completion & iteration signals) edit->disableSignals(); // Default the key-bindings to system settings. edit->useGlobalKeyBindings();
|
Constructs a KLineEdit object with a default text, a parent, and a name.
Parameters:
string | text to be shown in the edit widget |
parent | the parent object of this widget |
name | the name of this widget |
|
Constructs a KLineEdit object with a parent and a name.
Parameters:
string | text to be shown in the edit widget |
parent | the parent object of this widget |
name | the name of this widget |
~ |
[virtual]
Destructor.
void |
Puts cursor at the end of the string.
This method is deprecated. Use QLineEdit::end instead.
QLineEdit::end
void |
[virtual]
Re-implemented from KCompletionBase for internal reasons.
This function is re-implemented in order to make sure that the EchoMode is acceptable before we set the completion mode.
See KCompletionBase::setCompletionMode
Reimplemented from KCompletionBase
void |
[virtual]
Enables/disables the popup (context) menu.
Note that when this function is invoked with its argument
set to true
, then both the context menu and the completion
menu item are enabled. If you do not want to the completion
item to be visible simply invoke hideModechanger right
after calling this method. Also by default, the context
menu is automatically created if this widget is editable. Thus
you need to call this function with the argument set to false
if you do not want this behaviour.
Parameters:
showMenu | if true, show the context menu. |
showMode | if true, show the mode changer item. |
bool |
[const]
Returns true when the context menu is enabled.
Returns: true
if context menu is enabled.
void |
[signal]
This signal is emitted when the user presses the return key. The argument is the current text. Note that this signal is NOT emitted if the widget's EchoMode is set to QLineEdit::Password.
void |
[signal]
Signal emitted when the completion key is pressed.
Please note that this signal is NOT emitted if the completion mode is set to CompletionNone or EchoMode is NOT normal.
void |
[signal]
Signal emitted when the key-binding set for the next text match is pressed.
See KCompletionBase::setKeyBinding.
Note that this signal is NOT emitted if the completion mode is set to CompletionNone or EchoMode is NOT normal.
void |
[signal]
Signal emitted when the key-binding set for the previous text match is pressed.
See KCompletionBase::setKeyBinding.
Note that this signal is NOT emitted if the completion mode is set to CompletionNone or EchoMode is NOT normal.
void |
[slot]
Iterates through all possible matches of the completed text or the history list.
This function simply iterates over all possible matches in case multimple matches are found as a result of a text completion request. It will have no effect if only a single match is found.
Parameters:
type | the key-binding invoked. |
void |
[protected virtual slot]
Accepts the "aboutToShow" signal from the completion sub-menu inserted by showCompletionMenu.
This method sets the completion mode to the one requested by the end user.
Parameters:
itemID | the completion mode type |
void |
[protected virtual slot]
Populates the sub menu before it is displayed.
All the items are inserted by the completion base class. See @KCompletionBase::insertCompletionItems. The items then invoke the slot giiven by the
void |
[protected virtual slot]
Inserts the completion menu item as needed.
Since this widget's parent class comes with its own pop-up menu this slot is needed to invoke the method need to insert the completion menu item. This method, KCompletionBase::insetCompeltionMenu, is defined by the KCompletionBase.
void |
[protected virtual slot]
Completes the remaining text with a matching one from a given list.
void |
[protected virtual]
Initializes variables. Called from the constructors.
void |
[protected const virtual]
Implementation of KCompletionBase::connectSignals().
This function simply connects the signals to appropriate slots when they are handled internally.
Parameters:
handle | if true, handle completion & roation internally. |
Reimplemented from KCompletionBase
void |
[protected virtual]
Re-implemented for internal reasons. API not affected.
See QLineEdit::keyPressEvent.
void |
[protected virtual]
Re-implemented for internal reasons. API not affected.
See QLineEdit::mousePressEvent.