diff options
author | fluxgen <fluxgen> | 2002-08-04 15:55:13 (GMT) |
---|---|---|
committer | fluxgen <fluxgen> | 2002-08-04 15:55:13 (GMT) |
commit | 56a41b23f9b5ecdef5e9536c2e6eeed0db32e623 (patch) | |
tree | 8b6fd3a735918278d54f1d108042d90df696169f /src/FbAtoms.hh | |
parent | 380d50ba274c0ceb0a2f973ea464792847a80e6d (diff) | |
download | fluxbox-56a41b23f9b5ecdef5e9536c2e6eeed0db32e623.zip fluxbox-56a41b23f9b5ecdef5e9536c2e6eeed0db32e623.tar.bz2 |
doxygen comments
Diffstat (limited to 'src/FbAtoms.hh')
-rw-r--r-- | src/FbAtoms.hh | 99 |
1 files changed, 51 insertions, 48 deletions
diff --git a/src/FbAtoms.hh b/src/FbAtoms.hh index cebb040..8fa6676 100644 --- a/src/FbAtoms.hh +++ b/src/FbAtoms.hh | |||
@@ -19,12 +19,15 @@ | |||
19 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | 19 | // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
20 | // DEALINGS IN THE SOFTWARE. | 20 | // DEALINGS IN THE SOFTWARE. |
21 | 21 | ||
22 | // $Id: FbAtoms.hh,v 1.3 2002/05/07 15:07:02 fluxgen Exp $ | 22 | // $Id: FbAtoms.hh,v 1.4 2002/08/04 15:55:13 fluxgen Exp $ |
23 | #ifndef FBATOMS_HH | 23 | #ifndef FBATOMS_HH |
24 | #define FBATOMS_HH | 24 | #define FBATOMS_HH |
25 | 25 | ||
26 | #include <X11/Xlib.h> | 26 | #include <X11/Xlib.h> |
27 | #include <X11/Xatom.h> | 27 | #include <X11/Xatom.h> |
28 | /** | ||
29 | atom handler, should probably be a singleton | ||
30 | */ | ||
28 | class FbAtoms | 31 | class FbAtoms |
29 | { | 32 | { |
30 | public: | 33 | public: |
@@ -43,80 +46,80 @@ public: | |||
43 | inline const Atom &getGnomeLayerAtom() const { return gnome_wm_win_layer; } | 46 | inline const Atom &getGnomeLayerAtom() const { return gnome_wm_win_layer; } |
44 | #endif //GNOME | 47 | #endif //GNOME |
45 | 48 | ||
46 | inline const Atom &getWMChangeStateAtom(void) const { return xa_wm_change_state; } | 49 | inline const Atom &getWMChangeStateAtom() const { return xa_wm_change_state; } |
47 | inline const Atom &getWMStateAtom(void) const { return xa_wm_state; } | 50 | inline const Atom &getWMStateAtom() const { return xa_wm_state; } |
48 | inline const Atom &getWMDeleteAtom(void) const { return xa_wm_delete_window; } | 51 | inline const Atom &getWMDeleteAtom() const { return xa_wm_delete_window; } |
49 | inline const Atom &getWMProtocolsAtom(void) const { return xa_wm_protocols; } | 52 | inline const Atom &getWMProtocolsAtom() const { return xa_wm_protocols; } |
50 | inline const Atom &getWMTakeFocusAtom(void) const { return xa_wm_take_focus; } | 53 | inline const Atom &getWMTakeFocusAtom() const { return xa_wm_take_focus; } |
51 | inline const Atom &getWMColormapAtom(void) const { return xa_wm_colormap_windows; } | 54 | inline const Atom &getWMColormapAtom() const { return xa_wm_colormap_windows; } |
52 | inline const Atom &getMotifWMHintsAtom(void) const { return motif_wm_hints; } | 55 | inline const Atom &getMotifWMHintsAtom() const { return motif_wm_hints; } |
53 | 56 | ||
54 | // this atom is for normal app->WM hints about decorations, stacking, | 57 | // this atom is for normal app->WM hints about decorations, stacking, |
55 | // starting workspace etc... | 58 | // starting workspace etc... |
56 | inline const Atom &getFluxboxHintsAtom(void) const { return blackbox_hints;} | 59 | inline const Atom &getFluxboxHintsAtom() const { return blackbox_hints;} |
57 | 60 | ||
58 | // these atoms are for normal app->WM interaction beyond the scope of the | 61 | // these atoms are for normal app->WM interaction beyond the scope of the |
59 | // ICCCM... | 62 | // ICCCM... |
60 | inline const Atom &getFluxboxAttributesAtom(void) const { return blackbox_attributes; } | 63 | inline const Atom &getFluxboxAttributesAtom() const { return blackbox_attributes; } |
61 | inline const Atom &getFluxboxChangeAttributesAtom(void) const { return blackbox_change_attributes; } | 64 | inline const Atom &getFluxboxChangeAttributesAtom() const { return blackbox_change_attributes; } |
62 | 65 | ||
63 | // these atoms are for window->WM interaction, with more control and | 66 | // these atoms are for window->WM interaction, with more control and |
64 | // information on window "structure"... common examples are | 67 | // information on window "structure"... common examples are |
65 | // notifying apps when windows are raised/lowered... when the user changes | 68 | // notifying apps when windows are raised/lowered... when the user changes |
66 | // workspaces... i.e. "pager talk" | 69 | // workspaces... i.e. "pager talk" |
67 | inline const Atom &getFluxboxStructureMessagesAtom(void) const{ return blackbox_structure_messages; } | 70 | inline const Atom &getFluxboxStructureMessagesAtom() const{ return blackbox_structure_messages; } |
68 | 71 | ||
69 | // *Notify* portions of the NETStructureMessages protocol | 72 | // *Notify* portions of the NETStructureMessages protocol |
70 | inline const Atom &getFluxboxNotifyStartupAtom(void) const { return blackbox_notify_startup; } | 73 | inline const Atom &getFluxboxNotifyStartupAtom() const { return blackbox_notify_startup; } |
71 | inline const Atom &getFluxboxNotifyWindowAddAtom(void) const { return blackbox_notify_window_add; } | 74 | inline const Atom &getFluxboxNotifyWindowAddAtom() const { return blackbox_notify_window_add; } |
72 | inline const Atom &getFluxboxNotifyWindowDelAtom(void) const { return blackbox_notify_window_del; } | 75 | inline const Atom &getFluxboxNotifyWindowDelAtom() const { return blackbox_notify_window_del; } |
73 | inline const Atom &getFluxboxNotifyWindowFocusAtom(void) const { return blackbox_notify_window_focus; } | 76 | inline const Atom &getFluxboxNotifyWindowFocusAtom() const { return blackbox_notify_window_focus; } |
74 | inline const Atom &getFluxboxNotifyCurrentWorkspaceAtom(void) const { return blackbox_notify_current_workspace; } | 77 | inline const Atom &getFluxboxNotifyCurrentWorkspaceAtom() const { return blackbox_notify_current_workspace; } |
75 | inline const Atom &getFluxboxNotifyWorkspaceCountAtom(void) const { return blackbox_notify_workspace_count; } | 78 | inline const Atom &getFluxboxNotifyWorkspaceCountAtom() const { return blackbox_notify_workspace_count; } |
76 | inline const Atom &getFluxboxNotifyWindowRaiseAtom(void) const { return blackbox_notify_window_raise; } | 79 | inline const Atom &getFluxboxNotifyWindowRaiseAtom() const { return blackbox_notify_window_raise; } |
77 | inline const Atom &getFluxboxNotifyWindowLowerAtom(void) const { return blackbox_notify_window_lower; } | 80 | inline const Atom &getFluxboxNotifyWindowLowerAtom() const { return blackbox_notify_window_lower; } |
78 | 81 | ||
79 | // atoms to change that request changes to the desktop environment during | 82 | // atoms to change that request changes to the desktop environment during |
80 | // runtime... these messages can be sent by any client... as the sending | 83 | // runtime... these messages can be sent by any client... as the sending |
81 | // client window id is not included in the ClientMessage event... | 84 | // client window id is not included in the ClientMessage event... |
82 | inline const Atom &getFluxboxChangeWorkspaceAtom(void) const { return blackbox_change_workspace; } | 85 | inline const Atom &getFluxboxChangeWorkspaceAtom() const { return blackbox_change_workspace; } |
83 | inline const Atom &getFluxboxChangeWindowFocusAtom(void) const { return blackbox_change_window_focus; } | 86 | inline const Atom &getFluxboxChangeWindowFocusAtom() const { return blackbox_change_window_focus; } |
84 | inline const Atom &getFluxboxCycleWindowFocusAtom(void) const { return blackbox_cycle_window_focus; } | 87 | inline const Atom &getFluxboxCycleWindowFocusAtom() const { return blackbox_cycle_window_focus; } |
85 | 88 | ||
86 | #ifdef NEWWMSPEC | 89 | #ifdef NEWWMSPEC |
87 | 90 | ||
88 | // root window properties | 91 | // root window properties |
89 | inline const Atom &getNETSupportedAtom(void) const { return net_supported; } | 92 | inline const Atom &getNETSupportedAtom() const { return net_supported; } |
90 | inline const Atom &getNETClientListAtom(void) const { return net_client_list; } | 93 | inline const Atom &getNETClientListAtom() const { return net_client_list; } |
91 | inline const Atom &getNETClientListStackingAtom(void) const { return net_client_list_stacking; } | 94 | inline const Atom &getNETClientListStackingAtom() const { return net_client_list_stacking; } |
92 | inline const Atom &getNETNumberOfDesktopsAtom(void) const { return net_number_of_desktops; } | 95 | inline const Atom &getNETNumberOfDesktopsAtom() const { return net_number_of_desktops; } |
93 | inline const Atom &getNETDesktopGeometryAtom(void) const { return net_desktop_geometry; } | 96 | inline const Atom &getNETDesktopGeometryAtom() const { return net_desktop_geometry; } |
94 | inline const Atom &getNETDesktopViewportAtom(void) const { return net_desktop_viewport; } | 97 | inline const Atom &getNETDesktopViewportAtom() const { return net_desktop_viewport; } |
95 | inline const Atom &getNETCurrentDesktopAtom(void) const { return net_current_desktop; } | 98 | inline const Atom &getNETCurrentDesktopAtom() const { return net_current_desktop; } |
96 | inline const Atom &getNETDesktopNamesAtom(void) const { return net_desktop_names; } | 99 | inline const Atom &getNETDesktopNamesAtom() const { return net_desktop_names; } |
97 | inline const Atom &getNETActiveWindowAtom(void) const { return net_active_window; } | 100 | inline const Atom &getNETActiveWindowAtom() const { return net_active_window; } |
98 | inline const Atom &getNETWorkareaAtom(void) const { return net_workarea; } | 101 | inline const Atom &getNETWorkareaAtom() const { return net_workarea; } |
99 | inline const Atom &getNETSupportingWMCheckAtom(void) const { return net_supporting_wm_check; } | 102 | inline const Atom &getNETSupportingWMCheckAtom() const { return net_supporting_wm_check; } |
100 | inline const Atom &getNETVirtualRootsAtom(void) const { return net_virtual_roots; } | 103 | inline const Atom &getNETVirtualRootsAtom() const { return net_virtual_roots; } |
101 | 104 | ||
102 | // root window messages | 105 | // root window messages |
103 | inline const Atom &getNETCloseWindowAtom(void) const { return net_close_window; } | 106 | inline const Atom &getNETCloseWindowAtom() const { return net_close_window; } |
104 | inline const Atom &getNETWMMoveResizeAtom(void) const { return net_wm_moveresize; } | 107 | inline const Atom &getNETWMMoveResizeAtom() const { return net_wm_moveresize; } |
105 | 108 | ||
106 | // application window properties | 109 | // application window properties |
107 | inline const Atom &getNETPropertiesAtom(void) const { return net_properties; } | 110 | inline const Atom &getNETPropertiesAtom() const { return net_properties; } |
108 | inline const Atom &getNETWMNameAtom(void) const { return net_wm_name; } | 111 | inline const Atom &getNETWMNameAtom() const { return net_wm_name; } |
109 | inline const Atom &getNETWMDesktopAtom(void) const { return net_wm_desktop; } | 112 | inline const Atom &getNETWMDesktopAtom() const { return net_wm_desktop; } |
110 | inline const Atom &getNETWMWindowTypeAtom(void) const { return net_wm_window_type; } | 113 | inline const Atom &getNETWMWindowTypeAtom() const { return net_wm_window_type; } |
111 | inline const Atom &getNETWMStateAtom(void) const { return net_wm_state; } | 114 | inline const Atom &getNETWMStateAtom() const { return net_wm_state; } |
112 | inline const Atom &getNETWMStrutAtom(void) const { return net_wm_strut; } | 115 | inline const Atom &getNETWMStrutAtom() const { return net_wm_strut; } |
113 | inline const Atom &getNETWMIconGeometryAtom(void) const { return net_wm_icon_geometry; } | 116 | inline const Atom &getNETWMIconGeometryAtom() const { return net_wm_icon_geometry; } |
114 | inline const Atom &getNETWMIconAtom(void) const { return net_wm_icon; } | 117 | inline const Atom &getNETWMIconAtom() const { return net_wm_icon; } |
115 | inline const Atom &getNETWMPidAtom(void) const { return net_wm_pid; } | 118 | inline const Atom &getNETWMPidAtom() const { return net_wm_pid; } |
116 | inline const Atom &getNETWMHandledIconsAtom(void) const { return net_wm_handled_icons; } | 119 | inline const Atom &getNETWMHandledIconsAtom() const { return net_wm_handled_icons; } |
117 | 120 | ||
118 | // application protocols | 121 | // application protocols |
119 | inline const Atom &getNETWMPingAtom(void) const { return net_wm_ping; } | 122 | inline const Atom &getNETWMPingAtom() const { return net_wm_ping; } |
120 | 123 | ||
121 | #endif // NEWWMSPEC | 124 | #endif // NEWWMSPEC |
122 | 125 | ||