comments and include guard fix

This commit is contained in:
fluxgen 2002-12-16 11:01:43 +00:00
parent 6d4454c386
commit e0ae69d0b9

View file

@ -19,10 +19,12 @@
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE. // DEALINGS IN THE SOFTWARE.
// $Id: Theme.hh,v 1.1 2002/12/02 19:34:51 fluxgen Exp $ // $Id: Theme.hh,v 1.2 2002/12/16 11:01:43 fluxgen Exp $
// holds ThemeItem, Theme and ThemeManager // holds ThemeItem, Theme and ThemeManager
#ifndef FBTK_THEME_HH
#define FBTK_THEME_HH
#include <string> #include <string>
#include <list> #include <list>
@ -33,9 +35,11 @@
namespace FbTk { namespace FbTk {
class Theme; class Theme;
/// Base class for ThemeItem, holds name and altname
/** /**
base class for themeitem, holds name and altname @see ThemeItem
*/ */
class ThemeItem_base { class ThemeItem_base {
public: public:
ThemeItem_base(const std::string &name, const std::string &altname): ThemeItem_base(const std::string &name, const std::string &altname):
@ -50,9 +54,8 @@ private:
std::string m_name, m_altname; std::string m_name, m_altname;
}; };
/**
template ThemeItem class for things like Texture and Color /// template ThemeItem class for things like Texture and Color
*/
template <typename T> template <typename T>
class ThemeItem:public ThemeItem_base { class ThemeItem:public ThemeItem_base {
public: public:
@ -80,10 +83,7 @@ private:
}; };
/// Hold ThemeItems. Use this to create a Theme set
/**
Hold themeitems. Use this to create a Theme set
*/
class Theme { class Theme {
public: public:
explicit Theme(int screen_num); // create a theme for a specific screen explicit Theme(int screen_num); // create a theme for a specific screen
@ -105,8 +105,9 @@ private:
}; };
/// Singleton theme manager
/** /**
singleton theme manager Use this to load all the registred themes
*/ */
class ThemeManager { class ThemeManager {
public: public:
@ -120,7 +121,7 @@ private:
friend class FbTk::Theme; // so only theme can register itself in constructor friend class FbTk::Theme; // so only theme can register itself in constructor
/// @return false if screen_num if out of /// @return false if screen_num if out of
// range or theme already registered, else true /// range or theme already registered, else true
bool registerTheme(FbTk::Theme &tm); bool registerTheme(FbTk::Theme &tm);
/// @return false if theme isn't registred in the manager /// @return false if theme isn't registred in the manager
bool unregisterTheme(FbTk::Theme &tm); bool unregisterTheme(FbTk::Theme &tm);
@ -159,4 +160,5 @@ void Theme::remove(ThemeItem<T> &item) {
}; // end namespace FbTk }; // end namespace FbTk
#endif // FBTK_THEME_HH