org.kde.koala
Class KLineEdit

java.lang.Object
  org.kde.qt.Qt
      org.kde.qt.QObject
          org.kde.qt.QWidget
              org.kde.qt.QFrame
                  org.kde.qt.QLineEdit
                      org.kde.koala.KLineEdit

All Implemented Interfaces:

KCompletionBaseInterface, org.kde.qt.QPaintDeviceInterface, org.kde.qt.QtSupport

Direct Known Subclasses:

KRestrictedLine

public class KLineEdit
extends org.kde.qt.QLineEdit
implements KCompletionBaseInterface

An enhanced QLineEdit widget for inputting text.

Detail

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( String ), textRotation( KeyBindingType ), and returnPressed( String ). The completion signal can be connected to a slot that will assist the user in filling out the remaining text. The text rotation signal is intended to be used to iterate through the list of all possible matches whenever there is more than one match for the entered text. The returnPressed( String ) signals are 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 when you invoke the completionObject( boolean ) member function for the first time or use setCompletionObject( KCompletion, boolean ) to assign your own completion object. Additionally, to make this widget more functional, KLineEdit will by default handle the text rotation and completion events internally when a completion object is created through either one of the methods mentioned above. If you do not need this functionality, simply use KCompletionBase.setHandleSignals( boolean ) or set the booleanean parameter in the above functions to false. The default key-bindings for completion and rotation is determined from the global settings in KStdAccel. These values, however, can be overridden 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 using setKeyBinding() with the default second argument. If EchoMode for this widget is set to something other than QLineEdit.Normal, the completion mode will always be defaulted to KGlobalSettings.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. A read-only KLineEdit will have the same background color as a disabled KLineEdit, but its foreground color will be the one used for the read-write mode. This differs from QLineEdit'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 :

 KLineEdit edit = new KLineEdit( this, "mywidget" );
 KCompletion comp = edit.completionObject();
 // Connect to the return pressed signal - optional
 connect(edit,SIGNAL("returnPressed(String)"),comp,SLOT("addItem(String)"));
 

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(String)"),comp,SLOT("addItem(String)"));
 

Note if you specify your own completion object you have to either delete it when you don't need it anymore, or you can tell KLineEdit to delete it for you:

 
 edit.setAutoDeleteCompletionObject( true );
 

Miscellaneous function calls :

 // Tell the widget to not handle completion and iteration automatically.
 edit.setHandleSignals( false );
 // Set your own key-bindings for a text completion mode.
 edit.setKeyBinding( KCompletionBase.TextCompletion, Qt.End );
 // Hide the context (popup) menu
 edit.setContextMenuEnabled( false );
 // Temporarily disable signal (both completion & iteration) emitions
 edit.disableSignals();
 // Default the key-bindings back to the default system settings.
 edit.useGlobalKeyBindings();
 

See KLineEditSignals for signals emitted by KLineEdit

Author:

Dawit Alemayehu

Field Summary

Fields inherited from class org.kde.qt.QLineEdit

NoEcho, Normal, Password

Fields inherited from class org.kde.qt.QFrame

Box, GroupBoxPanel, HLine, LineEditPanel, MenuBarPanel, MShadow, MShape, NoFrame, Panel, Plain, PopupPanel, Raised, StyledPanel, Sunken, TabWidgetPanel, ToolBarPanel, VLine, WinPanel

Fields inherited from class org.kde.qt.QWidget

AncestorOrigin, ClickFocus, NoFocus, ParentOrigin, StrongFocus, TabFocus, WheelFocus, WidgetOrigin, WindowOrigin

Fields inherited from class org.kde.qt.Qt

AlignAuto, AlignBottom, AlignCenter, AlignHCenter, AlignHorizontal_Mask, AlignJustify, AlignLeft, AlignRight, AlignTop, AlignVCenter, AlignVertical_Mask, AlphaDither_Mask, ALT, AltButton, AnchorHref, AnchorName, AndNotROP, AndROP, ArrowCursor, Ascending, ASCII_ACCEL, AutoColor, AutoDither, AutoText, AvoidDither, BDiagPattern, BeginsWith, BevelJoin, BitmapCursor, BlankCursor, Bottom, BottomLeft, BottomRight, BreakAnywhere, BusyCursor, CaseSensitive, ClearROP, ColorMode_Mask, ColorOnly, Contains, ControlButton, CopyROP, CrossCursor, CrossPattern, CTRL, CustomPattern, DashDotDotLine, DashDotLine, DashLine, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, Descending, DiagCrossPattern, DiffuseAlphaDither, DiffuseDither, Dither_Mask, DitherMode_Mask, DockBottom, DockLeft, DockMinimized, DockRight, DockTop, DockTornOff, DockUnmanaged, DontClip, DontPrint, DotLine, DownArrow, EndsWith, EraseROP, ExactMatch, ExpandTabs, FDiagPattern, FixedColor, FixedPixmap, FlatCap, ForbiddenCursor, HiEnglishUnit, HiMetricUnit, Horizontal, HorPattern, IbeamCursor, Identical, IncludeTrailingSpaces, ISODate, Key_0, Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_A, Key_aacute, Key_Aacute, Key_acircumflex, Key_Acircumflex, Key_acute, Key_adiaeresis, Key_Adiaeresis, Key_ae, Key_AE, Key_agrave, Key_Agrave, Key_Alt, Key_Ampersand, Key_Any, Key_Apostrophe, Key_aring, Key_Aring, Key_AsciiCircum, Key_AsciiTilde, Key_Asterisk, Key_At, Key_atilde, Key_Atilde, Key_B, Key_Back, Key_Backslash, Key_Backspace, Key_BackSpace, Key_Backtab, Key_BackTab, Key_Bar, Key_BassBoost, Key_BassDown, Key_BassUp, Key_BraceLeft, Key_BraceRight, Key_BracketLeft, Key_BracketRight, Key_brokenbar, Key_C, Key_CapsLock, Key_ccedilla, Key_Ccedilla, Key_cedilla, Key_cent, Key_Clear, Key_Colon, Key_Comma, Key_Control, Key_copyright, Key_currency, Key_D, Key_degree, Key_Delete, Key_diaeresis, Key_Direction_L, Key_Direction_R, Key_division, Key_Dollar, Key_Down, Key_E, Key_eacute, Key_Eacute, Key_ecircumflex, Key_Ecircumflex, Key_ediaeresis, Key_Ediaeresis, Key_egrave, Key_Egrave, Key_End, Key_Enter, Key_Equal, Key_Escape, Key_eth, Key_ETH, Key_Exclam, Key_exclamdown, Key_F, Key_F1, Key_F10, Key_F11, Key_F12, Key_F13, Key_F14, Key_F15, Key_F16, Key_F17, Key_F18, Key_F19, Key_F2, Key_F20, Key_F21, Key_F22, Key_F23, Key_F24, Key_F25, Key_F26, Key_F27, Key_F28, Key_F29, Key_F3, Key_F30, Key_F31, Key_F32, Key_F33, Key_F34, Key_F35, Key_F4, Key_F5, Key_F6, Key_F7, Key_F8, Key_F9, Key_Favorites, Key_Forward, Key_G, Key_Greater, Key_guillemotleft, Key_guillemotright, Key_H, Key_Help, Key_Home, Key_HomePage, Key_Hyper_L, Key_Hyper_R, Key_hyphen, Key_I, Key_iacute, Key_Iacute, Key_icircumflex, Key_Icircumflex, Key_idiaeresis, Key_Idiaeresis, Key_igrave, Key_Igrave, Key_Insert, Key_J, Key_K, Key_L, Key_Launch0, Key_Launch1, Key_Launch2, Key_Launch3, Key_Launch4, Key_Launch5, Key_Launch6, Key_Launch7, Key_Launch8, Key_Launch9, Key_LaunchA, Key_LaunchB, Key_LaunchC, Key_LaunchD, Key_LaunchE, Key_LaunchF, Key_LaunchMail, Key_LaunchMedia, Key_Left, Key_Less, Key_M, Key_macron, Key_masculine, Key_MediaLast, Key_MediaNext, Key_MediaPlay, Key_MediaPrev, Key_MediaRecord, Key_MediaStop, Key_Menu, Key_Meta, Key_Minus, Key_mu, Key_multiply, Key_N, Key_Next, Key_nobreakspace, Key_notsign, Key_ntilde, Key_Ntilde, Key_NumberSign, Key_NumLock, Key_O, Key_oacute, Key_Oacute, Key_ocircumflex, Key_Ocircumflex, Key_odiaeresis, Key_Odiaeresis, Key_ograve, Key_Ograve, Key_onehalf, Key_onequarter, Key_onesuperior, Key_Ooblique, Key_OpenUrl, Key_ordfeminine, Key_oslash, Key_otilde, Key_Otilde, Key_P, Key_PageDown, Key_PageUp, Key_paragraph, Key_ParenLeft, Key_ParenRight, Key_Pause, Key_Percent, Key_Period, Key_periodcentered, Key_Plus, Key_plusminus, Key_Print, Key_Prior, Key_Q, Key_Question, Key_questiondown, Key_QuoteDbl, Key_QuoteLeft, Key_R, Key_Refresh, Key_registered, Key_Return, Key_Right, Key_S, Key_ScrollLock, Key_Search, Key_section, Key_Semicolon, Key_Shift, Key_Slash, Key_Space, Key_ssharp, Key_Standby, Key_sterling, Key_Stop, Key_Super_L, Key_Super_R, Key_SysReq, Key_T, Key_Tab, Key_thorn, Key_THORN, Key_threequarters, Key_threesuperior, Key_TrebleDown, Key_TrebleUp, Key_twosuperior, Key_U, Key_uacute, Key_Uacute, Key_ucircumflex, Key_Ucircumflex, Key_udiaeresis, Key_Udiaeresis, Key_ugrave, Key_Ugrave, Key_Underscore, Key_unknown, Key_Up, Key_V, Key_VolumeDown, Key_VolumeMute, Key_VolumeUp, Key_W, Key_X, Key_Y, Key_yacute, Key_Yacute, Key_ydiaeresis, Key_yen, Key_Z, KeyButtonMask, Keypad, LastCursor, LastROP, Left, LeftArrow, LeftButton, LocalDate, LocalTime, LoEnglishUnit, LogText, LoMetricUnit, MacStyle, META, MetaButton, MidButton, Minimized, MiterJoin, MODIFIER_MASK, MonoOnly, MotifStyle, MouseButtonMask, MPenCapStyle, MPenJoinStyle, MPenStyle, MV_10_DOT_0, MV_10_DOT_1, MV_10_DOT_2, MV_10_DOT_3, MV_10_DOT_4, MV_9, MV_CHEETAH, MV_JAGUAR, MV_PANTHER, MV_PUMA, MV_TIGER, MV_Unknown, NandROP, NoAccel, NoAlpha, NoBackground, NoBrush, NoButton, NoMatch, NoPen, NopROP, NorROP, NotAndROP, NotCopyROP, NotEraseROP, NotOrROP, NotROP, NotXorROP, OpaqueMode, OrderedAlphaDither, OrderedDither, OrNotROP, OrROP, Overline, PaletteBackground, PaletteBase, PaletteBrightText, PaletteButton, PaletteButtonText, PaletteDark, PaletteForeground, PaletteHighlight, PaletteHighlightedText, PaletteLight, PaletteLink, PaletteLinkVisited, PaletteMid, PaletteMidlight, PaletteShadow, PaletteText, PartialMatch, PixelUnit, PlainText, PMStyle, PointingHandCursor, PreferDither, RichText, Right, RightArrow, RightButton, RoundCap, RoundJoin, SetROP, SHIFT, ShiftButton, ShowPrefix, SingleLine, SizeAllCursor, SizeBDiagCursor, SizeFDiagCursor, SizeHorCursor, SizeVerCursor, SolidLine, SolidPattern, SplitHCursor, SplitVCursor, SquareCap, StrikeOut, TextDate, ThresholdAlphaDither, ThresholdDither, Top, TopLeft, TopRight, TornOff, TransparentMode, TwipsUnit, UI_AnimateCombo, UI_AnimateMenu, UI_AnimateToolBox, UI_AnimateTooltip, UI_FadeMenu, UI_FadeTooltip, UI_General, Underline, UNICODE_ACCEL, Unmanaged, UpArrow, UpArrowCursor, UTC, VerPattern, Vertical, WaitCursor, WDestructiveClose, WGroupLeader, WhatsThisCursor, Win3Style, WindowActive, WindowFullScreen, WindowMaximized, WindowMinimized, WindowNoState, WindowsStyle, WMacDrawer, WMacNoSheet, WMouseNoMask, WNoAutoErase, WNoMousePropagation, WNorthWestGravity, WordBreak, WPaintClever, WPaintDesktop, WPaintUnclipped, WRepaintNoErase, WResizeNoErase, WShowModal, WState_AutoMask, WState_BlockUpdates, WState_CompressKeys, WState_ConfigPending, WState_Created, WState_CreatedHidden, WState_Disabled, WState_DND, WState_Exposed, WState_ForceDisabled, WState_ForceHide, WState_FullScreen, WState_HasMouse, WState_InPaintEvent, WState_Maximized, WState_Minimized, WState_MouseTracking, WState_OwnCursor, WState_OwnSizePolicy, WState_Polished, WState_Reparented, WState_Reserved0, WState_Resized, WState_Visible, WStaticContents, WStyle_ContextHelp, WStyle_Customize, WStyle_Dialog, WStyle_DialogBorder, WStyle_Mask, WStyle_Maximize, WStyle_Minimize, WStyle_MinMax, WStyle_NoBorder, WStyle_NoBorderEx, WStyle_NormalBorder, WStyle_Reserved, WStyle_Splash, WStyle_StaysOnTop, WStyle_SysMenu, WStyle_Title, WStyle_Tool, WSubWindow, WType_Desktop, WType_Dialog, WType_Mask, WType_Modal, WType_Popup, WType_TopLevel, WV_2000, WV_2003, WV_32s, WV_95, WV_98, WV_CE, WV_CE_based, WV_CENET, WV_DOS_based, WV_Me, WV_NT, WV_NT_based, WV_XP, WWinOwnDC, WX11BypassWM, X11ParentRelative, XorROP

Constructor Summary

	KLineEdit()
protected	KLineEdit(java.lang.Class dummy)
	KLineEdit(org.kde.qt.QWidget parent)
	KLineEdit(org.kde.qt.QWidget parent, java.lang.String name) Constructs a KLineEdit object with a parent and a name.
	KLineEdit(java.lang.String string, org.kde.qt.QWidget parent)
	KLineEdit(java.lang.String string, org.kde.qt.QWidget parent, java.lang.String name) Constructs a KLineEdit object with a default text, a parent, and a name.

Method Summary

protected boolean	autoSuggest() Whether in current state text should be auto-suggested
java.lang.String	className()
void	clear() Reimplemented to workaround a buggy QLineEdit.clear() (changing the clipboard to the text we just had in the lineedit)
KCompletionBox	completionBox()
KCompletionBox	completionBox(boolean create)
int	completionMode() Returns the current completion mode.
KCompletion	completionObject()
KCompletion	completionObject(boolean hsig) Returns a pointer to the current completion object.
KCompletion	compObj() Returns a pointer to the completion object.
protected void	contextMenuEvent(org.kde.qt.QContextMenuEvent arg1) Re-implemented for internal reasons.
void	copy() Reimplemented for internal reasons, the API is not affected.
protected void	create()
protected void	create(long arg1)
protected void	create(long arg1, boolean initializeWindow)
protected void	create(long arg1, boolean initializeWindow, boolean destroyOldWindow) Reimplemented for internal reasons, the API is not affected.
protected org.kde.qt.QPopupMenu	createPopupMenu() Re-implemented for internal reasons.
protected KCompletionBaseInterface	delegate() Returns the delegation object.
void	dispose() Delete the wrapped C++ instance ahead of finalize()
protected void	dropEvent(org.kde.qt.QDropEvent arg1) Re-implemented to handle URI drops.
boolean	emitSignals() Returns true if the object emits the signals.
boolean	eventFilter(org.kde.qt.QObject arg1, org.kde.qt.QEvent arg2) Re-implemented for internal reasons.
protected void	finalize() Deletes the wrapped C++ instance
protected void	focusInEvent(org.kde.qt.QFocusEvent arg1) Re-implemented for internal reasons.
KShortcut	getKeyBinding(int item) Returns the key-binding used for the specified item.
boolean	handleSignals() Returns true if the object handles the signals.
boolean	isCompletionObjectAutoDeleted() Returns true if the completion object is deleted upon this widget's destruction.
boolean	isContextMenuEnabled() Returns true when the context menu is enabled.
boolean	isDisposed() Has the wrapped C++ instance been deleted?
boolean	isSqueezedTextEnabled() Returns true if text squeezing is enabled.
boolean	isURLDropsEnabled() Returns true when decoded URL drops are enabled
protected void	keyPressEvent(org.kde.qt.QKeyEvent arg1) Re-implemented for internal reasons.
protected void	makeCompletion(java.lang.String arg1) Completes the remaining text with a matching one from a given list.
org.kde.qt.QMetaObject	metaObject()
protected void	mouseDoubleClickEvent(org.kde.qt.QMouseEvent arg1) Re-implemented for internal reasons.
protected void	mousePressEvent(org.kde.qt.QMouseEvent arg1) Re-implemented for internal reasons.
java.lang.String	originalText() Returns the original text if text squeezing is enabled.
protected void	resizeEvent(org.kde.qt.QResizeEvent arg1) Re-implemented for internal reasons.
void	rotateText(int type) Iterates through all possible matches of the completed text or the history list.
void	setAutoDeleteCompletionObject(boolean autoDelete) Sets the completion object when this widget's destructor is called.
void	setCompletedItems(java.lang.String[] items) Sets items into the completion-box if completionMode() is CompletionPopup.
void	setCompletedItems(java.lang.String[] items, boolean autoSuggest) Same as the above function except it allows you to temporarily turn off text completion in CompletionPopupAuto mode.
void	setCompletedText(java.lang.String arg1) See KCompletionBase.setCompletedText.
protected void	setCompletedText(java.lang.String arg1, boolean arg2)
void	setCompletionBox(KCompletionBox box) Set the completion-box to be used in completion mode KGlobalSettings.CompletionPopup.
void	setCompletionMode(int mode) Re-implemented from KCompletionBase for internal reasons.
void	setCompletionObject(KCompletion arg1)
void	setCompletionObject(KCompletion arg1, boolean hsig) Reimplemented for internal reasons, the API is not affected.
void	setContextMenuEnabled(boolean showMenu) Enables/disables the popup (context) menu.
protected void	setDelegate(KCompletionBaseInterface delegate) Sets or removes the delegation object.
void	setEnableSignals(boolean enable) Sets the widget's ability to emit text completion and rotation signals.
void	setEnableSqueezedText(boolean enable) Enable text squeezing whenever the supplied text is too long.
void	setHandleSignals(boolean handle) Enables this object to handle completion and rotation events internally.
boolean	setKeyBinding(int item, 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.
void	setReadOnly(boolean arg1) Re-implemented for internal reasons.
void	setSqueezedText(java.lang.String text) Squeezes text into the line edit.
void	setText(java.lang.String arg1) Re-implemented to enable text squeezing.
void	setTrapReturnKey(boolean trap) By default, KLineEdit 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.
void	setURL(KURL url) Sets url into the lineedit.
void	setURLDropsEnabled(boolean enable) Enables/Disables handling of URL drops.
protected void	setUserSelection(boolean userSelection) Sets the widget in userSelection mode or in automatic completion selection mode.
boolean	trapReturnKey()
void	useGlobalKeyBindings() Sets this object to use global values for key-bindings.
protected void	userCancelled(java.lang.String cancelText) Resets the current displayed text.

Methods inherited from class org.kde.qt.QLineEdit

alignment, backspace, characterAt, clearModified, clearValidator, cursorBackward, cursorBackward, cursorForward, cursorForward, cursorLeft, cursorLeft, cursorPosition, cursorRight, cursorRight, cursorWordBackward, cursorWordForward, cut, del, deselect, displayText, dragEnabled, dragEnterEvent, dragLeaveEvent, dragMoveEvent, drawContents, echoMode, edited, end, event, focusOutEvent, frame, getSelection, hasAcceptableInput, hasMarkedText, hasSelectedText, home, imComposeEvent, imEndEvent, imStartEvent, inputMask, insert, isModified, isReadOnly, isRedoAvailable, isUndoAvailable, markedText, maxLength, minimumSizeHint, mouseMoveEvent, mouseReleaseEvent, paste, redo, repaintArea, selectAll, selectedText, selectionStart, setAlignment, setCursorPosition, setDragEnabled, setEchoMode, setEdited, setFont, setFrame, setInputMask, setMaxLength, setPalette, setSelection, setValidator, sizeHint, text, tr, tr, undo, validateAndSet, validator, windowActivationChange

Methods inherited from class org.kde.qt.QFrame

contentsRect, drawFrame, frameChanged, frameRect, frameShadow, frameShape, frameStyle, frameWidth, lineShapesOk, lineWidth, margin, midLineWidth, paintEvent, setFrameRect, setFrameShadow, setFrameShape, setFrameStyle, setLineWidth, setMargin, setMidLineWidth, styleChange

Methods inherited from class org.kde.qt.QWidget

acceptDrops, adjustSize, autoMask, backgroundBrush, backgroundColor, backgroundMode, backgroundOffset, backgroundOrigin, backgroundPixmap, baseSize, caption, childAt, childAt, childAt, childAt, childrenRect, childrenRegion, clearFocus, clearMask, clearWFlags, clearWState, clipRegion, close, close, closeEvent, colorGroup, constPolish, cursor, customWhatsThis, destroy, destroy, destroy, devType, drawText, drawText, enabledChange, enterEvent, erase, erase, erase, erase, eraseColor, erasePixmap, find, focusData, focusNextPrevChild, focusPolicy, focusProxy, focusWidget, font, fontChange, fontInf, fontInfo, fontMet, fontMet, fontMet, fontMetrics, foregroundColor, frameGeometry, frameSize, geometry, getWFlags, getWState, grabKeyboard, grabMouse, grabMouse, hasFocus, hasMouse, hasMouseTracking, height, heightForWidth, hide, hideEvent, icon, iconify, iconText, isActiveWindow, isDesktop, isDialog, isEnabled, isEnabledTo, isEnabledToTLW, isExtDev, isFocusEnabled, isFullScreen, isHidden, isInputMethodEnabled, isMaximized, isMinimized, isModal, isPopup, isShown, isTopLevel, isUpdatesEnabled, isVisible, isVisibleTo, isVisibleToTLW, keyboardGrabber, keyReleaseEvent, layout, leaveEvent, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, maximumHeight, maximumSize, maximumWidth, metric, microFocusHint, minimumHeight, minimumSize, minimumWidth, mouseGrabber, move, move, moveEvent, ownCursor, ownFont, ownPalette, paintDevice, paintingActive, palette, paletteBackgroundColor, paletteBackgroundPixmap, paletteChange, paletteForegroundColor, parentWidget, parentWidget, polish, pos, raise, recreate, recreate, rect, releaseKeyboard, releaseMouse, repaint, repaint, repaint, repaint, repaint, repaint, repaint, repaint, reparent, reparent, reparent, reparent, resetInputContext, resize, resize, resolution, scroll, scroll, setAcceptDrops, setActiveWindow, setAutoMask, setBackgroundColor, setBackgroundMode, setBackgroundMode, setBackgroundOrigin, setBackgroundPixmap, setBaseSize, setBaseSize, setCaption, setCursor, setDisabled, setEnabled, setEraseColor, setErasePixmap, setFixedHeight, setFixedSize, setFixedSize, setFixedWidth, setFocus, setFocusPolicy, setFocusProxy, setFont, setGeometry, setGeometry, setHidden, setIcon, setIconText, setInputMethodEnabled, setKeyCompression, setMask, setMask, setMaximumHeight, setMaximumSize, setMaximumSize, setMaximumWidth, setMicroFocusHint, setMicroFocusHint, setMicroFocusHint, setMinimumHeight, setMinimumSize, setMinimumSize, setMinimumWidth, setMouseTracking, setName, setPalette, setPaletteBackgroundColor, setPaletteBackgroundPixmap, setPaletteForegroundColor, setResolution, setShown, setSizeIncrement, setSizeIncrement, setSizePolicy, setSizePolicy, setSizePolicy, setStyle, setStyle, setTabOrder, setUpdatesEnabled, setWFlags, setWindowOpacity, setWindowState, setWState, show, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeIncrement, sizePolicy, stackUnder, style, tabletEvent, testWFlags, testWState, topLevelWidget, unsetCursor, unsetFont, unsetPalette, update, update, update, updateGeometry, updateMask, visibleRect, wheelEvent, width, windowOpacity, windowState, winId, x, y

Methods inherited from class org.kde.qt.QObject

activate_filters, activate_signal_bool, activate_signal, activate_signal, activate_signal, activate_signal, blockSignals, checkConnectArgs, child, child, child, childEvent, children, connect, connect, connectInternal, connectNotify, customEvent, deleteLater, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnectInternal, disconnectNotify, dumpObjectInfo, dumpObjectTree, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, highPriority, i18n, inherits, insertChild, installEventFilter, isA, isWidgetType, killTimer, killTimers, name, name, normalizeSignalSlot, objectTrees, parent, property, queryList, queryList, queryList, queryList, queryList, registerUserData, removeChild, removeEventFilter, sender, setProperty, signalsBlocked, startTimer, timerEvent

Methods inherited from class org.kde.qt.Qt

arrowCursor, bin, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, black, blankCursor, blue, color0, color1, copyBlt, copyBlt, copyBlt, copyBlt, copyBlt, crossCursor, cyan, darkBlue, darkCyan, darkGray, darkGreen, darkMagenta, darkRed, darkYellow, dec, dynamicCast, endl, flush, forbiddenCursor, fromUtf8, gray, green, hex, ibeamCursor, lightGray, magenta, oct, op_div, op_div, op_div, op_div, op_equals, op_equals, op_equals, op_equals, op_minus, op_minus, op_minus, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_not_equals, op_not_equals, op_not_equals, op_not_equals, op_plus, op_plus, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, pointingHandCursor, qAlpha, qApp, qAppName, qBlue, qCompress, qCompress, qDebug, qDebug, qDrawArrow, qDrawItem, qDrawItem, qDrawItem, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qFatal, qFatal, qGLVersion, qGray, qGray, qGreen, qInitNetworkProtocols, qInstallPath, qInstallPathBins, qInstallPathData, qInstallPathDocs, qInstallPathHeaders, qInstallPathLibs, qInstallPathPlugins, qInstallPathSysconf, qInstallPathTranslations, qItemRect, qItemRect, qObsolete, qObsolete, qObsolete, qRed, qRgb, qRgba, qRound, qSharedBuild, qSuppressObsoleteWarnings, qSuppressObsoleteWarnings, qSysInfo, qSystemWarning, qSystemWarning, qUncompress, qUncompress, qVersion, qWarning, qWarning, red, reset, SIGNAL, sizeAllCursor, sizeBDiagCursor, sizeFDiagCursor, sizeHorCursor, sizeVerCursor, SLOT, splitHCursor, splitVCursor, upArrowCursor, waitCursor, whatsThisCursor, white, ws, yellow

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KLineEdit

protected KLineEdit(java.lang.Class dummy)

KLineEdit

public KLineEdit(java.lang.String string,
                 org.kde.qt.QWidget parent,
                 java.lang.String name)

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

KLineEdit

public KLineEdit(java.lang.String string,
                 org.kde.qt.QWidget parent)

KLineEdit

public KLineEdit(org.kde.qt.QWidget parent,
                 java.lang.String name)

Constructs a KLineEdit object with a parent and a name.

Parameters:

parent - The parent object of this widget.

name - The name of this widget.

KLineEdit

public KLineEdit(org.kde.qt.QWidget parent)

KLineEdit

public KLineEdit()

Method Detail

metaObject

public org.kde.qt.QMetaObject metaObject()

Overrides:

metaObject in class org.kde.qt.QLineEdit

className

public java.lang.String className()

Overrides:

className in class org.kde.qt.QLineEdit

setURL

public void setURL(KURL url)

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

setCompletionMode

public void setCompletionMode(int mode)

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

Specified by:

setCompletionMode in interface KCompletionBaseInterface

setContextMenuEnabled

public void setContextMenuEnabled(boolean showMenu)

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 behavior.

Parameters:

showMenu - If true, show the context menu.

isContextMenuEnabled

public boolean isContextMenuEnabled()

Returns true when the context menu is enabled.

setURLDropsEnabled

public void setURLDropsEnabled(boolean 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 QLineEdit is used, which inserts the encoded URL.

Parameters:

enable - If true, insert decoded URLs

isURLDropsEnabled

public boolean isURLDropsEnabled()

Returns true when decoded URL drops are enabled

setTrapReturnKey

public void setTrapReturnKey(boolean trap)

By default, KLineEdit 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 = true to make KLineEdit stop these events. The signals will still be emitted of course.

See Also:

trapReturnKey()

trapReturnKey

public boolean trapReturnKey()

Returns:

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

See Also:

setTrapReturnKey(boolean)

eventFilter

public boolean eventFilter(org.kde.qt.QObject arg1,
                           org.kde.qt.QEvent arg2)

Re-implemented for internal reasons. API not affected.

Overrides:

eventFilter in class org.kde.qt.QObject

completionBox

public KCompletionBox completionBox(boolean create)

Parameters:

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

Returns:

the completion-box, that is used in completion mode KGlobalSettings.CompletionPopup. This method will create a completion-box if none is there, yet.

completionBox

public KCompletionBox completionBox()

setCompletionObject

public void setCompletionObject(KCompletion arg1,
                                boolean hsig)

Reimplemented for internal reasons, the API is not affected.

Specified by:

setCompletionObject in interface KCompletionBaseInterface

setCompletionObject

public void setCompletionObject(KCompletion arg1)

Specified by:

setCompletionObject in interface KCompletionBaseInterface

copy

public void copy()

Reimplemented for internal reasons, the API is not affected.

Overrides:

copy in class org.kde.qt.QLineEdit

setEnableSqueezedText

public void setEnableSqueezedText(boolean enable)

Enable text squeezing whenever the supplied text is too long. Only works for "read-only" mode. Note that once text squeezing is enabled, QLineEdit.text() and QLineEdit.displayText() return the squeezed text. If you want the original text, use originalText().

See Also:

QLineEdit

isSqueezedTextEnabled

public boolean isSqueezedTextEnabled()

Returns true if text squeezing is enabled. This is only valid when the widget is in read-only mode.

originalText

public java.lang.String originalText()

Returns the original text if text squeezing is enabled. If the widget is not in "read-only" mode, this function returns the same thing as QLineEdit.text().

See Also:

QLineEdit

setCompletionBox

public void setCompletionBox(KCompletionBox box)

Set the completion-box to be used in completion mode KGlobalSettings.CompletionPopup. This will do nothing if a completion-box already exists.

Parameters:

box - The KCompletionBox to set

setReadOnly

public void setReadOnly(boolean arg1)

Re-implemented for internal reasons. API not changed.

Overrides:

setReadOnly in class org.kde.qt.QLineEdit

rotateText

public void rotateText(int type)

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.

setCompletedText

public void setCompletedText(java.lang.String arg1)

See KCompletionBase.setCompletedText.

Specified by:

setCompletedText in interface KCompletionBaseInterface

setCompletedItems

public void setCompletedItems(java.lang.String[] items)

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

Specified by:

setCompletedItems in interface KCompletionBaseInterface

Parameters:

items - list of completion matches to be shown in the completion box.

setCompletedItems

public void setCompletedItems(java.lang.String[] items,
                              boolean autoSuggest)

Same as the above function except it allows you to temporarily turn off text completion in CompletionPopupAuto mode. TODO: Merge with above function in KDE 4. TODO: Does that make this or the above @deprecated ?

Parameters:

items - list of completion matches to be shown in the completion box.

autoSuggest - true if you want automatic text completion (suggestion) enabled.

clear

public void clear()

Reimplemented to workaround a buggy QLineEdit.clear() (changing the clipboard to the text we just had in the lineedit)

Overrides:

clear in class org.kde.qt.QLineEdit

setSqueezedText

public void setSqueezedText(java.lang.String text)

Squeezes text into the line edit. This can only be used with read-only line-edits.

setText

public void setText(java.lang.String arg1)

Re-implemented to enable text squeezing. API is not affected.

Overrides:

setText in class org.kde.qt.QLineEdit

resizeEvent

protected void resizeEvent(org.kde.qt.QResizeEvent arg1)

Re-implemented for internal reasons. API not affected. See QLineEdit.resizeEvent().

Overrides:

resizeEvent in class org.kde.qt.QLineEdit

keyPressEvent

protected void keyPressEvent(org.kde.qt.QKeyEvent arg1)

Re-implemented for internal reasons. API not affected. See QLineEdit.keyPressEvent().

Overrides:

keyPressEvent in class org.kde.qt.QLineEdit

mousePressEvent

protected void mousePressEvent(org.kde.qt.QMouseEvent arg1)

Re-implemented for internal reasons. API not affected. See QLineEdit.mousePressEvent().

Overrides:

mousePressEvent in class org.kde.qt.QLineEdit

mouseDoubleClickEvent

protected void mouseDoubleClickEvent(org.kde.qt.QMouseEvent arg1)

Re-implemented for internal reasons. API not affected. See QWidget.mouseDoubleClickEvent().

Overrides:

mouseDoubleClickEvent in class org.kde.qt.QLineEdit

contextMenuEvent

protected void contextMenuEvent(org.kde.qt.QContextMenuEvent arg1)

Re-implemented for internal reasons. API not affected. See QLineEdit.contextMenuEvent().

Overrides:

contextMenuEvent in class org.kde.qt.QLineEdit

createPopupMenu

protected org.kde.qt.QPopupMenu createPopupMenu()

Re-implemented for internal reasons. API not affected. See QLineEdit.createPopupMenu().

Overrides:

createPopupMenu in class org.kde.qt.QLineEdit

dropEvent

protected void dropEvent(org.kde.qt.QDropEvent arg1)

Re-implemented to handle URI drops. See QLineEdit.dropEvent().

Overrides:

dropEvent in class org.kde.qt.QLineEdit

setCompletedText

protected void setCompletedText(java.lang.String arg1,
                                boolean arg2)

setUserSelection

protected void setUserSelection(boolean userSelection)

Sets the widget in userSelection mode or in automatic completion selection mode. This changes the colors of selections.

create

protected void create(long arg1,
                      boolean initializeWindow,
                      boolean destroyOldWindow)

Reimplemented for internal reasons, the API is not affected.

Overrides:

create in class org.kde.qt.QWidget

create

protected void create(long arg1,
                      boolean initializeWindow)

Overrides:

create in class org.kde.qt.QWidget

create

protected void create(long arg1)

Overrides:

create in class org.kde.qt.QWidget

create

protected void create()

Overrides:

create in class org.kde.qt.QWidget

focusInEvent

protected void focusInEvent(org.kde.qt.QFocusEvent arg1)

Re-implemented for internal reasons. API not affected. See QLineEdit.focusInEvent().

Overrides:

focusInEvent in class org.kde.qt.QLineEdit

autoSuggest

protected boolean autoSuggest()

Whether in current state text should be auto-suggested

makeCompletion

protected void makeCompletion(java.lang.String arg1)

Completes the remaining text with a matching one from a given list.

userCancelled

protected void userCancelled(java.lang.String cancelText)

Resets the current displayed text. Call this function to revert a text completion if the user cancels the request. Mostly applies to popup completions.

finalize

protected void finalize()
                 throws java.lang.InternalError

Deletes the wrapped C++ instance

Overrides:

finalize in class org.kde.qt.QLineEdit

Throws:

java.lang.InternalError

dispose

public void dispose()

Delete the wrapped C++ instance ahead of finalize()

Overrides:

dispose in class org.kde.qt.QLineEdit

isDisposed

public boolean isDisposed()

Has the wrapped C++ instance been deleted?

Overrides:

isDisposed in class org.kde.qt.QLineEdit

completionObject

public KCompletion completionObject(boolean hsig)

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(boolean) and setHandleSignals(boolean) member functions. See also compObj().

Specified by:

completionObject in interface KCompletionBaseInterface

Parameters:

hsig - if true, handles completion signals internally.

Returns:

a pointer the completion object.

completionObject

public KCompletion completionObject()

Specified by:

completionObject in interface KCompletionBaseInterface

setHandleSignals

public void setHandleSignals(boolean handle)

Enables this object to handle completion and rotation events internally. This function simply assigns a booleanean 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.

Specified by:

setHandleSignals in interface KCompletionBaseInterface

Parameters:

handle - if true, handle completion & rotation internally.

isCompletionObjectAutoDeleted

public boolean isCompletionObjectAutoDeleted()

Returns true if the completion object is deleted upon this widget's destruction. See setCompletionObject() and enableCompletion() for details.

Specified by:

isCompletionObjectAutoDeleted in interface KCompletionBaseInterface

Returns:

true if the completion object will be deleted automatically

setAutoDeleteCompletionObject

public void setAutoDeleteCompletionObject(boolean 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.

Specified by:

setAutoDeleteCompletionObject in interface KCompletionBaseInterface

Parameters:

autoDelete - if true, delete completion object on destruction.

setEnableSignals

public void setEnableSignals(boolean 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.

Specified by:

setEnableSignals in interface KCompletionBaseInterface

Parameters:

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

handleSignals

public boolean handleSignals()

Returns true if the object handles the signals.

Specified by:

handleSignals in interface KCompletionBaseInterface

Returns:

true if this signals are handled internally.

emitSignals

public boolean emitSignals()

Returns true if the object emits the signals.

Specified by:

emitSignals in interface KCompletionBaseInterface

Returns:

true if signals are emitted

completionMode

public int completionMode()

Returns the current completion mode. The return values are of type KGlobalSettings.Completion. See setCompletionMode() for details.

Specified by:

completionMode in interface KCompletionBaseInterface

Returns:

the completion mode.

setKeyBinding

public boolean setKeyBinding(int item,
                             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.

Specified by:

setKeyBinding in interface KCompletionBaseInterface

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(int)

getKeyBinding

public KShortcut getKeyBinding(int item)

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.

Specified by:

getKeyBinding in interface KCompletionBaseInterface

Parameters:

item - the item to check

Returns:

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

See Also:

setKeyBinding(int, org.kde.koala.KShortcut)

useGlobalKeyBindings

public void 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.

Specified by:

useGlobalKeyBindings in interface KCompletionBaseInterface

compObj

public KCompletion compObj()

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!!

Specified by:

compObj in interface KCompletionBaseInterface

Returns:

the completion object or NULL if one does not exist.

setDelegate

protected void setDelegate(KCompletionBaseInterface delegate)

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

delegate

protected KCompletionBaseInterface delegate()

Returns the delegation object.

Returns:

the delegation object, or 0 if there is none

See Also:

setDelegate(org.kde.koala.KCompletionBaseInterface)