aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfluxgen <fluxgen>2007-03-31 19:29:00 (GMT)
committerfluxgen <fluxgen>2007-03-31 19:29:00 (GMT)
commitf040db94893f953780f4a3c4dd7e76c8c6cced81 (patch)
treeeb5ea47f1711381fb6bf8574458cd034335afab6
parent11a8b30381c6cc4c0fe2a5a6f4e68558a50d77f4 (diff)
downloadfluxbox-f040db94893f953780f4a3c4dd7e76c8c6cced81.zip
fluxbox-f040db94893f953780f4a3c4dd7e76c8c6cced81.tar.bz2
added documentation
-rw-r--r--src/ClientMenu.hh20
-rw-r--r--src/WorkspaceMenu.hh9
2 files changed, 24 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
31class BScreen; 31class BScreen;
32class FluxboxWindow; 32class FluxboxWindow;
33 33/**
34 * A menu holding a set of client menus.
35 * @see WorkspaceMenu
36 */
34class ClientMenu: public FbMenu { 37class ClientMenu: public FbMenu {
35public: 38public:
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
41private: 50private:
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
diff --git a/src/WorkspaceMenu.hh b/src/WorkspaceMenu.hh
index 2a425a3..1b06dc6 100644
--- a/src/WorkspaceMenu.hh
+++ b/src/WorkspaceMenu.hh
@@ -28,12 +28,21 @@
28 28
29class BScreen; 29class BScreen;
30 30
31/**
32 * A menu specific for workspace.
33 * Contains some simple workspace commands
34 * such as new/delete workspace and edit
35 * workspace name.
36 * It also contains client menus for all clients.
37 */
31class WorkspaceMenu: public FbMenu { 38class WorkspaceMenu: public FbMenu {
32public: 39public:
33 explicit WorkspaceMenu(BScreen &screen); 40 explicit WorkspaceMenu(BScreen &screen);
34 virtual ~WorkspaceMenu() { } 41 virtual ~WorkspaceMenu() { }
42 /// called when a subject is sending a signal
35 void update(FbTk::Subject *subj); 43 void update(FbTk::Subject *subj);
36private: 44private:
45 /// initialize menu for the screen
37 void init(BScreen &screen); 46 void init(BScreen &screen);
38}; 47};
39 48