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

FXEX::FXHistoryItems Class Reference

Implements generic history list traversal. More...

#include <FXHistoryItems.h>

Inheritance diagram for FXEX::FXHistoryItems::

FXEX::FXBaseObject FXObject FXEX::FXHistoryList FXEX::FXRecentItems List of all members.

Public Methods

 FXHistoryItems (FXApp *a, const FXString &gp="History Items", FXObject *tgt=NULL, FXSelector sel=0, FXint size=-1)
FXint size (const FXint mx)
FXint size () const
FXint no ()
void clear ()
FXint index () const
FXint index (const FXint item)
FXint previous ()
FXint next ()
FXint find (const FXString &name)
FXString name ()
virtual void * data ()
FXint remove ()
FXint remove (const FXString &name)
FXint remove (const FXint item)
virtual FXint add (const FXString &name, void *data=NULL)
FXint removeNewer (const FXint item)
FXint removeOlder (const FXint item)
FXint moveFirst (const FXString &name)
FXint moveFirst (const FXint item)
void saveOnDestroy (FXbool state)
void dataIsString (FXbool state)
void clearReg ()
FXint writeReg ()
FXint readReg ()
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXHistoryItems ()

Detailed Description

Implements generic history list traversal.

Definition at line 33 of file FXHistoryItems.h.


Constructor & Destructor Documentation

FXEX::FXHistoryItems::FXHistoryItems FXApp * a,
const FXString & gp = "History Items",
FXObject * tgt = NULL,
FXSelector sel = 0,
FXint size = -1
 

Make new History Items Group with groupname gp, capable of tracking an unlimited (-1) amount of items.

virtual FXEX::FXHistoryItems::~FXHistoryItems [virtual]
 

Destructor.


Member Function Documentation

FXint FXEX::FXHistoryItems::size const FXint mx
 

Change number of items we're tracking.

FXint FXEX::FXHistoryItems::size const [inline]
 

Return the maximum number of items capable being tracked.

Definition at line 85 of file FXHistoryItems.h.

FXint FXEX::FXHistoryItems::no [inline]
 

Get the amount of entries in the list.

Definition at line 88 of file FXHistoryItems.h.

void FXEX::FXHistoryItems::clear
 

Clear the list of items.

FXint FXEX::FXHistoryItems::index const [inline]
 

Get current index number.

Definition at line 94 of file FXHistoryItems.h.

FXint FXEX::FXHistoryItems::index const FXint item
 

Set current index number - returns the current item pointed to.

FXint FXEX::FXHistoryItems::previous
 

Get the previous/older item index, if it exists - stays on the same index.

FXint FXEX::FXHistoryItems::next
 

Get the next/newer item index, if it exists - stays on the same index.

FXint FXEX::FXHistoryItems::find const FXString & name
 

Get the index of particular item name.

FXString FXEX::FXHistoryItems::name [inline]
 

Get name of current item.

Definition at line 109 of file FXHistoryItems.h.

virtual void* FXEX::FXHistoryItems::data [inline, virtual]
 

get data of current item.

Definition at line 112 of file FXHistoryItems.h.

FXint FXEX::FXHistoryItems::remove
 

Remove current item.

FXint FXEX::FXHistoryItems::remove const FXString & name
 

Remove an item by name.

FXint FXEX::FXHistoryItems::remove const FXint item
 

Remove an item by index.

virtual FXint FXEX::FXHistoryItems::add const FXString & name,
void * data = NULL
[virtual]
 

Add an item to the start of the list --> made virtual so that decendants can change the 'add' behaviour.

FXint FXEX::FXHistoryItems::removeNewer const FXint item
 

Remove items newer than specified item - returns the current item pointed to.

FXint FXEX::FXHistoryItems::removeOlder const FXint item
 

Remove items older than specified item - returns the current item pointed to.

FXint FXEX::FXHistoryItems::moveFirst const FXString & name
 

Moves the 'named item' to the top of the list Sets the current item reference to the top of the list.

FXint FXEX::FXHistoryItems::moveFirst const FXint item
 

Moves the 'item' to the top of the list Sets the current item reference to the top of the list.

void FXEX::FXHistoryItems::saveOnDestroy FXbool state
 

Saves the list to the registry on object destroy.

void FXEX::FXHistoryItems::dataIsString FXbool state
 

Saves the 'data' to the registry if it declared to an FXString type.

void FXEX::FXHistoryItems::clearReg
 

Removes this list from the registry.

FXint FXEX::FXHistoryItems::writeReg
 

Save the current history to the registory - returns the current item.

FXint FXEX::FXHistoryItems::readReg
 

Load the history from the registory - returns the most recent item.

virtual void FXEX::FXHistoryItems::save FXStream & store const [virtual]
 

Save to a stream.

Reimplemented from FXEX::FXBaseObject.

virtual void FXEX::FXHistoryItems::load FXStream & store [virtual]
 

Load from a stream.

Reimplemented from FXEX::FXBaseObject.