svl/README

   1 Contains non-graphical helper code for office applications.
   2
   3 Specifically this module does not depend on or use includes from module
   4 vcl. Originally all code in svtools that did not depend on vcl was split
   5 off into this svl ("svtools light") module.
   6
   7 In particular the SfxItemSet is a property-bag like container that
   8 stores arbitrary sets of properties for everything from text run
   9 formats, to Chart regression line properties.
  10
  11 There are lots of other useful helpers in here for various office
  12 tasks; much of this code was originally moved from svx/sfx2.
  13
  14 == Items, Pools and Sets ==
  15
  16 === SfxPoolItem ===
  17
  18 A small reference counted piece of data.  Many subclasses, each with a
  19 unique integer to identify its type (WhichId).  Can be compared for equality
  20 (operator==), Clone()d, and converted to/from uno::Any (QueryValue/PutValue).
  21
  22 A pool item may have value semantics (SfxItemPoolFlags::POOLABLE), meaning that
  23 there will generally be only one instance that compares equal per item pool,
  24 or not, in which case the item will be Clone()d quite a bit.
  25
  26 === SfxItemPool ===
  27
  28 Usually there is one item pool per document, with a range of valid WhichIds
  29 that is specific to the type of document.
  30
  31 The item pool owns all instances of SfxPoolItem or its subclasses that have
  32 ever been added to an item set.  It also contains a default item for
  33 every WhichId, which will be (depending on parameters) returned from item
  34 sets if the set does not contain an item at this WhichId.
  35
  36 === SfxItemSet ===
  37
  38 The item set can be created with a user-supplied range of WhichIds; it
  39 will accept SfxPoolItems with matching WhichIds and ignore attempts to
  40 insert items with non-matching WhichIds.
  41
  42 Items that are successfully inserted into the set will be stored in the
  43 set's SfxItemPool, and for poolable items only a single instance that
  44 compares equal under the predicate operator== will be stored in the pool,
  45 regardless of how many sets contain it, thus conserving memory.
  46
  47 There are members m_pWhichRanges for the valid ranges (as pairs of WhichIds),
  48 m_nCount for the number of items contained, and m_pItems for the pointers to
  49 the actual items.
  50