summaryrefslogtreecommitdiff
path: root/include/svl/itempool.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'include/svl/itempool.hxx')
-rw-r--r--include/svl/itempool.hxx25
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,