summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorSam Spilsbury <smspillaz@gmail.com>2010-03-24 09:31:41 +0800
committerSam Spilsbury <smspillaz@gmail.com>2010-03-24 09:31:41 +0800
commit2de5a640661ec50f9c86f78b5664e8ddd24bd549 (patch)
treed0b3c856c42a4c565c3d140b54a21238baedb9bc /include
parent25e7a62c04cfe129bb77a1ab7aad22059ef91ebd (diff)
downloadzcomp-2de5a640661ec50f9c86f78b5664e8ddd24bd549.tar.gz
zcomp-2de5a640661ec50f9c86f78b5664e8ddd24bd549.tar.bz2
Fixed some documentation
Diffstat (limited to 'include')
-rw-r--r--include/core/match.h10
-rw-r--r--include/core/window.h22
2 files changed, 22 insertions, 10 deletions
diff --git a/include/core/match.h b/include/core/match.h
index ba9c7f2..8949566 100644
--- a/include/core/match.h
+++ b/include/core/match.h
@@ -35,8 +35,9 @@ class CompWindow;
class CompDisplay;
/**
- * Matches windows based on properties similar to regular expressions.
- * TODO how do you get the list of windows that match it?
+ * Object which represents a series of window properties
+ * that can be matched in a window. Used for determining which
+ * windows to operate on, in core or in plugins
*/
class CompMatch {
public:
@@ -59,6 +60,11 @@ class CompMatch {
static const CompMatch emptyMatch;
void update ();
+
+ /**
+ * Returns true if the specified CompWindow has the properties
+ * specified in the match object
+ */
bool evaluate (CompWindow *window);
CompString toString () const;
diff --git a/include/core/window.h b/include/core/window.h
index 2338620..ab1cc88 100644
--- a/include/core/window.h
+++ b/include/core/window.h
@@ -156,7 +156,8 @@ struct CompStartupSequence;
#define CompWindowGrabExternalAppMask (1 << 4)
/**
- * TODO
+ * Enumeration value which represents
+ * how a window will be stacked by compiz
*/
enum CompStackingUpdateMode {
CompStackingUpdateModeNone = 0,
@@ -167,7 +168,8 @@ enum CompStackingUpdateMode {
};
/**
- * TODO
+ * Enumeration value used by CompWindow::windowNotify
+ * which specifies the type of event that occured.
*/
enum CompWindowNotify {
CompWindowNotifyMap,
@@ -194,7 +196,8 @@ enum CompWindowNotify {
};
/**
- * TODO
+ * Specifies the left, right, top and bottom positions of a window's
+ * geometry
*/
struct CompWindowExtents {
int left;
@@ -204,7 +207,7 @@ struct CompWindowExtents {
};
/**
- * TODO
+ * Specifies the area of the screen taken up by strut windows
*/
struct CompStruts {
XRectangle left;
@@ -214,7 +217,9 @@ struct CompStruts {
};
/**
- * TODO
+ * Wrappable core window functions. Derive from this class
+ * and overload these functions in order to have your function called
+ * after a core CompWindow function is called with the same name.
*/
class WindowInterface : public WrapableInterface<CompWindow, WindowInterface>
{
@@ -288,7 +293,8 @@ class CompWindow :
Window aboveId);
~CompWindow ();
- /* this is the geometry retrieved from the
+ /**
+ * Geometry retrieved from the
* last ConfigureNotify event received
*/
Geometry & geometry () const;
@@ -302,8 +308,8 @@ class CompWindow :
int height () const;
CompSize size () const;
- /* this is the
- * geometry last sent to the server
+ /**
+ * Geometry last sent to the server
*/
Geometry & serverGeometry () const;