diff options
author | fluxgen <fluxgen> | 2007-03-31 19:29:00 (GMT) |
---|---|---|
committer | fluxgen <fluxgen> | 2007-03-31 19:29:00 (GMT) |
commit | f040db94893f953780f4a3c4dd7e76c8c6cced81 (patch) | |
tree | eb5ea47f1711381fb6bf8574458cd034335afab6 /src/ClientMenu.hh | |
parent | 11a8b30381c6cc4c0fe2a5a6f4e68558a50d77f4 (diff) | |
download | fluxbox-f040db94893f953780f4a3c4dd7e76c8c6cced81.zip fluxbox-f040db94893f953780f4a3c4dd7e76c8c6cced81.tar.bz2 |
added documentation
Diffstat (limited to 'src/ClientMenu.hh')
-rw-r--r-- | src/ClientMenu.hh | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/src/ClientMenu.hh b/src/ClientMenu.hh index ca01e43..8a1878b 100644 --- a/src/ClientMenu.hh +++ b/src/ClientMenu.hh | |||
@@ -30,21 +30,31 @@ | |||
30 | 30 | ||
31 | class BScreen; | 31 | class BScreen; |
32 | class FluxboxWindow; | 32 | class FluxboxWindow; |
33 | 33 | /** | |
34 | * A menu holding a set of client menus. | ||
35 | * @see WorkspaceMenu | ||
36 | */ | ||
34 | class ClientMenu: public FbMenu { | 37 | class ClientMenu: public FbMenu { |
35 | public: | 38 | public: |
36 | 39 | ||
37 | typedef std::list<FluxboxWindow *> Focusables; | 40 | typedef std::list<FluxboxWindow *> Focusables; |
38 | 41 | ||
39 | ClientMenu(BScreen &screen, Focusables &clients, FbTk::Subject *refresh); | 42 | /** |
43 | * @param screen the screen to show this menu on | ||
44 | * @param client a list of clients to show in this menu | ||
45 | * @param refresh the refresh subject to listen to | ||
46 | */ | ||
47 | ClientMenu(BScreen &screen, | ||
48 | Focusables &clients, FbTk::Subject *refresh); | ||
40 | 49 | ||
41 | private: | 50 | private: |
42 | 51 | /// refresh the entire menu | |
43 | void refreshMenu(); | 52 | void refreshMenu(); |
53 | /// called when receiving a subject signal | ||
44 | void update(FbTk::Subject *subj); | 54 | void update(FbTk::Subject *subj); |
45 | 55 | ||
46 | Focusables &m_list; | 56 | Focusables &m_list; ///< clients |
47 | FbTk::Subject *m_refresh_sig; | 57 | FbTk::Subject *m_refresh_sig; ///< signal to listen to |
48 | }; | 58 | }; |
49 | 59 | ||
50 | #endif // CLIENTMENU_HH | 60 | #endif // CLIENTMENU_HH |