summaryrefslogtreecommitdiff
path: root/svl
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /svl
parent33da78c21f4243a3e469fb7df79ed1745df70078 (diff)
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md and now, the contents of these files were changed to use Markdown format. Other than format inconsistency, some README.md files lacked information about modules, or were out of date. By using LibreOffice / OpenOffice wiki and other documentation websites, these files were updated. Now every README.md file has a title, and some description. The top-level README.md file is changed to add links to the modules. The result of processing the Markdown format README.md files can be seen at: https://docs.libreoffice.org/ Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424 Tested-by: Jenkins Reviewed-by: Michael Stahl <michael.stahl@allotropia.de> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'svl')
-rw-r--r--svl/README.md41
1 files changed, 21 insertions, 20 deletions
diff --git a/svl/README.md b/svl/README.md
index ce257747987b..984d6ecfe2f9 100644
--- a/svl/README.md
+++ b/svl/README.md
@@ -1,50 +1,51 @@
+# Non-Graphical Helper Code (svtools light)
+
Contains non-graphical helper code for office applications.
Specifically this module does not depend on or use includes from module
vcl. Originally all code in svtools that did not depend on vcl was split
off into this svl ("svtools light") module.
-In particular the SfxItemSet is a property-bag like container that
+In particular the `SfxItemSet` is a property-bag like container that
stores arbitrary sets of properties for everything from text run
formats, to Chart regression line properties.
There are lots of other useful helpers in here for various office
-tasks; much of this code was originally moved from svx/sfx2.
+tasks; much of this code was originally moved from `svx/sfx2`.
-== Items, Pools and Sets ==
+## Items, Pools and Sets
-=== SfxPoolItem ===
+### SfxPoolItem
A small reference counted piece of data. Many subclasses, each with a
-unique integer to identify its type (WhichId). Can be compared for equality
-(operator==), Clone()d, and converted to/from uno::Any (QueryValue/PutValue).
+unique integer to identify its type (`WhichId`). Can be compared for equality
+(`operator==`), `Clone()`d, and converted to/from `uno::Any` (`QueryValue/PutValue`).
A pool item may have value semantics ("poolable"), meaning that
there will generally be only one instance that compares equal per item pool,
-or not, in which case the item will be Clone()d quite a bit.
+or not, in which case the item will be `Clone()`d quite a bit.
-=== SfxItemPool ===
+### SfxItemPool
-Usually there is one item pool per document, with a range of valid WhichIds
+Usually there is one item pool per document, with a range of valid `WhichId`s
that is specific to the type of document.
-The item pool owns all instances of SfxPoolItem or its subclasses that have
+The item pool owns all instances of `SfxPoolItem` or its subclasses that have
ever been added to an item set. It also contains a default item for
every WhichId, which will be (depending on parameters) returned from item
-sets if the set does not contain an item at this WhichId.
+sets if the set does not contain an item at this `WhichId`.
-=== SfxItemSet ===
+### SfxItemSet
-The item set can be created with a user-supplied range of WhichIds; it
-will accept SfxPoolItems with matching WhichIds and ignore attempts to
-insert items with non-matching WhichIds.
+The item set can be created with a user-supplied range of `WhichId`s; it
+will accept `SfxPoolItems` with matching `WhichId`s and ignore attempts to
+insert items with non-matching `WhichId`s.
Items that are successfully inserted into the set will be stored in the
-set's SfxItemPool, and for poolable items only a single instance that
-compares equal under the predicate operator== will be stored in the pool,
+set's `SfxItemPool`, and for poolable items only a single instance that
+compares equal under the predicate `operator==` will be stored in the pool,
regardless of how many sets contain it, thus conserving memory.
-There are members m_pWhichRanges for the valid ranges (as pairs of WhichIds),
-m_nCount for the number of items contained, and m_pItems for the pointers to
+There are members `m_pWhichRanges` for the valid ranges (as pairs of `WhichId`s),
+`m_nCount` for the number of items contained, and `m_pItems` for the pointers to
the actual items.
-