Inheritance diagram for TopicSource:

Collaboration diagram for TopicSource:

Public Member Functions
virtual void	destroy ()
	cleanup on shutdown.
virtual void	getEntry ()
	get entry i passing name and icon through returns if it is not null returns DataSource_false if out of bounds otherwise returns an entity or DataSource_true
virtual void	indexOf ()
	return the index of the first match for find.
virtual void	reload ()
	reload all entries matching filter returning how many matches were found

Static Public Attributes
static entity	false = NULL
static entity	true = NEW(Object)

Detailed Description

Definition at line 24 of file guide.qh.

Member Function Documentation

◆ destroy()

virtual void DataSource::destroy ( )

inlinevirtualinherited

cleanup on shutdown.

optional

Definition at line 17 of file datasource.qh.

17{ }

References destroy(), and entity().

Referenced by destroy().

◆ getEntry()

void TopicSource::getEntry ( )

virtual

get entry i passing name and icon through returns if it is not null returns DataSource_false if out of bounds otherwise returns an entity or DataSource_true

Reimplemented from DataSource.

Definition at line 3 of file guide.qc.

{
    int idx = 0;
    #define TOPIC(src, name, icon) \
        if (idx++ == i) \
        { \
            if (returns) \
                returns(name, icon); \
            return DataSource_true; \
        }
    TOPICS(TOPIC);
    #undef TOPIC
    if (returns)
        returns("undefined", "undefined");
    return DataSource_false;
}

References getEntry(), TOPIC, and TOPICS.

Referenced by getEntry().

◆ indexOf()

virtual void DataSource::indexOf ( )

inlinevirtualinherited

return the index of the first match for find.

optional

Definition at line 13 of file datasource.qh.

13{ return -1; }

References entity(), find(), and indexOf().

Referenced by indexOf().

◆ reload()

void TopicSource::reload ( )

virtual

reload all entries matching filter returning how many matches were found

Reimplemented from DataSource.

Definition at line 19 of file guide.qc.

{
    int n = 0;
    #define TOPIC(src, name, icon) ++n;
    TOPICS(TOPIC);
    #undef TOPIC
    return n;
}

References reload(), TOPIC, and TOPICS.

Referenced by reload().

Member Data Documentation

◆ false

entity DataSource::false = NULL

staticinherited

Definition at line 5 of file datasource.qh.

◆ true

entity DataSource::true = NEW(Object)