org.kde.koala
Class KComboBox

java.lang.Object
  org.kde.qt.Qt
      org.kde.qt.QObject
          org.kde.qt.QWidget
              org.kde.qt.QComboBox
                  org.kde.koala.KComboBox

All Implemented Interfaces:

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

Direct Known Subclasses:

KFileFilterCombo, KFontCombo, KHistoryCombo, KURLComboBox

public class KComboBox
extends org.kde.qt.QComboBox
implements KCompletionBaseInterface

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 change the text completion mode on the fly. To support these new features KComboBox emits a few additional signals such as completion( String ) 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( String ) signals are emitted when the user presses the Enter/Return key. KCombobox by default creates a completion object when you invoke the completionObject( boolean ) member function for the first time or explicitly use setCompletionObject( KCompletion, boolean ) 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 KCompletionBase.setHandleSignals(boolean) or alternatively set the booleanean 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 QGuardedPtr. 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 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 KCompletionBox(true, this, "mywidget");
 KCompletion 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" );
 KCompletion comp = combo.completionObject();
 // Connect to the return pressed signal - optional
 connect(combo,SIGNAL("returnPressed(String)"),comp,SLOT("addItem(String)"));
 // Provide the to be completed strings. Note that those are separate from the combo's
 // contents.
 comp.insertItems( someArrayList );
 

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

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 );
 

See KComboBoxSignals for signals emitted by KComboBox

Author:

Dawit Alemayehu

Field Summary

Fields inherited from class org.kde.qt.QComboBox

AfterCurrent, AtBottom, AtCurrent, AtTop, BeforeCurrent, NoInsertion

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

	KComboBox()
	KComboBox(boolean rw)
	KComboBox(boolean rw, org.kde.qt.QWidget parent)
	KComboBox(boolean rw, org.kde.qt.QWidget parent, java.lang.String name) Constructs a "read-write" or "read-only" combo box depending on the value of the first argument( rw ) with a parent, a name.
protected	KComboBox(java.lang.Class dummy)
	KComboBox(org.kde.qt.QWidget parent)
	KComboBox(org.kde.qt.QWidget parent, java.lang.String name) Constructs a read-only or rather select-only combo box with a parent object and a name.

Method Summary

boolean	autoCompletion() Re-implemented from QComboBox.
void	changeURL(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.
void	changeURL(org.kde.qt.QPixmap pixmap, 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.
java.lang.String	className()
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.
boolean	contains(java.lang.String text) 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.
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.
int	cursorPosition() Returns the current cursor position.
protected KCompletionBaseInterface	delegate() Returns the delegation object.
void	dispose() Delete the wrapped C++ instance ahead of finalize()
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
KShortcut	getKeyBinding(int item) Returns the key-binding used for the specified item.
boolean	handleSignals() Returns true if the object handles the signals.
void	insertURL(KURL url)
void	insertURL(KURL url, int index) Inserts url at position index into the combobox.
void	insertURL(org.kde.qt.QPixmap pixmap, KURL url)
void	insertURL(org.kde.qt.QPixmap pixmap, KURL url, int index) Inserts url with the pixmap &p pixmap at position index into the combobox.
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	isURLDropsEnabled() Returns true when decoded URL drops are enabled
protected void	makeCompletion(java.lang.String arg1) Completes text according to the completion mode.
org.kde.qt.QMetaObject	metaObject()
void	rotateText(int type) Iterates through all possible matches of the completed text or the history list.
void	setAutoCompletion(boolean autocomplete) Re-implemented from QComboBox.
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	setCompletedText(java.lang.String arg1) Sets the completed text in the line-edit appropriately.
protected void	setCompletedText(java.lang.String arg1, boolean arg2)
void	setCompletionMode(int mode) Sets the type of completion to be used.
void	setCompletionObject(KCompletion compObj)
void	setCompletionObject(KCompletion compObj, boolean hsig) Sets up the completion object to be used.
void	setContextMenuEnabled(boolean showMenu) Enables or disable the popup (context) menu.
void	setCurrentItem(int index) Simply calls QComboBox' implementation.
void	setCurrentItem(java.lang.String item)
void	setCurrentItem(java.lang.String item, boolean insert)
void	setCurrentItem(java.lang.String item, boolean insert, int index) Selects the first item that matches item. If there is no such item, it is inserted at position index if insert is true.
protected void	setDelegate(KCompletionBaseInterface delegate) Sets or removes the delegation object.
void	setEditURL(KURL url) Sets url into the edit field of the combobox.
void	setEnableSignals(boolean enable) Sets the widget's ability to emit text completion and rotation signals.
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	setLineEdit(org.kde.qt.QLineEdit arg1) Re-implemented for internal reasons.
void	setTrapReturnKey(boolean 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.
void	setURLDropsEnabled(boolean enable) Enables/Disables handling of URL drops.
boolean	trapReturnKey()
void	useGlobalKeyBindings() Sets this object to use global values for key-bindings.
protected void	wheelEvent(org.kde.qt.QWheelEvent ev)

Methods inherited from class org.kde.qt.QComboBox

autoResize, changeItem, changeItem, changeItem, clear, clearEdit, clearValidator, count, currentItem, currentText, duplicatesEnabled, editable, focusInEvent, focusOutEvent, hide, insertionPolicy, insertItem, insertItem, insertItem, insertItem, insertItem, insertItem, insertStringList, insertStringList, insertStrList, insertStrList, insertStrList, keyPressEvent, lineEdit, listBox, maxCount, mouseDoubleClickEvent, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, paintEvent, pixmap, popup, removeItem, resizeEvent, setAutoResize, setCurrentText, setDuplicatesEnabled, setEditable, setEditText, setEnabled, setFont, setInsertionPolicy, setListBox, setMaxCount, setPalette, setSizeLimit, setValidator, sizeHint, sizeLimit, styleChange, text, tr, tr, updateMask, validator

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, contextMenuEvent, cursor, customWhatsThis, destroy, destroy, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, drawText, drawText, dropEvent, enabledChange, enterEvent, erase, erase, erase, erase, eraseColor, erasePixmap, event, 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, hideEvent, icon, iconify, iconText, imComposeEvent, imEndEvent, imStartEvent, 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, minimumSizeHint, 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, 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, visibleRect, width, windowActivationChange, 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

KComboBox

protected KComboBox(java.lang.Class dummy)

KComboBox

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

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

KComboBox

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

KComboBox

public KComboBox()

KComboBox

public KComboBox(boolean rw,
                 org.kde.qt.QWidget parent,
                 java.lang.String name)

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.

KComboBox

public KComboBox(boolean rw,
                 org.kde.qt.QWidget parent)

KComboBox

public KComboBox(boolean rw)

Method Detail

metaObject

public org.kde.qt.QMetaObject metaObject()

Overrides:

metaObject in class org.kde.qt.QComboBox

className

public java.lang.String className()

Overrides:

className in class org.kde.qt.QComboBox

setEditURL

public void setEditURL(KURL url)

Sets url into the edit field of the combobox. It uses KURL.prettyURL() so that the url is properly decoded for displaying.

insertURL

public void insertURL(KURL url,
                      int index)

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.

insertURL

public void insertURL(KURL url)

insertURL

public void insertURL(org.kde.qt.QPixmap pixmap,
                      KURL url,
                      int index)

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.

insertURL

public void insertURL(org.kde.qt.QPixmap pixmap,
                      KURL url)

changeURL

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

changeURL

public void changeURL(org.kde.qt.QPixmap pixmap,
                      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.

cursorPosition

public int cursorPosition()

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

Returns:

Current cursor position.

setAutoCompletion

public void setAutoCompletion(boolean autocomplete)

Re-implemented from QComboBox. 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().

Overrides:

setAutoCompletion in class org.kde.qt.QComboBox

Parameters:

autocomplete - Flag to enable/disable automatic completion mode.

autoCompletion

public boolean autoCompletion()

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

Overrides:

autoCompletion in class org.kde.qt.QComboBox

Returns:

true when completion mode is automatic.

setContextMenuEnabled

public void setContextMenuEnabled(boolean showMenu)

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.

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

contains

public boolean contains(java.lang.String text)

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.

setTrapReturnKey

public void setTrapReturnKey(boolean 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(boolean)

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

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 and KGlobalSettings.CompletionPopupAuto. This method will create a completion-box by calling KLineEdit.completionBox, if none is there, yet.

completionBox

public KCompletionBox completionBox()

setLineEdit

public void setLineEdit(org.kde.qt.QLineEdit arg1)

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.

Overrides:

setLineEdit in class org.kde.qt.QComboBox

rotateText

public void rotateText(int type)

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

setCompletedText

public void setCompletedText(java.lang.String arg1)

Sets the completed text in the line-edit appropriately. This function is an implementation for 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

setCurrentItem

public void setCurrentItem(java.lang.String item,
                           boolean insert,
                           int index)

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.

setCurrentItem

public void setCurrentItem(java.lang.String item,
                           boolean insert)

setCurrentItem

public void setCurrentItem(java.lang.String item)

setCurrentItem

public void setCurrentItem(int index)

Simply calls QComboBox' implementation. Only here to not become shadowed.

Overrides:

setCurrentItem in class org.kde.qt.QComboBox

setCompletedText

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

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

wheelEvent

protected void wheelEvent(org.kde.qt.QWheelEvent ev)

Overrides:

wheelEvent in class org.kde.qt.QComboBox

makeCompletion

protected void makeCompletion(java.lang.String arg1)

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.

finalize

protected void finalize()
                 throws java.lang.InternalError

Deletes the wrapped C++ instance

Overrides:

finalize in class org.kde.qt.QComboBox

Throws:

java.lang.InternalError

dispose

public void dispose()

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

Overrides:

dispose in class org.kde.qt.QComboBox

isDisposed

public boolean isDisposed()

Has the wrapped C++ instance been deleted?

Overrides:

isDisposed in class org.kde.qt.QComboBox

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

setCompletionObject

public void setCompletionObject(KCompletion compObj,
                                boolean hsig)

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(boolean) after calling this method. Be sure to set the boolean argument to false, if you want to handle the completion signals yourself.

Specified by:

setCompletionObject in interface KCompletionBaseInterface

Parameters:

compObj - a KCompletion() or a derived child object.

hsig - if true, handles completion signals internally.

setCompletionObject

public void setCompletionObject(KCompletion compObj)

Specified by:

setCompletionObject 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

setCompletionMode

public void setCompletionMode(int mode)

Sets the type of completion to be used. The completion modes supported are those defined in KGlobalSettings(). See below.

Specified by:

setCompletionMode in interface KCompletionBaseInterface

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.

@short Sets the type of completion to be used.

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)