Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXDirList Class Reference

#include <FXDirList.h>

Inheritance diagram for FX::FXDirList:
FX::FXTreeList FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

Public Member Functions

 FXDirList (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
virtual void create ()
 
virtual void detach ()
 
virtual void destroy ()
 
void scan (FXbool force=TRUE)
 
FXbool isItemDirectory (const FXTreeItem *item) const
 
FXbool isItemFile (const FXTreeItem *item) const
 
FXbool isItemExecutable (const FXTreeItem *item) const
 
virtual FXbool collapseTree (FXTreeItem *tree, FXbool notify=FALSE)
 
virtual FXbool expandTree (FXTreeItem *tree, FXbool notify=FALSE)
 
void setCurrentFile (const FXString &file, FXbool notify=FALSE)
 
FXString getCurrentFile () const
 
void setDirectory (const FXString &path, FXbool notify=FALSE)
 
FXString getDirectory () const
 
FXString getItemPathname (const FXTreeItem *item) const
 
FXTreeItemgetPathnameItem (const FXString &path)
 
void setPattern (const FXString &ptrn)
 
FXString getPattern () const
 
FXuint getMatchMode () const
 
void setMatchMode (FXuint mode)
 
FXbool showFiles () const
 
void showFiles (FXbool showing)
 
FXbool showHiddenFiles () const
 
void showHiddenFiles (FXbool showing)
 
void setAssociations (FXFileDict *assoc)
 
FXFileDictgetAssociations () const
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXDirList ()
 
- Public Member Functions inherited from FX::FXTreeList
 FXTreeList (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=TREELIST_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
virtual void layout ()
 
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
virtual FXint getContentWidth ()
 
virtual FXint getContentHeight ()
 
virtual void recalc ()
 
virtual bool canFocus () const
 
virtual void setFocus ()
 
virtual void killFocus ()
 
FXint getNumItems () const
 
FXint getNumVisible () const
 
void setNumVisible (FXint nvis)
 
FXTreeItemgetFirstItem () const
 
FXTreeItemgetLastItem () const
 
FXint fillItems (FXTreeItem *father, const FXchar **strings, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXint fillItems (FXTreeItem *father, const FXString &strings, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeIteminsertItem (FXTreeItem *other, FXTreeItem *father, FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeIteminsertItem (FXTreeItem *other, FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeItemappendItem (FXTreeItem *father, FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeItemappendItem (FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeItemprependItem (FXTreeItem *father, FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeItemprependItem (FXTreeItem *father, const FXString &text, FXIcon *oi=NULL, FXIcon *ci=NULL, void *ptr=NULL, FXbool notify=FALSE)
 
FXTreeItemmoveItem (FXTreeItem *other, FXTreeItem *father, FXTreeItem *item)
 
FXTreeItemextractItem (FXTreeItem *item, FXbool notify=FALSE)
 
void removeItem (FXTreeItem *item, FXbool notify=FALSE)
 
void removeItems (FXTreeItem *fm, FXTreeItem *to, FXbool notify=FALSE)
 
void clearItems (FXbool notify=FALSE)
 
FXint getItemWidth (const FXTreeItem *item) const
 
FXint getItemHeight (const FXTreeItem *item) const
 
virtual FXTreeItemgetItemAt (FXint x, FXint y) const
 
FXTreeItemfindItem (const FXString &name, FXTreeItem *start=NULL, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
 
FXTreeItemfindItemByData (const void *ptr, FXTreeItem *start=NULL, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const
 
virtual void makeItemVisible (FXTreeItem *item)
 
void setItemText (FXTreeItem *item, const FXString &text)
 
FXString getItemText (const FXTreeItem *item) const
 
void setItemOpenIcon (FXTreeItem *item, FXIcon *icon, FXbool owned=FALSE)
 
FXIcongetItemOpenIcon (const FXTreeItem *item) const
 
void setItemClosedIcon (FXTreeItem *item, FXIcon *icon, FXbool owned=FALSE)
 
FXIcongetItemClosedIcon (const FXTreeItem *item) const
 
void setItemData (FXTreeItem *item, void *ptr) const
 
void * getItemData (const FXTreeItem *item) const
 
FXbool isItemSelected (const FXTreeItem *item) const
 
FXbool isItemCurrent (const FXTreeItem *item) const
 
FXbool isItemVisible (const FXTreeItem *item) const
 
FXbool isItemOpened (const FXTreeItem *item) const
 
FXbool isItemExpanded (const FXTreeItem *item) const
 
FXbool isItemLeaf (const FXTreeItem *item) const
 
FXbool isItemEnabled (const FXTreeItem *item) const
 
FXint hitItem (const FXTreeItem *item, FXint x, FXint y) const
 
void updateItem (FXTreeItem *item) const
 
virtual FXbool enableItem (FXTreeItem *item)
 
virtual FXbool disableItem (FXTreeItem *item)
 
virtual FXbool selectItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool deselectItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool toggleItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool extendSelection (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool killSelection (FXbool notify=FALSE)
 
virtual FXbool openItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual FXbool closeItem (FXTreeItem *item, FXbool notify=FALSE)
 
virtual void setCurrentItem (FXTreeItem *item, FXbool notify=FALSE)
 
FXTreeItemgetCurrentItem () const
 
void setAnchorItem (FXTreeItem *item)
 
FXTreeItemgetAnchorItem () const
 
FXTreeItemgetCursorItem () const
 
void sortItems ()
 
void sortRootItems ()
 
void sortChildItems (FXTreeItem *item)
 
FXTreeListSortFunc getSortFunc () const
 
void setSortFunc (FXTreeListSortFunc func)
 
void setFont (FXFont *fnt)
 
FXFontgetFont () const
 
void setIndent (FXint in)
 
FXint getIndent () const
 
FXColor getTextColor () const
 
void setTextColor (FXColor clr)
 
FXColor getSelBackColor () const
 
void setSelBackColor (FXColor clr)
 
FXColor getSelTextColor () const
 
void setSelTextColor (FXColor clr)
 
FXColor getLineColor () const
 
void setLineColor (FXColor clr)
 
FXuint getListStyle () const
 
void setListStyle (FXuint style)
 
void setHelpText (const FXString &text)
 
const FXStringgetHelpText () const
 
virtual ~FXTreeList ()
 
- Public Member Functions inherited from FX::FXScrollArea
virtual FXint getViewportHeight ()
 
virtual FXint getViewportWidth ()
 
void setScrollStyle (FXuint style)
 
FXuint getScrollStyle () const
 
FXbool isHorizontalScrollable () const
 
FXbool isVerticalScrollable () const
 
FXScrollBarhorizontalScrollBar () const
 
FXScrollBarverticalScrollBar () const
 
FXint getXPosition () const
 
FXint getYPosition () const
 
void setPosition (FXint x, FXint y)
 
void getPosition (FXint &x, FXint &y) const
 
virtual ~FXScrollArea ()
 
- Public Member Functions inherited from FX::FXComposite
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXint maxChildWidth () const
 
FXint maxChildHeight () const
 
virtual bool isComposite () const
 
virtual ~FXComposite ()
 
- Public Member Functions inherited from FX::FXWindow
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXWindowgetParent () const
 
FXWindowgetOwner () const
 
FXWindowgetShell () const
 
FXWindowgetRoot () const
 
FXWindowgetNext () const
 
FXWindowgetPrev () const
 
FXWindowgetFirst () const
 
FXWindowgetLast () const
 
FXWindowgetFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObjectgetTarget () const
 
void setSelector (FXSelector sel)
 
FXSelector getSelector () const
 
FXint getX () const
 
FXint getY () const
 
virtual FXint getWidthForHeight (FXint givenheight)
 
virtual FXint getHeightForWidth (FXint givenwidth)
 
void setX (FXint x)
 
void setY (FXint y)
 
void setWidth (FXint w)
 
void setHeight (FXint h)
 
void setLayoutHints (FXuint lout)
 
FXuint getLayoutHints () const
 
FXAccelTablegetAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXStringgetHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindowgetChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindowchildAtIndex (FXint index) const
 
FXComposeContextgetComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursorgetDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursorgetDragCursor () const
 
FXint getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 
FXint setCursorPosition (FXint x, FXint y)
 
bool isEnabled () const
 
bool isActive () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
virtual void changeFocus (FXWindow *child)
 
virtual void setDefault (FXbool enable=TRUE)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void enable ()
 
virtual void disable ()
 
virtual void attach (FXID w)
 
virtual void setShape (const FXRegion &region)
 
virtual void setShape (FXBitmap *bitmap)
 
virtual void setShape (FXIcon *icon)
 
virtual void clearShape ()
 
virtual void raise ()
 
virtual void lower ()
 
virtual void move (FXint x, FXint y)
 
virtual void resize (FXint w, FXint h)
 
virtual void position (FXint x, FXint y, FXint w, FXint h)
 
void forceRefresh ()
 
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 
void update (FXint x, FXint y, FXint w, FXint h) const
 
void update () const
 
void repaint (FXint x, FXint y, FXint w, FXint h) const
 
void repaint () const
 
void grab ()
 
void ungrab ()
 
bool grabbed () const
 
void grabKeyboard ()
 
void ungrabKeyboard ()
 
bool grabbedKeyboard () const
 
virtual void show ()
 
virtual void hide ()
 
bool shown () const
 
bool underCursor () const
 
bool hasSelection () const
 
bool acquireSelection (const FXDragType *types, FXuint numtypes)
 
bool releaseSelection ()
 
bool hasClipboard () const
 
bool acquireClipboard (const FXDragType *types, FXuint numtypes)
 
bool releaseClipboard ()
 
virtual void dropEnable ()
 
virtual void dropDisable ()
 
bool isDropEnabled () const
 
bool isDragging () const
 
bool beginDrag (const FXDragType *types, FXuint numtypes)
 
bool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 
FXDragAction endDrag (bool drop=true)
 
bool isDropTarget () const
 
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
 
void clearDragRectangle () const
 
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 
FXDragAction didAccept () const
 
void dropFinished (FXDragAction action=DRAG_REJECT) const
 
bool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 
bool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 
FXDragAction inquireDNDAction () const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 
virtual bool contains (FXint parentx, FXint parenty) const
 
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 
virtual void setBackColor (FXColor clr)
 
FXColor getBackColor () const
 
virtual bool doesSaveUnder () const
 
virtual const FXchartr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisualgetVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXAppgetApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Static Public Member Functions

static FXint ascending (const FXTreeItem *a, const FXTreeItem *b)
 
static FXint descending (const FXTreeItem *a, const FXTreeItem *b)
 
static FXint ascendingCase (const FXTreeItem *a, const FXTreeItem *b)
 
static FXint descendingCase (const FXTreeItem *a, const FXTreeItem *b)
 
- Static Public Member Functions inherited from FX::FXTreeList
static FXint ascending (const FXTreeItem *, const FXTreeItem *)
 
static FXint descending (const FXTreeItem *, const FXTreeItem *)
 
static FXint ascendingCase (const FXTreeItem *, const FXTreeItem *)
 
static FXint descendingCase (const FXTreeItem *, const FXTreeItem *)
 
- Static Public Member Functions inherited from FX::FXWindow
static FXWindowcommonAncestor (FXWindow *a, FXWindow *b)
 
static bool before (const FXWindow *a, const FXWindow *b)
 
static bool after (const FXWindow *a, const FXWindow *b)
 

Additional Inherited Members

- Public Types inherited from FX::FXWindow
enum  {
  ID_NONE,
  ID_HIDE,
  ID_SHOW,
  ID_TOGGLESHOWN,
  ID_LOWER,
  ID_RAISE,
  ID_DELETE,
  ID_DISABLE,
  ID_ENABLE,
  ID_TOGGLEENABLED,
  ID_UNCHECK,
  ID_CHECK,
  ID_UNKNOWN,
  ID_UPDATE,
  ID_AUTOSCROLL,
  ID_TIPTIMER,
  ID_HSCROLLED,
  ID_VSCROLLED,
  ID_SETVALUE,
  ID_SETINTVALUE,
  ID_SETREALVALUE,
  ID_SETSTRINGVALUE,
  ID_SETICONVALUE,
  ID_SETINTRANGE,
  ID_SETREALRANGE,
  ID_GETINTVALUE,
  ID_GETREALVALUE,
  ID_GETSTRINGVALUE,
  ID_GETICONVALUE,
  ID_GETINTRANGE,
  ID_GETREALRANGE,
  ID_SETHELPSTRING,
  ID_GETHELPSTRING,
  ID_SETTIPSTRING,
  ID_GETTIPSTRING,
  ID_QUERY_MENU,
  ID_HOTKEY,
  ID_ACCEL,
  ID_UNPOST,
  ID_POST,
  ID_MDI_TILEHORIZONTAL,
  ID_MDI_TILEVERTICAL,
  ID_MDI_CASCADE,
  ID_MDI_MAXIMIZE,
  ID_MDI_MINIMIZE,
  ID_MDI_RESTORE,
  ID_MDI_CLOSE,
  ID_MDI_WINDOW,
  ID_MDI_MENUWINDOW,
  ID_MDI_MENUMINIMIZE,
  ID_MDI_MENURESTORE,
  ID_MDI_MENUCLOSE,
  ID_MDI_NEXT,
  ID_MDI_PREV,
  ID_LAST
}
 
- Static Public Attributes inherited from FX::FXWindow
static FXDragType octetType
 
static FXDragType deleteType
 
static FXDragType textType
 
static FXDragType utf8Type
 
static FXDragType utf16Type
 
static FXDragType colorType
 
static FXDragType urilistType
 
static const FXDragType stringType
 
static const FXDragType imageType
 
static const FXchar octetTypeName []
 
static const FXchar deleteTypeName []
 
static const FXchar textTypeName []
 
static const FXchar colorTypeName []
 
static const FXchar urilistTypeName []
 
static const FXchar utf8TypeName []
 
static const FXchar utf16TypeName []
 

Detailed Description

A Directory List widget provides a tree-structured view of the file system.

It automatically updates itself periodically by re-scanning the file system for any changes. As it scans the displayed directories and files, it automatically determines the icons to be displayed by consulting the file-associations registry settings. A number of messages can be sent to the Directory List to control the filter pattern, sorting order, case sensitivity, and hidden file display mode. The Directory list widget supports drags and drops of files.

See also:

Constructor & Destructor Documentation

FX::FXDirList::FXDirList ( FXComposite p,
FXObject tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = 0,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0 
)

Construct a directory list.

virtual FX::FXDirList::~FXDirList ( )
virtual

Destructor.

Member Function Documentation

static FXint FX::FXDirList::ascending ( const FXTreeItem a,
const FXTreeItem b 
)
static
static FXint FX::FXDirList::descending ( const FXTreeItem a,
const FXTreeItem b 
)
static
static FXint FX::FXDirList::ascendingCase ( const FXTreeItem a,
const FXTreeItem b 
)
static
static FXint FX::FXDirList::descendingCase ( const FXTreeItem a,
const FXTreeItem b 
)
static
virtual void FX::FXDirList::create ( )
virtual

Create server-side resources.

Reimplemented from FX::FXTreeList.

virtual void FX::FXDirList::detach ( )
virtual

Detach server-side resources.

Reimplemented from FX::FXTreeList.

virtual void FX::FXDirList::destroy ( )
virtual

Destroy server-side resources.

Reimplemented from FX::FXComposite.

void FX::FXDirList::scan ( FXbool  force = TRUE)

Scan the directories and update the items if needed, or if force is TRUE.

FXbool FX::FXDirList::isItemDirectory ( const FXTreeItem item) const

Return TRUE if item is a directory.

FXbool FX::FXDirList::isItemFile ( const FXTreeItem item) const

Return TRUE if item is a file.

FXbool FX::FXDirList::isItemExecutable ( const FXTreeItem item) const

Return TRUE if item is executable.

virtual FXbool FX::FXDirList::collapseTree ( FXTreeItem tree,
FXbool  notify = FALSE 
)
virtual

Collapse tree.

Reimplemented from FX::FXTreeList.

virtual FXbool FX::FXDirList::expandTree ( FXTreeItem tree,
FXbool  notify = FALSE 
)
virtual

Expand tree.

Reimplemented from FX::FXTreeList.

void FX::FXDirList::setCurrentFile ( const FXString file,
FXbool  notify = FALSE 
)

Set current file.

FXString FX::FXDirList::getCurrentFile ( ) const

Return current file.

void FX::FXDirList::setDirectory ( const FXString path,
FXbool  notify = FALSE 
)

Set current directory.

FXString FX::FXDirList::getDirectory ( ) const

Return current directory.

FXString FX::FXDirList::getItemPathname ( const FXTreeItem item) const

Return absolute pathname of item.

FXTreeItem* FX::FXDirList::getPathnameItem ( const FXString path)

Return the item from the absolute pathname.

void FX::FXDirList::setPattern ( const FXString ptrn)

Change wildcard matching pattern.

FXString FX::FXDirList::getPattern ( ) const
inline

Return wildcard pattern.

FXuint FX::FXDirList::getMatchMode ( ) const
inline

Return wildcard matching mode.

void FX::FXDirList::setMatchMode ( FXuint  mode)

Change wildcard matching mode.

FXbool FX::FXDirList::showFiles ( ) const

Return TRUE if showing files as well as directories.

void FX::FXDirList::showFiles ( FXbool  showing)

Show or hide normal files.

FXbool FX::FXDirList::showHiddenFiles ( ) const

Return TRUE if showing hidden files and directories.

void FX::FXDirList::showHiddenFiles ( FXbool  showing)

Show or hide hidden files and directories.

void FX::FXDirList::setAssociations ( FXFileDict assoc)

Change file associations.

FXFileDict* FX::FXDirList::getAssociations ( ) const
inline

Return file associations.

virtual void FX::FXDirList::save ( FXStream store) const
virtual

Save to stream.

Reimplemented from FX::FXTreeList.

virtual void FX::FXDirList::load ( FXStream store)
virtual

Load from stream.

Reimplemented from FX::FXTreeList.

Copyright © 1997-2005 Jeroen van der Zijp