FX::FXRecentFiles Class Reference

#include <FXRecentFiles.h>

Inheritance diagram for FX::FXRecentFiles:

Inheritance graph
[legend]

List of all members.


Detailed Description

The recent files object manages a most recently used (MRU) file list by means of the standard system registry. When connected to a widget, like a menu command, the recent files object updates the menu commands label to the associated recent file name; when the menu command is invoked, the recent file object sends its target a SEL_COMMAND message with the message data set to the associated file name, of the type const char*. When adding or removing file names, the recent files object automatically updates the system registry to record these changes.

Public Types

enum  {
  ID_CLEAR, ID_ANYFILES, ID_FILE_1, ID_FILE_2,
  ID_FILE_3, ID_FILE_4, ID_FILE_5, ID_FILE_6,
  ID_FILE_7, ID_FILE_8, ID_FILE_9, ID_FILE_10,
  ID_LAST
}

Public Member Functions

long onCmdClear (FXObject *, FXSelector, void *)
long onCmdFile (FXObject *, FXSelector, void *)
long onUpdFile (FXObject *, FXSelector, void *)
long onUpdAnyFiles (FXObject *, FXSelector, void *)
 FXRecentFiles ()
 FXRecentFiles (FXApp *a)
 FXRecentFiles (FXApp *a, const FXString &gp, FXObject *tgt=NULL, FXSelector sel=0)
FXAppgetApp () const
void setMaxFiles (FXint mx)
FXint getMaxFiles () const
void setGroupName (const FXString &name)
FXString getGroupName () const
void setTarget (FXObject *t)
FXObjectgetTarget () const
void setSelector (FXSelector sel)
FXSelector getSelector () const
FXString getFile (FXint index) const
void setFile (FXint index, const FXString &filename)
void appendFile (const FXString &filename)
void removeFile (const FXString &filename)
void clear ()
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXRecentFiles ()
virtual long onDefault (FXObject *, FXSelector, void *)
const FXchar * getClassName () const
bool isMemberOf (const FXMetaClass *metaclass) const
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
QTransString tr (const char *text, const char *hint=0)
virtual void * getPythonObject () const
virtual void decouplePythonObject () const

Constructor & Destructor Documentation

FX::FXRecentFiles::FXRecentFiles (  ) 

Make new recent files group, using global application instance.

FX::FXRecentFiles::FXRecentFiles ( FXApp a  ) 

Make new recent files group with default groupname.

FX::FXRecentFiles::FXRecentFiles ( FXApp a,
const FXString gp,
FXObject tgt = NULL,
FXSelector  sel = 0 
)

Make new recent files group with groupname gp.

virtual FX::FXRecentFiles::~FXRecentFiles (  )  [virtual]

Destructor.


Member Function Documentation

FXApp* FX::FXRecentFiles::getApp (  )  const [inline]

Get application.

void FX::FXRecentFiles::setMaxFiles ( FXint  mx  )  [inline]

Change number of files we're tracking.

FXint FX::FXRecentFiles::getMaxFiles (  )  const [inline]

Return the maximum number of files being tracked.

void FX::FXRecentFiles::setGroupName ( const FXString name  )  [inline]

Set group name.

FXString FX::FXRecentFiles::getGroupName (  )  const [inline]

Return group name.

void FX::FXRecentFiles::setTarget ( FXObject t  )  [inline]

Change the target.

FXObject* FX::FXRecentFiles::getTarget (  )  const [inline]

Get the target.

void FX::FXRecentFiles::setSelector ( FXSelector  sel  )  [inline]

Change the message.

FXSelector FX::FXRecentFiles::getSelector (  )  const [inline]

Return the message id.

FXString FX::FXRecentFiles::getFile ( FXint  index  )  const

Obtain the filename at index.

void FX::FXRecentFiles::setFile ( FXint  index,
const FXString filename 
)

Change the filename at index.

void FX::FXRecentFiles::appendFile ( const FXString filename  ) 

Append a file.

void FX::FXRecentFiles::removeFile ( const FXString filename  ) 

Remove a file.

void FX::FXRecentFiles::clear (  ) 

Clear the list of files.

virtual void FX::FXRecentFiles::save ( FXStream store  )  const [virtual]

Save to a stream.

Reimplemented from FX::FXObject.

virtual void FX::FXRecentFiles::load ( FXStream store  )  [virtual]

Load from a stream.

Reimplemented from FX::FXObject.

virtual long FX::FXObject::onDefault ( FXObject ,
FXSelector  ,
void *   
) [virtual, inherited]

Called for unhandled messages.

Reimplemented in FX::FXDelegator, FX::FXGLViewer, FX::FXMDIChild, and FX::FXMDIClient.

const FXchar* FX::FXObject::getClassName (  )  const [inherited]

Get class name of some object.

bool FX::FXObject::isMemberOf ( const FXMetaClass metaclass  )  const [inherited]

Check if object is member of metaclass.

virtual long FX::FXObject::tryHandle ( FXObject sender,
FXSelector  sel,
void *  ptr 
) [virtual, inherited]

Try handle message safely.

QTransString FX::FXObject::tr ( const char *  text,
const char *  hint = 0 
) [inherited]

Returns a human translated version of the text to the locale language (warning: uses a virtual method call, so can't use before construction)

virtual void* FX::FXObject::getPythonObject (  )  const [inline, virtual, inherited]

Returns the python object representing this instance (if created in python).

virtual void FX::FXObject::decouplePythonObject (  )  const [inline, virtual, inherited]

Causes decoupling of python object from this object (deletes self).


The documentation for this class was generated from the following file:

(C) 2002-2008 Niall Douglas. Some parts (C) to assorted authors.
Generated on Fri Jun 13 22:11:36 2008 for TnFOX by doxygen v1.5.6