org.kde.koala
Class KDirLister

java.lang.Object
  extended by org.kde.qt.Qt
      extended by org.kde.qt.QObject
          extended by org.kde.koala.KDirLister
All Implemented Interfaces:
org.kde.qt.QtSupport
Direct Known Subclasses:
KFileTreeBranch

public class KDirLister
extends org.kde.qt.QObject

The dir lister deals with the kiojob used to list and update a directory and has signals for the user of this class (e.g. konqueror view or kdesktop) to create/destroy its items when asked. This class is independent from the graphical representation of the dir (icon container, tree view, ...) and it stores the items (as KFileItems). Typical usage :

  • Create an instance.
  • Connect to at least update, clear, newItem, and deleteItem.
  • Call openURL - the signals will be called.
  • Reuse the instance when opening a new url (openURL).
  • Destroy the instance when not needed anymore (usually destructor).
  • Advanced usage : call openURL with _keep = true to list directories without forgetting the ones previously read (e.g. for a tree view) See KDirListerSignals for signals emitted by KDirLister

    Author:
    Michael Brade

    Field Summary
    static int AllItems
              Used by items() and itemsForDir() to specify whether you want all items for a directory or just the filtered ones.
    static int DIR_ONLY_MODE
               
    static int DOT_FILES
               
    static int FilteredItems
               
    static int MIME_FILTER
               
    static int NAME_FILTER
               
    static int NONE
               
     
    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
      KDirLister()
               
      KDirLister(boolean _delayedMimeTypes)
              Create a directory lister.
    protected KDirLister(java.lang.Class dummy)
               
     
    Method Summary
     boolean autoErrorHandlingEnabled()
              Check whether auto error handling is enabled.
     boolean autoUpdate()
              Checks whether KDirWatch will automatically update directories.
     java.lang.String className()
               
     void clearMimeFilter()
              Clears the mime based filter.
     java.util.ArrayList directories()
              Returns all URLs that are listed by this KDirLister.
     boolean dirOnlyMode()
              Checks whether the KDirLister only lists directories or all files.
     void dispose()
              Delete the wrapped C++ instance ahead of finalize()
    protected  boolean doMimeExcludeFilter(java.lang.String mimeExclude, java.lang.String[] filters)
               
    protected  boolean doMimeFilter(java.lang.String mime, java.lang.String[] filters)
              Called by the public matchesMimeFilter() to do the actual filtering.
     void emitChanges()
              Actually emit the changes made with setShowingDotFiles, setDirOnlyMode, setNameFilter and setMimeFilter.
    protected  void finalize()
              Deletes the wrapped C++ instance
     KFileItem find(KURL _url)
               
     KFileItem findByName(java.lang.String name)
              Find an item by its name.
     KFileItem findByURL(KURL _url)
              Find an item by its URL.
    protected  void handleError(Job arg1)
              Reimplement to customize error handling @short Reimplement to customize error handling
     boolean isDisposed()
              Has the wrapped C++ instance been deleted?
     boolean isFinished()
              Returns true if no io operation is currently in progress.
     java.util.ArrayList items()
               
     java.util.ArrayList items(int which)
              Returns the items listed for the current url().
     java.util.ArrayList itemsForDir(KURL dir)
               
     java.util.ArrayList itemsForDir(KURL dir, int which)
              Returns the items listed for the given dir. This method will NOT start listing dir, you should only call this when receiving the finished() signal.
     org.kde.qt.QWidget mainWindow()
              Returns the main window associated with this object.
    protected  boolean matchesFilter(KFileItem arg1)
              Called for every new item before emitting newItems().
     boolean matchesFilter(java.lang.String name)
              Checks whether name matches a filter in the list of name filters.
    protected  boolean matchesMimeFilter(KFileItem arg1)
              Called for every new item before emitting newItems().
     boolean matchesMimeFilter(java.lang.String mime)
              Checks whether mime matches a filter in the list of mime types
     org.kde.qt.QMetaObject metaObject()
               
     java.util.ArrayList mimeFilters()
              Returns the list of mime based filters, as set via setMimeFilter().
     java.lang.String nameFilter()
              Returns the current name filter, as set via setNameFilter()
     boolean openURL(KURL _url)
               
     boolean openURL(KURL _url, boolean _keep)
               
     boolean openURL(KURL _url, boolean _keep, boolean _reload)
              Run the directory lister on the given url.
     KFileItem rootItem()
              Returns the file item of the URL.
     void setAutoErrorHandlingEnabled(boolean enable, org.kde.qt.QWidget parent)
              Enable or disable auto error handling is enabled.
     void setAutoUpdate(boolean enable)
              Enable/disable automatic directory updating, when a directory changes (using KDirWatch).
     void setDirOnlyMode(boolean dirsOnly)
              Call this to list only directories.
     void setMainWindow(org.kde.qt.QWidget window)
              Pass the main window this object is associated with this is used for caching authentication data
     void setMimeExcludeFilter(java.lang.String[] mimeList)
              Filtering should be done with KFileFilter.
     void setMimeFilter(java.lang.String[] mimeList)
              Set mime-based filter to only list items matching the given mimetypes.
     void setNameFilter(java.lang.String filter)
              Set a name filter to only list items matching this name, e.g.
     void setShowingDotFiles(boolean _showDotFiles)
              Changes the "is viewing dot files" setting.
     boolean showingDotFiles()
              Checks whether hidden files (files beginning with a dot) will be shown.
     void stop()
              Stop listing all directories currently being listed.
     void stop(KURL _url)
              Stop listing the given directory.
     void updateDirectory(KURL _dir)
              Update the directory _dir. This method causes KDirLister to _only_ emit the items of _dir that actually changed compared to the current state in the cache and updates the cache.
     KURL url()
              Returns the top level URL that is listed by this KDirLister.
    protected  boolean validURL(KURL arg1)
              Checks if an url is malformed or not and displays an error message if it is and autoErrorHandling is set to true.
     
    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, event, eventFilter, highPriority, i18n, inherits, insertChild, installEventFilter, isA, isWidgetType, killTimer, killTimers, name, name, normalizeSignalSlot, objectTrees, parent, property, queryList, queryList, queryList, queryList, queryList, registerUserData, removeChild, removeEventFilter, sender, setName, setProperty, signalsBlocked, startTimer, timerEvent, tr, tr
     
    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
     

    Field Detail

    AllItems

    public static final int AllItems
    Used by items() and itemsForDir() to specify whether you want all items for a directory or just the filtered ones.

    See Also:
    Constant Field Values

    FilteredItems

    public static final int FilteredItems
    See Also:
    Constant Field Values

    NONE

    public static final int NONE
    See Also:
    Constant Field Values

    NAME_FILTER

    public static final int NAME_FILTER
    See Also:
    Constant Field Values

    MIME_FILTER

    public static final int MIME_FILTER
    See Also:
    Constant Field Values

    DOT_FILES

    public static final int DOT_FILES
    See Also:
    Constant Field Values

    DIR_ONLY_MODE

    public static final int DIR_ONLY_MODE
    See Also:
    Constant Field Values
    Constructor Detail

    KDirLister

    protected KDirLister(java.lang.Class dummy)

    KDirLister

    public KDirLister(boolean _delayedMimeTypes)
    Create a directory lister.

    Parameters:
    _delayedMimeTypes - if true, mime types will be fetched on demand. If false, they will always be fetched immediately

    KDirLister

    public KDirLister()
    Method Detail

    metaObject

    public org.kde.qt.QMetaObject metaObject()
    Overrides:
    metaObject in class org.kde.qt.QObject

    className

    public java.lang.String className()
    Overrides:
    className in class org.kde.qt.QObject

    openURL

    public boolean openURL(KURL _url,
                           boolean _keep,
                           boolean _reload)
    Run the directory lister on the given url. This method causes KDirLister to emit _all_ the items of _url, in any case. Depending on _keep either clear() or clear(KURL) will be emitted first. The newItems() signal may be emitted more than once to supply you with KFileItems, up until the signal completed() is emitted (and isFinished() returns true).

    Parameters:
    _url - the directory URL.
    _keep - if true the previous directories aren't forgotten (they are still watched by kdirwatch and their items are kept for this KDirLister). This is useful for e.g. a treeview.
    _reload - indicates wether to use the cache (false) or to reread the directory from the disk. Use only when opening a dir not yet listed by this lister without using the cache. Otherwise use updateDirectory.
    Returns:
    true if successful, false otherwise (e.g. invalid _url)

    openURL

    public boolean openURL(KURL _url,
                           boolean _keep)

    openURL

    public boolean openURL(KURL _url)

    stop

    public void stop()
    Stop listing all directories currently being listed. Emits canceled() if there was at least one job running. Emits canceled( KURL ) for each stopped job if there are at least two dirctories being watched by KDirLister.


    stop

    public void stop(KURL _url)
    Stop listing the given directory. Emits canceled() if the killed job was the last running one. Emits canceled( KURL ) for the killed job if there are at least two directories being watched by KDirLister. No signal is emitted if there was no job running for _url.

    Parameters:
    _url - the directory URL

    autoUpdate

    public boolean autoUpdate()
    Checks whether KDirWatch will automatically update directories. This is enabled by default.

    Returns:
    true if KDirWatch is used to automatically update directories.

    setAutoUpdate

    public void setAutoUpdate(boolean enable)
    Enable/disable automatic directory updating, when a directory changes (using KDirWatch).

    Parameters:
    enable - true to enable, false to disable

    autoErrorHandlingEnabled

    public boolean autoErrorHandlingEnabled()
    Check whether auto error handling is enabled. If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default.

    Returns:
    true if auto error handling is enabled, false otherwise
    See Also:
    setAutoErrorHandlingEnabled(boolean, org.kde.qt.QWidget)

    setAutoErrorHandlingEnabled

    public void setAutoErrorHandlingEnabled(boolean enable,
                                            org.kde.qt.QWidget parent)
    Enable or disable auto error handling is enabled. If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default.

    Parameters:
    enable - true to enable auto error handling, false to disable
    parent - the parent widget for the error dialogs, can be 0 for top-level
    See Also:
    autoErrorHandlingEnabled()

    showingDotFiles

    public boolean showingDotFiles()
    Checks whether hidden files (files beginning with a dot) will be shown. By default this option is disabled (hidden files will be not shown).

    Returns:
    true if dot files are shown, false otherwise
    See Also:
    setShowingDotFiles(boolean)

    setShowingDotFiles

    public void setShowingDotFiles(boolean _showDotFiles)
    Changes the "is viewing dot files" setting. Calls updateDirectory() if setting changed. By default this option is disabled (hidden files will not be shown).

    Parameters:
    _showDotFiles - true to enable showing hidden files, false to disable
    See Also:
    showingDotFiles()

    dirOnlyMode

    public boolean dirOnlyMode()
    Checks whether the KDirLister only lists directories or all files. By default this option is disabled (all files will be shown).

    Returns:
    true if setDirOnlyMode(true) was called

    setDirOnlyMode

    public void setDirOnlyMode(boolean dirsOnly)
    Call this to list only directories. By default this option is disabled (all files will be shown).

    Parameters:
    dirsOnly - true to list only directories

    url

    public KURL url()
    Returns the top level URL that is listed by this KDirLister. It might be different from the one given with openURL() if there was a redirection. If you called openURL() with _keep == true this is the first url opened (e.g. in a treeview this is the root).

    Returns:
    the url used by this instance to list the files.

    directories

    public java.util.ArrayList directories()
    Returns all URLs that are listed by this KDirLister. This is only useful if you called openURL() with _keep == true, as it happens in a treeview, for example. (Note that the base url is included in the list as well, of course.)

    Returns:
    the list of all listed URLs

    emitChanges

    public void emitChanges()
    Actually emit the changes made with setShowingDotFiles, setDirOnlyMode, setNameFilter and setMimeFilter.


    updateDirectory

    public void updateDirectory(KURL _dir)
    Update the directory _dir. This method causes KDirLister to _only_ emit the items of _dir that actually changed compared to the current state in the cache and updates the cache. The current implementation calls updateDirectory automatically for local files, using KDirWatch (if autoUpdate() is true), but it might be useful to force an update manually.

    Parameters:
    _dir - the directory URL

    isFinished

    public boolean isFinished()
    Returns true if no io operation is currently in progress.

    Returns:
    true if finished, false otherwise

    rootItem

    public KFileItem rootItem()
    Returns the file item of the URL.

    Returns:
    the file item for url() itself (".")

    findByURL

    public KFileItem findByURL(KURL _url)
    Find an item by its URL.

    Parameters:
    _url - the item URL
    Returns:
    the pointer to the KFileItem

    find

    public KFileItem find(KURL _url)

    findByName

    public KFileItem findByName(java.lang.String name)
    Find an item by its name.

    Parameters:
    name - the item name
    Returns:
    the pointer to the KFileItem

    setNameFilter

    public void setNameFilter(java.lang.String filter)
    Set a name filter to only list items matching this name, e.g. "*.cpp". You can set more than one filter by separating them with whitespace, e.g "*.cpp .h". Note: the direcory is not automatically reloaded.

    Parameters:
    filter - the new filter, null to disable filtering
    See Also:
    matchesFilter(java.lang.String)

    nameFilter

    public java.lang.String nameFilter()
    Returns the current name filter, as set via setNameFilter()

    Returns:
    the current name filter, can be null if filtering is turned off

    setMimeFilter

    public void setMimeFilter(java.lang.String[] mimeList)
    Set mime-based filter to only list items matching the given mimetypes. NOTE: setting the filter does not automatically reload direcory. Also calling this function will not affect any named filter already set.

    Parameters:
    mimeList - a list of mime-types.
    See Also:
    clearMimeFilter(), matchesMimeFilter(java.lang.String)

    setMimeExcludeFilter

    public void setMimeExcludeFilter(java.lang.String[] mimeList)
    Filtering should be done with KFileFilter. This will be implemented in a later revision of KDirLister. This method may be removed then. Set mime-based exclude filter to only list items not matching the given mimetypes NOTE: setting the filter does not automatically reload direcory. Also calling this function will not affect any named filter already set.

    Parameters:
    mimeList - a list of mime-types.
    See Also:
    clearMimeFilter(), matchesMimeFilter(java.lang.String)

    clearMimeFilter

    public void clearMimeFilter()
    Clears the mime based filter.

    See Also:
    setMimeFilter(java.lang.String[])

    mimeFilters

    public java.util.ArrayList mimeFilters()
    Returns the list of mime based filters, as set via setMimeFilter().

    Returns:
    the list of mime based filters. Empty, when no mime filter is set.

    matchesFilter

    public boolean matchesFilter(java.lang.String name)
    Checks whether name matches a filter in the list of name filters.

    Returns:
    true if name matches a filter in the list, otherwise false.
    See Also:
    setNameFilter(java.lang.String)

    matchesMimeFilter

    public boolean matchesMimeFilter(java.lang.String mime)
    Checks whether mime matches a filter in the list of mime types

    Parameters:
    mime - the mimetype to find in the filter list.
    Returns:
    true if name matches a filter in the list, otherwise false.
    See Also:
    #setMimeFilter#

    setMainWindow

    public void setMainWindow(org.kde.qt.QWidget window)
    Pass the main window this object is associated with this is used for caching authentication data

    Parameters:
    window - the window to associate with, 0 to disassociate

    mainWindow

    public org.kde.qt.QWidget mainWindow()
    Returns the main window associated with this object.

    Returns:
    the associated main window, or 0 if there is none

    items

    public java.util.ArrayList items(int which)
    Returns the items listed for the current url(). This method will NOT start listing a directory, you should only call this when receiving the finished() signal. The items in the KFileItemList are references to the items used by KDirLister, so e.g. an item gets destroyed when the deleteItem() signal is emitted.

    Parameters:
    which - specifies whether the returned list will contain all entries or only the ones that passed the nameFilter(), mimeFilter(), etc. Note that the latter causes iteration over all the items, filtering them. If this is too slow for you, use the newItems() signal, sending out filtered items in chunks.
    Returns:
    the items listed for the current url().

    items

    public java.util.ArrayList items()

    itemsForDir

    public java.util.ArrayList itemsForDir(KURL dir,
                                           int which)
    Returns the items listed for the given dir. This method will NOT start listing dir, you should only call this when receiving the finished() signal. The items in the KFileItemList are references to the items used by KDirLister, so e.g. an item gets destroyed when the deleteItem() signal is emitted.

    Parameters:
    dir - specifies the url for which the items should be returned. This is only useful if you use KDirLister with multiple URLs i.e. using boolean keep = true in openURL().
    which - specifies whether the returned list will contain all entries or only the ones that passed the nameFilter, mimeFilter, etc. Note that the latter causes iteration over all the items, filtering them. If this is too slow for you, use the newItems() signal, sending out filtered items in chunks.
    Returns:
    the items listed for dir.

    itemsForDir

    public java.util.ArrayList itemsForDir(KURL dir)

    matchesFilter

    protected boolean matchesFilter(KFileItem arg1)
    Called for every new item before emitting newItems(). You may reimplement this method in a subclass to implement your own filtering. The default implementation filters out ".." and everything not matching the name filter(s)

    Returns:
    true if the item is "ok". false if the item shall not be shown in a view, e.g. files not matching a pattern *.cpp ( KFileItem.isHidden())
    See Also:
    matchesFilter(java.lang.String), setNameFilter(java.lang.String)

    matchesMimeFilter

    protected boolean matchesMimeFilter(KFileItem arg1)
    Called for every new item before emitting newItems(). You may reimplement this method in a subclass to implement your own filtering. The default implementation filters out ".." and everything not matching the name filter(s)

    Returns:
    true if the item is "ok". false if the item shall not be shown in a view, e.g. files not matching a pattern *.cpp ( KFileItem.isHidden())
    See Also:
    matchesMimeFilter(java.lang.String), setMimeFilter(java.lang.String[])

    doMimeFilter

    protected boolean doMimeFilter(java.lang.String mime,
                                   java.lang.String[] filters)
    Called by the public matchesMimeFilter() to do the actual filtering. Those methods may be reimplemented to customize filtering.

    Parameters:
    mime - the mime type to filter
    filters - the list of mime types to filter

    doMimeExcludeFilter

    protected boolean doMimeExcludeFilter(java.lang.String mimeExclude,
                                          java.lang.String[] filters)

    validURL

    protected boolean validURL(KURL arg1)
    Checks if an url is malformed or not and displays an error message if it is and autoErrorHandling is set to true.

    Returns:
    true if url is valid, otherwise false.

    handleError

    protected void handleError(Job arg1)
    Reimplement to customize error handling @short Reimplement to customize error handling


    finalize

    protected void finalize()
                     throws java.lang.InternalError
    Deletes the wrapped C++ instance

    Overrides:
    finalize in class org.kde.qt.QObject
    Throws:
    java.lang.InternalError

    dispose

    public void dispose()
    Delete the wrapped C++ instance ahead of finalize()

    Overrides:
    dispose in class org.kde.qt.QObject

    isDisposed

    public boolean isDisposed()
    Has the wrapped C++ instance been deleted?

    Overrides:
    isDisposed in class org.kde.qt.QObject