aboutsummaryrefslogtreecommitdiff
path: root/src/fluxbox.hh
diff options
context:
space:
mode:
authorfluxgen <fluxgen>2002-08-04 15:55:13 (GMT)
committerfluxgen <fluxgen>2002-08-04 15:55:13 (GMT)
commit56a41b23f9b5ecdef5e9536c2e6eeed0db32e623 (patch)
tree8b6fd3a735918278d54f1d108042d90df696169f /src/fluxbox.hh
parent380d50ba274c0ceb0a2f973ea464792847a80e6d (diff)
downloadfluxbox_pavel-56a41b23f9b5ecdef5e9536c2e6eeed0db32e623.zip
fluxbox_pavel-56a41b23f9b5ecdef5e9536c2e6eeed0db32e623.tar.bz2
doxygen comments
Diffstat (limited to 'src/fluxbox.hh')
-rw-r--r--src/fluxbox.hh64
1 files changed, 34 insertions, 30 deletions
diff --git a/src/fluxbox.hh b/src/fluxbox.hh
index b83347e..0a2f7c9 100644
--- a/src/fluxbox.hh
+++ b/src/fluxbox.hh
@@ -22,7 +22,7 @@
22// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 22// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23// DEALINGS IN THE SOFTWARE. 23// DEALINGS IN THE SOFTWARE.
24 24
25// $Id: fluxbox.hh,v 1.21 2002/07/19 21:26:11 fluxgen Exp $ 25// $Id: fluxbox.hh,v 1.22 2002/08/04 15:55:13 fluxgen Exp $
26 26
27#ifndef FLUXBOX_HH 27#ifndef FLUXBOX_HH
28#define FLUXBOX_HH 28#define FLUXBOX_HH
@@ -62,6 +62,10 @@
62#include <map> 62#include <map>
63#include <list> 63#include <list>
64 64
65/**
66 main class for the window manager.
67 singleton type
68*/
65class Fluxbox : public BaseDisplay, public TimeoutHandler { 69class Fluxbox : public BaseDisplay, public TimeoutHandler {
66public: 70public:
67 71
@@ -72,12 +76,12 @@ public:
72 inline bool useIconBar() { return *m_rc_iconbar; } 76 inline bool useIconBar() { return *m_rc_iconbar; }
73 inline void saveTabs(bool value) { *m_rc_tabs = value; } 77 inline void saveTabs(bool value) { *m_rc_tabs = value; }
74 inline void saveIconBar(bool value) { m_rc_iconbar = value; } 78 inline void saveIconBar(bool value) { m_rc_iconbar = value; }
75#ifdef HAVE_GETPID 79#ifdef HAVE_GETPID
76 inline const Atom &getFluxboxPidAtom(void) const { return fluxbox_pid; } 80 inline const Atom &getFluxboxPidAtom() const { return fluxbox_pid; }
77 #ifdef KDE 81 #ifdef KDE
78 //For KDE dock applets 82 //For KDE dock applets
79 inline const Atom &getKWM1DockwindowAtom(void) const { return kwm1_dockwindow; } //KDE v1.x 83 inline const Atom &getKWM1DockwindowAtom() const { return kwm1_dockwindow; } //KDE v1.x
80 inline const Atom &getKWM2DockwindowAtom(void) const { return kwm2_dockwindow; } //KDE v2.x 84 inline const Atom &getKWM2DockwindowAtom() const { return kwm2_dockwindow; } //KDE v2.x
81 #endif 85 #endif
82#endif // HAVE_GETPID 86#endif // HAVE_GETPID
83 87
@@ -85,39 +89,39 @@ public:
85 89
86 FluxboxWindow *searchGroup(Window, FluxboxWindow *); 90 FluxboxWindow *searchGroup(Window, FluxboxWindow *);
87 FluxboxWindow *searchWindow(Window); 91 FluxboxWindow *searchWindow(Window);
88 inline FluxboxWindow *getFocusedWindow(void) { return focused_window; } 92 inline FluxboxWindow *getFocusedWindow() { return focused_window; }
89 93
90 94
91 BScreen *searchScreen(Window); 95 BScreen *searchScreen(Window w);
92 96
93 inline const Time &getDoubleClickInterval(void) const 97 inline const Time &getDoubleClickInterval() const { return resource.double_click_interval; }
94 { return resource.double_click_interval; } 98 inline const Time &getLastTime() const { return last_time; }
95 inline const Time &getLastTime(void) const { return last_time; }
96 99
97 Toolbar *searchToolbar(Window); 100 Toolbar *searchToolbar(Window w);
98 Tab *searchTab(Window); 101 Tab *searchTab(Window);
99 102
103 /// obsolete
100 enum Titlebar{SHADE=0, MINIMIZE, MAXIMIZE, CLOSE, STICK, MENU, EMPTY}; 104 enum Titlebar{SHADE=0, MINIMIZE, MAXIMIZE, CLOSE, STICK, MENU, EMPTY};
101 105
102 inline const std::vector<Fluxbox::Titlebar>& getTitlebarRight() { return *m_rc_titlebar_right; } 106 inline const std::vector<Fluxbox::Titlebar>& getTitlebarRight() { return *m_rc_titlebar_right; }
103 inline const std::vector<Fluxbox::Titlebar>& getTitlebarLeft() { return *m_rc_titlebar_left; } 107 inline const std::vector<Fluxbox::Titlebar>& getTitlebarLeft() { return *m_rc_titlebar_left; }
104 inline const char *getStyleFilename(void) const { return m_rc_stylefile->c_str(); } 108 inline const char *getStyleFilename() const { return m_rc_stylefile->c_str(); }
105 109
106 inline const char *getMenuFilename(void) const { return m_rc_menufile->c_str(); } 110 inline const char *getMenuFilename() const { return m_rc_menufile->c_str(); }
107 inline const std::string &getSlitlistFilename(void) const { return *m_rc_slitlistfile; } 111 inline const std::string &getSlitlistFilename() const { return *m_rc_slitlistfile; }
108 inline int colorsPerChannel(void) const { return *m_rc_colors_per_channel; } 112 inline int colorsPerChannel() const { return *m_rc_colors_per_channel; }
109 113
110 inline const timeval &getAutoRaiseDelay(void) const { return resource.auto_raise_delay; } 114 inline const timeval &getAutoRaiseDelay() const { return resource.auto_raise_delay; }
111 115
112 inline unsigned int getCacheLife(void) const { return *m_rc_cache_life * 60000; } 116 inline unsigned int getCacheLife() const { return *m_rc_cache_life * 60000; }
113 inline unsigned int getCacheMax(void) const { return *m_rc_cache_max; } 117 inline unsigned int getCacheMax() const { return *m_rc_cache_max; }
114 118
115 inline void maskWindowEvents(Window w, FluxboxWindow *bw) 119 inline void maskWindowEvents(Window w, FluxboxWindow *bw)
116 { masked = w; masked_window = bw; } 120 { masked = w; masked_window = bw; }
117 inline void setNoFocus(Bool f) { no_focus = f; } 121 inline void setNoFocus(Bool f) { no_focus = f; }
118 122
119 void setFocusedWindow(FluxboxWindow *w); 123 void setFocusedWindow(FluxboxWindow *w);
120 void shutdown(void); 124 void shutdown();
121 void load_rc(BScreen *); 125 void load_rc(BScreen *);
122 void loadRootCommand(BScreen *); 126 void loadRootCommand(BScreen *);
123 void loadTitlebar(); 127 void loadTitlebar();
@@ -130,21 +134,21 @@ public:
130 void saveToolbarSearch(Window, Toolbar *); 134 void saveToolbarSearch(Window, Toolbar *);
131 void saveTabSearch(Window, Tab *); 135 void saveTabSearch(Window, Tab *);
132 void saveGroupSearch(Window, FluxboxWindow *); 136 void saveGroupSearch(Window, FluxboxWindow *);
133 void save_rc(void); 137 void save_rc();
134 void removeMenuSearch(Window); 138 void removeMenuSearch(Window);
135 void removeWindowSearch(Window); 139 void removeWindowSearch(Window);
136 void removeToolbarSearch(Window); 140 void removeToolbarSearch(Window);
137 void removeTabSearch(Window); 141 void removeTabSearch(Window);
138 void removeGroupSearch(Window); 142 void removeGroupSearch(Window);
139 void restart(const char * = 0); 143 void restart(const char * = 0);
140 void reconfigure(void); 144 void reconfigure();
141 void reconfigureTabs(void); 145 void reconfigureTabs();
142 void rereadMenu(void); 146 void rereadMenu();
143 void checkMenu(void); 147 void checkMenu();
144 148
145 virtual Bool handleSignal(int); 149 virtual Bool handleSignal(int);
146 150
147 virtual void timeout(void); 151 virtual void timeout();
148 152
149#ifdef SLIT 153#ifdef SLIT
150 Slit *searchSlit(Window); 154 Slit *searchSlit(Window);
@@ -238,18 +242,18 @@ protected:
238 Fluxbox(int, char **, char * = 0, char * = 0); 242 Fluxbox(int, char **, char * = 0, char * = 0);
239 char *getRcFilename(); 243 char *getRcFilename();
240 void getDefaultDataFilename(char *, std::string &); 244 void getDefaultDataFilename(char *, std::string &);
241 void load_rc(void); 245 void load_rc();
242 246
243 void reload_rc(void); 247 void reload_rc();
244 void real_rereadMenu(void); 248 void real_rereadMenu();
245 void real_reconfigure(void); 249 void real_reconfigure();
246 250
247 virtual void process_event(XEvent *); 251 virtual void process_event(XEvent *);
248 //only main should be able to creat new blackbox object 252 //only main should be able to creat new blackbox object
249 //TODO this must be removed! 253 //TODO this must be removed!
250 friend int main(int,char **); 254 friend int main(int,char **);
251 static Fluxbox *singleton; //singleton object ( can only be destroyed by main ) 255 static Fluxbox *singleton; //singleton object ( can only be destroyed by main )
252 virtual ~Fluxbox(void); 256 virtual ~Fluxbox();
253 257
254}; 258};
255 259