summaryrefslogtreecommitdiff
path: root/include/core/output.h
diff options
context:
space:
mode:
authorSam Spilsbury <smspillaz@gmail.com>2010-03-24 17:37:19 +0800
committerSam Spilsbury <smspillaz@gmail.com>2010-03-24 17:37:19 +0800
commit3e45d4893e102d04f34ab90a8adfed813db60175 (patch)
tree986dee11d95ed8a5ff0831725169c30f2fd59399 /include/core/output.h
parent2de5a640661ec50f9c86f78b5664e8ddd24bd549 (diff)
downloadmobileperf-3e45d4893e102d04f34ab90a8adfed813db60175.tar.gz
mobileperf-3e45d4893e102d04f34ab90a8adfed813db60175.tar.bz2
Documentation update for CompIcon, ModifierHandler, CompOutput,
PluginClassStorage, PluginClassIndex, CompPoint, CompRect, CompRegion and CompSize
Diffstat (limited to 'include/core/output.h')
-rw-r--r--include/core/output.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/include/core/output.h b/include/core/output.h
index 093a822..a8ac41f 100644
--- a/include/core/output.h
+++ b/include/core/output.h
@@ -31,9 +31,11 @@
#include <core/core.h>
#include <core/rect.h>
-///
-/// Output to a device from Compiz
-///
+/**
+ * Represents a phisically attached screen in Compiz, where this
+ * phisical screen is part of an X11 screen in a configuration such
+ * as Xinerama, XRandR, TwinView or MergedFB
+ */
class CompOutput : public CompRect {
public:
@@ -43,6 +45,10 @@ class CompOutput : public CompRect {
unsigned int id () const;
+ /**
+ * Returns a "working area" of the screen, which the geometry
+ * which is not covered by strut windows (such as panels)
+ */
const CompRect& workArea () const;
void setWorkArea (const CompRect&);