summaryrefslogtreecommitdiff
path: root/include/tools/gen.hxx
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.co.uk>2015-07-07 14:07:33 +0200
committerMiklos Vajna <vmiklos@collabora.co.uk>2015-07-07 14:08:16 +0200
commitf420d65b76a6c30bce1322215990890da119a8ce (patch)
tree45d6d1931c60bc438f3f2c1cca72d6b67746c618 /include/tools/gen.hxx
parent10a3db37377a68ec7529bbfbf876c852d58b7ae4 (diff)
vcl: document Rectangle's get vs Get differences
Change-Id: Icf08f96c8d21f98a6f5a5a83b07447755f32257a
Diffstat (limited to 'include/tools/gen.hxx')
-rw-r--r--include/tools/gen.hxx4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/tools/gen.hxx b/include/tools/gen.hxx
index 32e488ac63ff..9b624eeed378 100644
--- a/include/tools/gen.hxx
+++ b/include/tools/gen.hxx
@@ -377,7 +377,9 @@ public:
void SetSize( const Size& rSize );
inline Size GetSize() const;
+ /// Returns the difference between right and left, assuming the range is inclusive.
inline long GetWidth() const;
+ /// Returns the difference between bottom and top, assuming the range is inclusive.
inline long GetHeight() const;
Rectangle& Union( const Rectangle& rRect );
@@ -409,7 +411,9 @@ public:
// ONE
long getX() const { return nLeft; }
long getY() const { return nTop; }
+ /// Returns the difference between right and left, assuming the range includes one end, but not the other.
long getWidth() const { return nRight - nLeft; }
+ /// Returns the difference between bottom and top, assuming the range includes one end, but not the other.
long getHeight() const { return nBottom - nTop; }
void setX( long n ) { nRight += n-nLeft; nLeft = n; }
void setY( long n ) { nBottom += n-nTop; nTop = n; }