The dictionary class maintains a fast-access hash table of entities indexed by a character string.
Inheritance:
Public Methods
-
FXDict()
- Construct an empty dictionary
-
FXint size() const
- Return the size of the table, including the empty slots
-
void size(FXint m)
- Resize the table to the given size
-
FXint no() const
- Return the total number of entries in the table
-
void* insert(const FXchar* ky, const void* ptr, FXbool mrk=FALSE)
- Insert a new entry into the table given key and mark.
-
void* replace(const FXchar* ky, const void* ptr, FXbool mrk=FALSE)
- Replace data at key, if the entry's mark is less than or equal to the given mark.
-
void* remove(const FXchar* ky)
- Remove data given key
-
void* find(const FXchar* ky) const
- Find data pointer given key
-
const FXchar* key(FXuint pos) const
- Return key at position pos
-
void* data(FXuint pos) const
- return data pointer at position pos
-
FXbool mark(FXuint pos) const
- Return mark flag of entry at position pos
-
FXint first() const
- Return position of first filled slot, or >= total
-
FXint last() const
- Return position of last filled slot or -1
-
FXint next(FXint pos) const
- Return position of next filled slot in hash table or a value greater than or equal to total if no filled slot was found
-
FXint prev(FXint pos) const
- Return position of previous filled slot in hash table or a -1 if no filled slot was found
-
void clear()
- Clear all entries
-
virtual ~FXDict()
- Destructor
Protected Methods
-
virtual void* createData(const void*)
- Overload this function in a derived class to return the data pointer given an input pointer; the default implementation just returns the input pointer
-
virtual void deleteData(void*)
- Overload this function in a derived class to delete the pointer previously returned by createData(); the default implementation does nothing
Public Methods
-
const FXchar* getClassName() const
-
FXbool isMemberOf(const FXMetaClass* metaclass) const
-
virtual void save(FXStream& store) const
-
virtual void load(FXStream& store)
Documentation
The dictionary class maintains a fast-access hash table of entities
indexed by a character string.
It is typically used to map strings to pointers; however, overloading
the createData() and deleteData() members allows any type of data to
be indexed by strings.
virtual void* createData(const void*)
-
Overload this function in a derived class to return the
data pointer given an input pointer; the default implementation
just returns the input pointer
virtual void deleteData(void*)
-
Overload this function in a derived class to delete the pointer
previously returned by createData(); the default implementation
does nothing
FXDict()
-
Construct an empty dictionary
FXint size() const
-
Return the size of the table, including the empty slots
void size(FXint m)
-
Resize the table to the given size
FXint no() const
-
Return the total number of entries in the table
void* insert(const FXchar* ky, const void* ptr, FXbool mrk=FALSE)
-
Insert a new entry into the table given key and mark.
If there is already an entry with that key, leave it unchanged,
otherwise insert the new entry.
void* replace(const FXchar* ky, const void* ptr, FXbool mrk=FALSE)
-
Replace data at key, if the entry's mark is less than
or equal to the given mark. If there was no existing entry,
a new entry is inserted with the given mark.
void* remove(const FXchar* ky)
-
Remove data given key
void* find(const FXchar* ky) const
-
Find data pointer given key
const FXchar* key(FXuint pos) const
-
Return key at position pos
void* data(FXuint pos) const
-
return data pointer at position pos
FXbool mark(FXuint pos) const
-
Return mark flag of entry at position pos
FXint first() const
-
Return position of first filled slot, or >= total
FXint last() const
-
Return position of last filled slot or -1
FXint next(FXint pos) const
-
Return position of next filled slot in hash table
or a value greater than or equal to total if no filled
slot was found
FXint prev(FXint pos) const
-
Return position of previous filled slot in hash table
or a -1 if no filled slot was found
void clear()
- Clear all entries
virtual ~FXDict()
- Destructor
- Direct child classes:
- FXStringDict
FXSettings
FXIconDict
FXFileDict
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.