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

FX::FXRecentFiles Class Reference

The recent files object manages a most recently used (MRU) file list by means of the standard system registry. More...

#include <FXRecentFiles.h>

Inheritance diagram for FX::FXRecentFiles:

FX::FXObject List of all members.

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
}

Public Member Functions

 FXRecentFiles ()
 FXRecentFiles (const FXString &gp, FXObject *tgt=NULL, FXSelector sel=0)
void setMaxFiles (FXint mx)
FXint getMaxFiles () const
void setGroupName (const FXString &name)
FXString getGroupName () const
void setTarget (FXObject *t)
FXObject * getTarget () 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 ()

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.

Constructor & Destructor Documentation

FX::FXRecentFiles::FXRecentFiles (   ) 
 

Make new Recent Files Group with default groupname.

FX::FXRecentFiles::FXRecentFiles (  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

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.

Copyright © 1997-2005 Jeroen van der Zijp