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

FX::FXRecentFiles Class Reference

The Recent Files group 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,
  ID_LAST
}

Public Member Functions

 FXRecentFiles ()
 FXRecentFiles (FXApp *a, const FXString &gp="Recent Files", FXObject *tgt=NULL, FXSelector sel=0)
 FXRecentFiles (FXSettings *st, const FXString &gp="Recent Files", FXObject *tgt=NULL, FXSelector sel=0)
void setSettings (FXSettings *s)
FXSettingsgetSettings () const
void setMaxFiles (FXuint mx)
FXuint 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 (FXuint index) const
void setFile (FXuint 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 group 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. The ID_ANYFILES may be connected to a menu separator to cause automatic hiding of the menu separator when there are no recent files. The number of file names is typically no more than 10. File names should not be empty.


Member Enumeration Documentation

anonymous enum

Enumerator:
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 


Constructor & Destructor Documentation

FX::FXRecentFiles::FXRecentFiles (  ) 

Make new recent files group.

A Settings object and group name must be assigned prior to usage.

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

Make new recent files group, using settings database from application.

An optional target and message may be passed to invoke when one of the list of files is invoked.

FX::FXRecentFiles::FXRecentFiles ( FXSettings st,
const FXString gp = "Recent Files",
FXObject tgt = NULL,
FXSelector  sel = 0 
)

Make new recent files group, using given settings database.

An optional target and message may be passed to invoke when one of the list of files is invoked.

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

Destructor.


Member Function Documentation

void FX::FXRecentFiles::setSettings ( FXSettings s  )  [inline]

Change settings database.

FXSettings* FX::FXRecentFiles::getSettings (  )  const [inline]

Return settings database.

void FX::FXRecentFiles::setMaxFiles ( FXuint  mx  ) 

Change number of files we're tracking.

FXuint 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.

References FX::FXSystem::group().

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

Change the message.

References FX::FXSystem::group().

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

Return the message id.

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

Obtain the filename at index.

void FX::FXRecentFiles::setFile ( FXuint  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-2009 Jeroen van der Zijp