# class KUrlComboBox

###

Module | kio
Namespace |
Class | KUrlComboBox
Inherits | KComboBox

This combobox shows a number of recent URLs/directories, as well as some default directories. It will manage the default dirs root-directory, home-directory and Desktop-directory, as well as a number of URLs set via setUrls() and one additional entry to be set via setUrl().

A combo box showing a number of recent URLs/directories Author Carsten Pfeiffer <pfeiffer@kde.org>

### enums

- Mode { Files, Directories, Both }
- OverLoadResolving { RemoveTop, RemoveBottom }

enum details

### methods

- KUrlComboBox (mode, parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  mode | KUrlComboBox.Mode |
  parent | QWidget | 0

  Constructs a KUrlComboBox.

  mode - is either Files, Directories or Both and controls the following behavior:

- Files all inserted URLs will be treated as files, therefore the
url shown in the combo will never show a trailing / the icon will be the one associated with the file's mimetype.
- Directories all inserted URLs will be treated as directories, will
have a trailing slash in the combobox. The current directory will show the "open folder" icon, other directories the "folder" icon.
- Both Don't mess with anything, just show the url as given.

parent - The parent object of this widget.

- KUrlComboBox (mode, rw, parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  mode | KUrlComboBox.Mode |
  rw | bool |
  parent | QWidget | 0

- KUrlComboBox (a0)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  a0 | KUrlComboBox |

- KUrlComboBox (a0, a1)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | KUrlComboBox.Mode |
  a1 | QWidget | 0

- addDefaultUrl (url, text)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |
  text | QString | QString()

  Adds a url that will always be shown in the combobox, it can't be "rotated away". Default urls won't be returned in urls() and don't have to be set via setUrls(). If you want to specify a special pixmap, use the overloaded method with the pixmap parameter. Default URLs will be inserted into the combobox by setDefaults()

- addDefaultUrl (url, icon, text)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |
  icon | QIcon |
  text | QString | QString()

  Adds a url that will always be shown in the combobox, it can't be "rotated away". Default urls won't be returned in urls() and don't have to be set via setUrls(). If you don't need to specify a pixmap, use the overloaded method without the pixmap parameter. Default URLs will be inserted into the combobox by setDefaults()

- maxItems ( )

  returns int

  Returns the maximum of items the combobox handles.

  See also setMaxItems

- mouseMoveEvent (event)

  returns Nothing
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  event | QMouseEvent |

- mousePressEvent (event)

  returns Nothing
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  event | QMouseEvent |

- removeUrl (url, checkDefaultURLs)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |
  checkDefaultURLs | bool | 1

  Removes any occurrence of url. If checkDefaultUrls is false default-urls won't be removed.

- setDefaults ( )

  returns Nothing

  Clears all items and inserts the default urls into the combo. Will be called implicitly upon the first call to setUrls() or setUrl()

  See also addDefaultUrl

- setMaxItems (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | int |

  Sets how many items should be handled and displayed by the combobox.

  See also maxItems

- setUrl (url)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Sets the current url. This combo handles exactly one url additionally to the default items and those set via setUrls(). So you can call setUrl() as often as you want, it will always replace the previous one set via setUrl(). If url is already in the combo, the last item will stay there and the existing item becomes the current item. The current item will always have the open-directory-pixmap as icon.

  Note that you won't receive any signals, e.g. textChanged(), returnPressed() or activated() upon calling this method.

- setUrls (urls)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  urls | QStringList |

  Inserts urls into the combobox below the "default urls" (see addDefaultUrl).

  If the list of urls contains more items than maxItems, the first items will be stripped.

- setUrls (urls, remove)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  urls | QStringList |
  remove | KUrlComboBox.OverLoadResolving |

  Inserts urls into the combobox below the "default urls" (see addDefaultUrl).

  If the list of urls contains more items than maxItems, the remove parameter determines whether the first or last items will be stripped.

- urlActivated (url)

  returns Nothing
  SIGNAL ("urlActivated (const KUrl&)")

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Emitted when an item was clicked at.

  url - is the url of the now current item. If it is a local url, it won't have a protocol (file:/), otherwise it will.

- urls ( )

  returns QStringList

  Returns a list of all urls currently handled. The list contains at most maxItems() items. Use this to save the list of urls in a config-file and reinsert them via setUrls() next time. Note that all default urls set via addDefaultUrl() are not returned, they will automatically be set via setUrls() or setUrl(). You will always get fully qualified urls, i.e. with protocol like file:/

### enums - detail

- Mode { Files, Directories, Both }

  This enum describes which kind of items is shown in the combo box.

  | Files | - -1 | - |
  | Directories | - 1 | - |
  | Both | - 0 | - |

- OverLoadResolving { RemoveTop, RemoveBottom }

  This Enumeration is used in setUrl() to determine which items will be removed when the given list is larger than maxItems().

- RemoveTop means that items will be removed from top
- RemoveBottom means, that items will be removed from the bottom

| RemoveTop | - | - |
| RemoveBottom | - | - |