OmgTipFactory Class Reference

#include <omgtipfactory.h>

Inheritance diagram for OmgTipFactory:

[legend]Collaboration diagram for OmgTipFactory:

[legend]List of all members.

---

Detailed Description

A factory class to serve up tips to the user. Tips can be generic, in which case they make no mention of gui dialogs etc, or gui-secific in which case they may allude to features of the graphical user interface.

See also:

also OmgTipOfTheDay, OmgTip

Definition at line 35 of file omgtipfactory.h.

Public Member Functions
	OmgTipFactory ()
	~OmgTipFactory ()
OmgTip	getTip ()
OmgTip	getTip (int thePosition)
OmgTip	getGenericTip ()
OmgTip	getGuiTip ()
Private Member Functions
void	addGenericTip (OmgTip)
void	addGuiTip (OmgTip)
int	randomNumber (int theMax)
Private Attributes
QList< OmgTip >	mGenericTips
QList< OmgTip >	mGuiTips
QList< OmgTip >	mAllTips

---

Constructor & Destructor Documentation

OmgTipFactory::OmgTipFactory (   )

Constructor Definition at line 25 of file omgtipfactory.cpp. References addGenericTip(), addGuiTip(), OmgTip::setContent(), and OmgTip::setTitle().

Here is the call graph for this function:

OmgTipFactory::~OmgTipFactory (   )

Destructor Definition at line 124 of file omgtipfactory.cpp.

---

Member Function Documentation

void OmgTipFactory::addGenericTip (  OmgTip   )  [private]

Definition at line 135 of file omgtipfactory.cpp. References mAllTips, and mGenericTips. Referenced by OmgTipFactory().

void OmgTipFactory::addGuiTip (  OmgTip   )  [private]

Definition at line 129 of file omgtipfactory.cpp. References mAllTips, and mGuiTips. Referenced by OmgTipFactory().

OmgTip OmgTipFactory::getGenericTip (   )

Get a random generic tip Returns: An OmgTip containing the tip Definition at line 153 of file omgtipfactory.cpp. References mGenericTips. Referenced by OmgTipFactoryTest::getGenericTip().

OmgTip OmgTipFactory::getGuiTip (   )

Get a random gui-centric tip Returns: An OmgTip containing the tip Definition at line 161 of file omgtipfactory.cpp. References mGuiTips. Referenced by OmgTipFactoryTest::getGuiTip().

OmgTip OmgTipFactory::getTip (  int  thePosition  )

Get a specific tip (generic or gui-centric). Parameters: thePosition  The tip returned will be based on the number passed in as thePosition. If the position is invalid, an empty string will be returned. Returns: An OmgTip containing the tip Definition at line 148 of file omgtipfactory.cpp. References mAllTips.

OmgTip OmgTipFactory::getTip (   )

Get a random tip (generic or gui-centric) Returns: An OmgTip containing the tip Definition at line 140 of file omgtipfactory.cpp. References mAllTips. Referenced by OmgTipFactoryTest::getTip(), OmgTipFactoryTest::getTipAtPosition(), and OmgMainWindow::showHelp().

int OmgTipFactory::randomNumber (  int  theMax  )  [private]

Definition at line 169 of file omgtipfactory.cpp.

---

Member Data Documentation

QList<OmgTip> OmgTipFactory::mAllTips [private]

Definition at line 71 of file omgtipfactory.h. Referenced by addGenericTip(), addGuiTip(), and getTip().

QList<OmgTip> OmgTipFactory::mGenericTips [private]

Definition at line 69 of file omgtipfactory.h. Referenced by addGenericTip(), and getGenericTip().

QList<OmgTip> OmgTipFactory::mGuiTips [private]

Definition at line 70 of file omgtipfactory.h. Referenced by addGuiTip(), and getGuiTip().

---

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

• lib/omgtipfactory.h
• lib/omgtipfactory.cpp

---