EditorInfo - stores information about an editor's contents
SYNOPSIS
#include <Unidraw/editorinfo.h>
DESCRIPTION
An EditorInfo object is a UMap that stores a list of
strings and/or string tuples. Application-specific edi-
tors can use these objects to store information about what
components, commands, and tools they incorporate in their
interface. The programmer can write out this information
with a catalog object and read it back in later. The
application can then let the user change the editor's con-
figuration by editing the catalog-generated file. For
example, an EditorInfo object could have a list of names
for tools in the editor's interface that have been saved
with the catalog. When the application is restarted, the
EditorInfo object can be read first, and then the catalog
can reconstruct the tools given their names.
PUBLIC OPERATIONS
EditorInfo()
Construct an EditorInfo instance.
void Register(const char* name, const char* info = ``'')
void UnregisterName(const char*)
void UnregisterInfo(const char*)
boolean Registered(const char* name)
Register enters a name or name-info tuple into the
EditorInfo object. UnregisterName removes an entry
whose name string matches the given one, while
UnregisterInfo removes an entry whose info string
matches the given one. The Registered operation
returns whether or not an entry with a matching
name exists.
const char* GetName(const char* info)
const char* GetInfo(const char* name)
Name-info tuple lookup operations. The GetName
operation returns the name corresponding to a given
info string, while the GetInfo operation returns
the info string for a given name.
const char* GetName(int index)
const char* GetInfo(int index)
Name or info strings can be accessed by an index
that reflects the order in which they were regis-
tered. These operations return the name or info
string for a given index.
SEE ALSO
Catalog(3U), Editor(3U), UMap(3U)
Man(1) output converted with
man2html