summaryrefslogtreecommitdiffstats
path: root/ksim/library/common.h
blob: 6f6ae56d11799ebf50b763a2b031509cebf469fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*  ksim - a system monitor for kde
 *
 *  Copyright (C) 2001  Robbie Ward <[email protected]>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef KSIM__COMMON_H
#define KSIM__COMMON_H

#define KSIM_VERSION 110
#define KSIM_VERSION_STRING "1.1.0"

#include <tqstring.h>
#include <kdemacros.h>

/**
 * namespace for common ksim entries
 *
 * @author Robbie Ward <[email protected]>
 */
namespace KSim
{
  // a few forward declares
  class ThemeLoader;
  class Theme;
  class PluginLoader;
  class PluginList;
  class Plugin;
  class PluginObject;
  class PluginView;
  class PluginPage;

  /**
   * class that all widgets (library dir only) HAVE to inherit
   * if they want to change items on ksim configuration reload
   *
   * any class that inherits this must re-implement
   * the configureObject() function.
   *
   * example:
   * <pre>
   *  #include &lt;tqwidget.h&gt;
   *  #include &lt;ksim/common.h&gt;
   *
   *  class Test : public TQWidget, virtual public KSim::Base
   *  {
   *    public:
   *      Test(TQWidget *parent, const char *name) : TQWidget(parent, name)
   *      {
   *      }
   *      ~Test() {}
   *
   *      void configureObject(bool repaintWidget)
   *      {
   *        // Re-Create view code here
   *      }
   *  };
   * </pre>
   * @short base class for widgets
   * @author Robbie Ward <[email protected]>
   */
  class TDE_EXPORT Base
  {
    public:
      Base();
      Base(int type);
      virtual ~Base();

      /**
       * Reimplement this to change theme images/locations etc
       */
      virtual void configureObject(bool = true) = 0;
      /**
       * returns true if configureObject has been setup
       * to contain only theme configuration
       * @see #setThemeConfigOnly
       */
      bool isThemeConfigOnly() const;
      /**
       * sets the theme type
       */
      void setType(int type);
      /**
       * @return the theme type, eg host, mem, swap etc
       */
      int type() const;
      /**
       * Set the config entry key to look for when reading gkrellmrc
       */
      void setConfigString(const TQString &string);
      /**
       * @return the config entry to look for when reading theme files
       */
      const TQString &configString() const;

    protected:
      /**
       * reimplement this function if you want setType()
       * to call extra information
       */
      virtual void extraTypeCall();
      /**
       * @return the current KSim::ThemeLoader instance
       */
      KSim::ThemeLoader &themeLoader() const;
      /**
       * set this to false if you want KSim to call your KSim::Base
       * configureObject() when KSim's configuration has changed
       * even if the theme settings are the same. The default is true
       */
      void setThemeConfigOnly(bool);

    private:
      Base(const Base &rhs);
      Base &operator=(const Base &rhs);

      class Private;
      Private *d;
  };
}
#endif