sc/README.md

   1 # Spreadsheet Application Code
   2
   3 You can dump some information in a dbgutil build:
   4
   5 ## Shortcuts
   6
   7 ### CTRL+SHIFT+F12
   8
   9 Dumps the column width of the first 20 columns.
  10
  11 ### CTRL+SHIFT+F11
  12
  13 Dumps the graphic objects and their position and size in pixel.
  14
  15 ### CTRL+SHIFT+F6
  16
  17 Dumps the SfxItemSet representing the cell properties' of the
  18 current selection as a xml file. The file will be named dump.xml
  19
  20 ## The Cache Format
  21
  22 ScDocument::StoreTabToCache allows storing the content (not the formatting)
  23 of a table to a binary cache format.
  24
  25 The format is column orientated which allows quick serialization of the table.
  26
  27 * Header:
  28     * Number of Columns: 64 bit unsigned integer
  29
  30 * Column:
  31     * Column Index: 64 bit unsigned integer
  32     * Column Size: 64 bit unsigned integer
  33     * For each cell type block a new ColumnBlock
  34
  35 * ColumnBlock:
  36     * Start Row: 64 bit unsigned integer
  37     * Block Size: 64 bit unsigned integer
  38     * Type: 8 bit unsigned integer
  39         - 0 : empty
  40         - 1 : numeric
  41             * for each cell: 64 bit IEEE 754 double precision value
  42         - 2 : string
  43             * for each cell: 32 bit signed string length followed by string length bytes of the string (UTF-8)
  44         - 3 : formula
  45             * for each cell: 32 bit signed string length followed by the formula in R1C1 notation as a string
  46
  47 ## Functions Supporting Wildcards or Regular Expressions
  48
  49 As this comes up every now and then, and rather should be documented in an
  50 extra list of the Help system, functions that support Wildcards or Regular
  51 Expressions *and* depend on the setting under
  52 Tools -> Options -> Calc -> Calculate are those that in ODF OpenFormula (ODFF)
  53 are defined to depend on the HOST-USE-REGULAR-EXPRESSIONS or HOST-USE-WILDCARDS
  54 properties, see ODF v1.3 part4 3.4 Host-Defined Behaviors
  55 https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part4-formula/OpenDocument-v1.3-os-part4-formula.html#__RefHeading__1017868_715980110
  56
  57 * Database Functions
  58   * DAVERAGE
  59   * DCOUNT
  60   * DCOUNTA
  61   * DGET
  62   * DMAX
  63   * DMIN
  64   * DPRODUCT
  65   * DSTDEV
  66   * DSTDEVP
  67   * DSUM
  68   * DVAR
  69   * DVARP
  70 * Information Functions
  71   * COUNTIF
  72   * COUNTIFS
  73 * Lookup Functions
  74   * HLOOKUP
  75   * LOOKUP
  76   * MATCH
  77   * VLOOKUP
  78 * Mathematical Functions
  79   * SUMIF
  80   * SUMIFS
  81 * Statistical Functions
  82   * AVERAGEIF
  83   * AVERAGEIFS
  84 * Text Functions
  85   * SEARCH
  86