summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDana Jansens <danakj@orodu.net>2003-02-11 20:20:01 +0000
committerDana Jansens <danakj@orodu.net>2003-02-11 20:20:01 +0000
commit7112755cfcda17e2c17360caf28407485e5befc0 (patch)
treeb9be2fb6ad7b79b50f5d992df81f40306906363c
parent15c2e7e2981f72bfc6b2c9456119759258b1b02f (diff)
add a comment regarding the client.area() being not-what-you-want
-rw-r--r--src/client.hh5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/client.hh b/src/client.hh
index ff119faf..8bbe2a91 100644
--- a/src/client.hh
+++ b/src/client.hh
@@ -622,6 +622,11 @@ BB @param window The window id that the Client class should handle
const otk::Size &logicalSize() const { return _logical_size; }
//! Returns the position and size of the client relative to the root window
+ /*!
+ Note that this value is *not* the size and position of the window's
+ frame, though the position will often line up.<br>
+ If you want the frame's area, use Frame::area() instead.
+ */
inline const otk::Rect &area() const { return _area; }
//! Returns the client's strut definition