Examples Class Reference

Aggregate of the example/preset sources (player, rival, Pokemon). More...

#include <examples.h>

Inheritance diagram for Examples:

Collaboration diagram for Examples:

Public Member Functions
ExamplesPlayer *	player () const
	The example-player source (backs player).
ExamplesRival *	rival () const
	The example-rival source (backs rival).
ExamplesPokemon *	pokemon () const
	The example-Pokemon source (backs pokemon).
void	qmlProtect (const QQmlEngine *const engine) const
	Pin to C++ ownership.

Static Public Member Functions
static Examples *	inst ()
	< Example player source.

Detailed Description

Aggregate of the example/preset sources (player, rival, Pokemon).

Groups player (ExamplesPlayer), rival (ExamplesRival), and pokemon (ExamplesPokemon) under one singleton, reached via db.examples. These supply ready-made example values (e.g. a random example player) used by the editors. See db.md.

See also

ExamplesPlayer, ExamplesRival, ExamplesPokemon.

Definition at line 35 of file examples.h.

Member Function Documentation

inst()

Examples * Examples::inst ( )

static

< Example player source.

Example rival source. Example Pokemon source. The process-wide Examples singleton.

Definition at line 31 of file examples.cpp.

Referenced by DB::examples(), and DB::qmlProtect().

player()

ExamplesPlayer * Examples::player

(

)

const

The example-player source (backs player).

Definition at line 37 of file examples.cpp.

References ExamplesPlayer::inst().

pokemon()

ExamplesPokemon * Examples::pokemon

(

)

const

The example-Pokemon source (backs pokemon).

Definition at line 47 of file examples.cpp.

References ExamplesPokemon::inst().

qmlProtect()

void Examples::qmlProtect

(

const QQmlEngine *const

engine

)

const

Pin to C++ ownership.

Definition at line 52 of file examples.cpp.

References ExamplesPlayer::inst(), ExamplesPokemon::inst(), ExamplesRival::inst(), AbstractRandomString::qmlProtect(), and Utility::qmlProtectUtil().

Referenced by DB::qmlProtect().

rival()

ExamplesRival * Examples::rival

(

)

const

The example-rival source (backs rival).

Definition at line 42 of file examples.cpp.

References ExamplesRival::inst().

---

The documentation for this class was generated from the following files:

• projects/db/src/pse-db/examples.h
• projects/db/src/pse-db/examples.cpp