diff options
author | Thorsten Behrens <tbehrens@suse.com> | 2013-08-01 11:01:00 +0200 |
---|---|---|
committer | Thorsten Behrens <tbehrens@suse.com> | 2013-08-01 11:01:53 +0200 |
commit | 44cd56e0ac1c1683e55b930f862c64f6da356779 (patch) | |
tree | 761c64462f42942b525ddffa870b996c5f9e4dd7 /include/svl | |
parent | 3bade6b47973a228723b240b9410f15891487812 (diff) |
Doxygenize some docs, translate to English while at it.
Change-Id: I977981bb45da1599e8d46bd8d961dcbb01ebd99b
Diffstat (limited to 'include/svl')
-rw-r--r-- | include/svl/itempool.hxx | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/include/svl/itempool.hxx b/include/svl/itempool.hxx index ab9ff84d173d..80c1faf88b57 100644 --- a/include/svl/itempool.hxx +++ b/include/svl/itempool.hxx @@ -151,6 +151,31 @@ public: virtual SfxMapUnit GetMetric( sal_uInt16 nWhich ) const; void SetDefaultMetric( SfxMapUnit eNewMetric ); + + /** Request string representation of pool items + + This virtual function produces a string representation, of + from the respective SfxItemPool subclass' known SfxPoolItems. + + Subclasses, please overwrite this method, and handle + SfxPoolItems that don't return useful/complete information on + SfxPoolItem::GetPresentation() + + This baseclass yields the unmodified string representation of + rItem. + + @param[in] rItem + SfxPoolItem to query the string representation of + + @param[in] ePresent + requested kind of representation - see SfxItemPresentation + + @param[in] eMetric + requested unit of measure of the representation + + @param[out] rText + string representation of 'rItem' + */ virtual SfxItemPresentation GetPresentation( const SfxPoolItem& rItem, SfxItemPresentation ePresentation, SfxMapUnit ePresentationMetric, |