add a comment regarding the client.area() being not-what-you-want

This commit is contained in:
Dana Jansens 2003-02-11 20:20:01 +00:00
parent 15c2e7e298
commit 7112755cfc

View file

@ -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