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/Screen.hh | |
parent | 380d50ba274c0ceb0a2f973ea464792847a80e6d (diff) | |
download | fluxbox-56a41b23f9b5ecdef5e9536c2e6eeed0db32e623.zip fluxbox-56a41b23f9b5ecdef5e9536c2e6eeed0db32e623.tar.bz2 |
doxygen comments
Diffstat (limited to 'src/Screen.hh')
-rw-r--r-- | src/Screen.hh | 148 |
1 files changed, 74 insertions, 74 deletions
diff --git a/src/Screen.hh b/src/Screen.hh index 1f4cf89..051a002 100644 --- a/src/Screen.hh +++ b/src/Screen.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: Screen.hh,v 1.40 2002/08/02 12:52:44 fluxgen Exp $ | 25 | // $Id: Screen.hh,v 1.41 2002/08/04 15:55:13 fluxgen Exp $ |
26 | 26 | ||
27 | #ifndef SCREEN_HH | 27 | #ifndef SCREEN_HH |
28 | #define SCREEN_HH | 28 | #define SCREEN_HH |
@@ -70,82 +70,82 @@ public: | |||
70 | int scrn); | 70 | int scrn); |
71 | ~BScreen(); | 71 | ~BScreen(); |
72 | 72 | ||
73 | inline bool isToolbarOnTop(void) const { return *resource.toolbar_on_top; } | 73 | inline bool isToolbarOnTop() const { return *resource.toolbar_on_top; } |
74 | inline bool doToolbarAutoHide(void) const { return *resource.toolbar_auto_hide; } | 74 | inline bool doToolbarAutoHide() const { return *resource.toolbar_auto_hide; } |
75 | inline bool isSloppyFocus(void) const { return resource.sloppy_focus; } | 75 | inline bool isSloppyFocus() const { return resource.sloppy_focus; } |
76 | inline bool isSemiSloppyFocus(void) const { return resource.semi_sloppy_focus; } | 76 | inline bool isSemiSloppyFocus() const { return resource.semi_sloppy_focus; } |
77 | inline bool isRootColormapInstalled(void) const { return root_colormap_installed; } | 77 | inline bool isRootColormapInstalled() const { return root_colormap_installed; } |
78 | inline bool isScreenManaged(void) const { return managed; } | 78 | inline bool isScreenManaged() const { return managed; } |
79 | inline bool isTabRotateVertical(void) const { return *resource.tab_rotate_vertical; } | 79 | inline bool isTabRotateVertical() const { return *resource.tab_rotate_vertical; } |
80 | inline bool isSloppyWindowGrouping(void) const { return *resource.sloppy_window_grouping; } | 80 | inline bool isSloppyWindowGrouping() const { return *resource.sloppy_window_grouping; } |
81 | inline bool isWorkspaceWarping(void) const { return *resource.workspace_warping; } | 81 | inline bool isWorkspaceWarping() const { return *resource.workspace_warping; } |
82 | inline bool isDesktopWheeling(void) const { return *resource.desktop_wheeling; } | 82 | inline bool isDesktopWheeling() const { return *resource.desktop_wheeling; } |
83 | inline bool doAutoRaise(void) const { return resource.auto_raise; } | 83 | inline bool doAutoRaise() const { return resource.auto_raise; } |
84 | inline bool doImageDither(void) const { return *resource.image_dither; } | 84 | inline bool doImageDither() const { return *resource.image_dither; } |
85 | inline bool doMaxOverSlit(void) const { return *resource.max_over_slit; } | 85 | inline bool doMaxOverSlit() const { return *resource.max_over_slit; } |
86 | inline bool doOpaqueMove(void) const { return *resource.opaque_move; } | 86 | inline bool doOpaqueMove() const { return *resource.opaque_move; } |
87 | inline bool doFullMax(void) const { return *resource.full_max; } | 87 | inline bool doFullMax() const { return *resource.full_max; } |
88 | inline bool doFocusNew(void) const { return *resource.focus_new; } | 88 | inline bool doFocusNew() const { return *resource.focus_new; } |
89 | inline bool doFocusLast(void) const { return *resource.focus_last; } | 89 | inline bool doFocusLast() const { return *resource.focus_last; } |
90 | inline bool doShowWindowPos(void) const { return *resource.show_window_pos; } | 90 | inline bool doShowWindowPos() const { return *resource.show_window_pos; } |
91 | 91 | ||
92 | inline GC getOpGC() const { return theme->getOpGC(); } | 92 | inline GC getOpGC() const { return theme->getOpGC(); } |
93 | 93 | ||
94 | inline const FbTk::Color *getBorderColor(void) const { return &theme->getBorderColor(); } | 94 | inline const FbTk::Color *getBorderColor() const { return &theme->getBorderColor(); } |
95 | inline BImageControl *getImageControl(void) { return image_control; } | 95 | inline BImageControl *getImageControl() { return image_control; } |
96 | inline Rootmenu *getRootmenu(void) { return rootmenu; } | 96 | inline Rootmenu *getRootmenu() { return rootmenu; } |
97 | inline const std::string &getRootCommand(void ) const { return *resource.rootcommand; } | 97 | inline const std::string &getRootCommand(void ) const { return *resource.rootcommand; } |
98 | #ifdef SLIT | 98 | #ifdef SLIT |
99 | inline bool isSlitOnTop(void) const { return resource.slit_on_top; } | 99 | inline bool isSlitOnTop() const { return resource.slit_on_top; } |
100 | inline bool doSlitAutoHide(void) const { return resource.slit_auto_hide; } | 100 | inline bool doSlitAutoHide() const { return resource.slit_auto_hide; } |
101 | inline Slit *getSlit(void) { return slit; } | 101 | inline Slit *getSlit() { return slit; } |
102 | inline int getSlitPlacement(void) const { return resource.slit_placement; } | 102 | inline int getSlitPlacement() const { return resource.slit_placement; } |
103 | inline int getSlitDirection(void) const { return resource.slit_direction; } | 103 | inline int getSlitDirection() const { return resource.slit_direction; } |
104 | inline void saveSlitPlacement(int p) { resource.slit_placement = p; } | 104 | inline void saveSlitPlacement(int p) { resource.slit_placement = p; } |
105 | inline void saveSlitDirection(int d) { resource.slit_direction = d; } | 105 | inline void saveSlitDirection(int d) { resource.slit_direction = d; } |
106 | inline void saveSlitOnTop(bool t) { resource.slit_on_top = t; } | 106 | inline void saveSlitOnTop(bool t) { resource.slit_on_top = t; } |
107 | inline void saveSlitAutoHide(bool t) { resource.slit_auto_hide = t; } | 107 | inline void saveSlitAutoHide(bool t) { resource.slit_auto_hide = t; } |
108 | #ifdef XINERAMA | 108 | #ifdef XINERAMA |
109 | inline unsigned int getSlitOnHead(void) const { return resource.slit_on_head; } | 109 | inline unsigned int getSlitOnHead() const { return resource.slit_on_head; } |
110 | inline void saveSlitOnHead(unsigned int h) { resource.slit_on_head = h; } | 110 | inline void saveSlitOnHead(unsigned int h) { resource.slit_on_head = h; } |
111 | #endif // XINERAMA | 111 | #endif // XINERAMA |
112 | 112 | ||
113 | #endif // SLIT | 113 | #endif // SLIT |
114 | 114 | ||
115 | inline Toolbar *getToolbar(void) { return toolbar; } | 115 | inline Toolbar *getToolbar() { return toolbar; } |
116 | 116 | ||
117 | inline Workspace *getWorkspace(unsigned int w) { return ( w < workspacesList.size() ? workspacesList[w] : 0); } | 117 | inline Workspace *getWorkspace(unsigned int w) { return ( w < workspacesList.size() ? workspacesList[w] : 0); } |
118 | inline Workspace *getCurrentWorkspace(void) { return current_workspace; } | 118 | inline Workspace *getCurrentWorkspace() { return current_workspace; } |
119 | 119 | ||
120 | inline Workspacemenu *getWorkspacemenu(void) { return workspacemenu; } | 120 | inline Workspacemenu *getWorkspacemenu() { return workspacemenu; } |
121 | 121 | ||
122 | inline unsigned int getHandleWidth(void) const { return theme->getHandleWidth(); } | 122 | inline unsigned int getHandleWidth() const { return theme->getHandleWidth(); } |
123 | inline unsigned int getBevelWidth(void) const { return theme->getBevelWidth(); } | 123 | inline unsigned int getBevelWidth() const { return theme->getBevelWidth(); } |
124 | inline unsigned int getFrameWidth(void) const { return theme->getFrameWidth(); } | 124 | inline unsigned int getFrameWidth() const { return theme->getFrameWidth(); } |
125 | inline unsigned int getBorderWidth(void) const { return theme->getBorderWidth(); } | 125 | inline unsigned int getBorderWidth() const { return theme->getBorderWidth(); } |
126 | inline unsigned int getBorderWidth2x(void) const { return theme->getBorderWidth()*2; } | 126 | inline unsigned int getBorderWidth2x() const { return theme->getBorderWidth()*2; } |
127 | inline unsigned int getCurrentWorkspaceID() const { return current_workspace->workspaceID(); } | 127 | inline unsigned int getCurrentWorkspaceID() const { return current_workspace->workspaceID(); } |
128 | 128 | ||
129 | typedef std::vector<FluxboxWindow *> Icons; | 129 | typedef std::vector<FluxboxWindow *> Icons; |
130 | inline unsigned int getCount(void) const { return workspacesList.size(); } | 130 | inline unsigned int getCount() const { return workspacesList.size(); } |
131 | inline unsigned int getIconCount(void) const { return iconList.size(); } | 131 | inline unsigned int getIconCount() const { return iconList.size(); } |
132 | inline const Icons &getIconList(void) const { return iconList; } | 132 | inline const Icons &getIconList() const { return iconList; } |
133 | inline Icons &getIconList(void) { return iconList; } | 133 | inline Icons &getIconList() { return iconList; } |
134 | 134 | ||
135 | inline int getNumberOfWorkspaces(void) const { return *resource.workspaces; } | 135 | inline int getNumberOfWorkspaces() const { return *resource.workspaces; } |
136 | inline Toolbar::Placement getToolbarPlacement(void) const { return *resource.toolbar_placement; } | 136 | inline Toolbar::Placement getToolbarPlacement() const { return *resource.toolbar_placement; } |
137 | #ifdef XINERAMA | 137 | #ifdef XINERAMA |
138 | inline int getToolbarOnHead(void) { return *resource.toolbar_on_head; } | 138 | inline int getToolbarOnHead() { return *resource.toolbar_on_head; } |
139 | #endif // XINERAMA | 139 | #endif // XINERAMA |
140 | inline int getToolbarWidthPercent(void) const { return *resource.toolbar_width_percent; } | 140 | inline int getToolbarWidthPercent() const { return *resource.toolbar_width_percent; } |
141 | inline int getPlacementPolicy(void) const { return resource.placement_policy; } | 141 | inline int getPlacementPolicy() const { return resource.placement_policy; } |
142 | inline int getEdgeSnapThreshold(void) const { return *resource.edge_snap_threshold; } | 142 | inline int getEdgeSnapThreshold() const { return *resource.edge_snap_threshold; } |
143 | inline int getRowPlacementDirection(void) const { return resource.row_direction; } | 143 | inline int getRowPlacementDirection() const { return resource.row_direction; } |
144 | inline int getColPlacementDirection(void) const { return resource.col_direction; } | 144 | inline int getColPlacementDirection() const { return resource.col_direction; } |
145 | inline unsigned int getTabWidth(void) const { return *resource.tab_width; } | 145 | inline unsigned int getTabWidth() const { return *resource.tab_width; } |
146 | inline unsigned int getTabHeight(void) const { return *resource.tab_height; } | 146 | inline unsigned int getTabHeight() const { return *resource.tab_height; } |
147 | inline Tab::Placement getTabPlacement(void) const { return *resource.tab_placement; } | 147 | inline Tab::Placement getTabPlacement() const { return *resource.tab_placement; } |
148 | inline Tab::Alignment getTabAlignment(void) const { return *resource.tab_alignment; } | 148 | inline Tab::Alignment getTabAlignment() const { return *resource.tab_alignment; } |
149 | 149 | ||
150 | inline void setRootColormapInstalled(Bool r) { root_colormap_installed = r; } | 150 | inline void setRootColormapInstalled(Bool r) { root_colormap_installed = r; } |
151 | inline void saveRootCommand(std::string rootcmd) { *resource.rootcommand = rootcmd; } | 151 | inline void saveRootCommand(std::string rootcmd) { *resource.rootcommand = rootcmd; } |
@@ -179,37 +179,37 @@ public: | |||
179 | inline void saveSloppyWindowGrouping(bool s) { resource.sloppy_window_grouping = s; } | 179 | inline void saveSloppyWindowGrouping(bool s) { resource.sloppy_window_grouping = s; } |
180 | inline void saveWorkspaceWarping(bool s) { resource.workspace_warping = s; } | 180 | inline void saveWorkspaceWarping(bool s) { resource.workspace_warping = s; } |
181 | inline void saveDesktopWheeling(bool s) { resource.desktop_wheeling = s; } | 181 | inline void saveDesktopWheeling(bool s) { resource.desktop_wheeling = s; } |
182 | inline void iconUpdate(void) { iconmenu->update(); } | 182 | inline void iconUpdate() { iconmenu->update(); } |
183 | inline Iconmenu *getIconmenu(void) { return iconmenu; } | 183 | inline Iconmenu *getIconmenu() { return iconmenu; } |
184 | inline void setAutoGroupWindow(Window w = 0) { auto_group_window = w; } | 184 | inline void setAutoGroupWindow(Window w = 0) { auto_group_window = w; } |
185 | 185 | ||
186 | 186 | ||
187 | #ifdef HAVE_STRFTIME | 187 | #ifdef HAVE_STRFTIME |
188 | inline const char *getStrftimeFormat(void) { return resource.strftime_format.c_str(); } | 188 | inline const char *getStrftimeFormat() { return resource.strftime_format.c_str(); } |
189 | void saveStrftimeFormat(const char *format); | 189 | void saveStrftimeFormat(const char *format); |
190 | #else // !HAVE_STRFTIME | 190 | #else // !HAVE_STRFTIME |
191 | inline int getDateFormat(void) { return resource.date_format; } | 191 | inline int getDateFormat() { return resource.date_format; } |
192 | inline void saveDateFormat(int f) { resource.date_format = f; } | 192 | inline void saveDateFormat(int f) { resource.date_format = f; } |
193 | inline bool isClock24Hour(void) { return resource.clock24hour; } | 193 | inline bool isClock24Hour() { return resource.clock24hour; } |
194 | inline void saveClock24Hour(Bool c) { resource.clock24hour = c; } | 194 | inline void saveClock24Hour(Bool c) { resource.clock24hour = c; } |
195 | #endif // HAVE_STRFTIME | 195 | #endif // HAVE_STRFTIME |
196 | 196 | ||
197 | inline Theme::WindowStyle *getWindowStyle(void) { return &theme->getWindowStyle(); } | 197 | inline Theme::WindowStyle *getWindowStyle() { return &theme->getWindowStyle(); } |
198 | inline Theme::MenuStyle *getMenuStyle(void) { return &theme->getMenuStyle(); } | 198 | inline Theme::MenuStyle *getMenuStyle() { return &theme->getMenuStyle(); } |
199 | inline Theme::ToolbarStyle *getToolbarStyle(void) { return &theme->getToolbarStyle(); } | 199 | inline Theme::ToolbarStyle *getToolbarStyle() { return &theme->getToolbarStyle(); } |
200 | const Theme *getTheme() const { return theme; } | 200 | const Theme *getTheme() const { return theme; } |
201 | FluxboxWindow *getIcon(unsigned int index); | 201 | FluxboxWindow *getIcon(unsigned int index); |
202 | 202 | ||
203 | int addWorkspace(void); | 203 | int addWorkspace(); |
204 | int removeLastWorkspace(void); | 204 | int removeLastWorkspace(); |
205 | //scroll workspaces | 205 | //scroll workspaces |
206 | void nextWorkspace(const int delta); | 206 | void nextWorkspace(const int delta); |
207 | void prevWorkspace(const int delta); | 207 | void prevWorkspace(const int delta); |
208 | void rightWorkspace(const int delta); | 208 | void rightWorkspace(const int delta); |
209 | void leftWorkspace(const int delta); | 209 | void leftWorkspace(const int delta); |
210 | 210 | ||
211 | void removeWorkspaceNames(void); | 211 | void removeWorkspaceNames(); |
212 | void updateWorkspaceNamesAtom(void); | 212 | void updateWorkspaceNamesAtom(); |
213 | 213 | ||
214 | void addWorkspaceName(const char *name); | 214 | void addWorkspaceName(const char *name); |
215 | void addNetizen(Netizen *net); | 215 | void addNetizen(Netizen *net); |
@@ -223,19 +223,19 @@ public: | |||
223 | void reassociateWindow(FluxboxWindow *window, unsigned int workspace_id, bool ignore_sticky); | 223 | void reassociateWindow(FluxboxWindow *window, unsigned int workspace_id, bool ignore_sticky); |
224 | void prevFocus(int = 0); | 224 | void prevFocus(int = 0); |
225 | void nextFocus(int = 0); | 225 | void nextFocus(int = 0); |
226 | void raiseFocus(void); | 226 | void raiseFocus(); |
227 | void reconfigure(void); | 227 | void reconfigure(); |
228 | void rereadMenu(void); | 228 | void rereadMenu(); |
229 | void shutdown(void); | 229 | void shutdown(); |
230 | void showPosition(int, int); | 230 | void showPosition(int, int); |
231 | void showGeometry(unsigned int, unsigned int); | 231 | void showGeometry(unsigned int, unsigned int); |
232 | void hideGeometry(void); | 232 | void hideGeometry(); |
233 | 233 | ||
234 | FluxboxWindow* useAutoGroupWindow(void); | 234 | FluxboxWindow* useAutoGroupWindow(); |
235 | 235 | ||
236 | void updateNetizenCurrentWorkspace(void); | 236 | void updateNetizenCurrentWorkspace(); |
237 | void updateNetizenWorkspaceCount(void); | 237 | void updateNetizenWorkspaceCount(); |
238 | void updateNetizenWindowFocus(void); | 238 | void updateNetizenWindowFocus(); |
239 | void updateNetizenWindowAdd(Window, unsigned long); | 239 | void updateNetizenWindowAdd(Window, unsigned long); |
240 | void updateNetizenWindowDel(Window); | 240 | void updateNetizenWindowDel(Window); |
241 | void updateNetizenConfigNotify(XEvent *); | 241 | void updateNetizenConfigNotify(XEvent *); |
@@ -356,7 +356,7 @@ protected: | |||
356 | XFontSet createFontSet(char *); | 356 | XFontSet createFontSet(char *); |
357 | void readDatabaseFont(char *, char *, XFontStruct **); | 357 | void readDatabaseFont(char *, char *, XFontStruct **); |
358 | 358 | ||
359 | void initMenu(void); | 359 | void initMenu(); |
360 | 360 | ||
361 | 361 | ||
362 | }; | 362 | }; |