sc drawstyles: Maintain comment formatting with styles

Up to now the look of comments was maintained with the comment
shape's DF, with the default formatting being reapplied on
import (for hidden comments), on changing Tools > Options... >
LibreOffice > AC > Notes background, and on changing the
default cell style, while keeping the user-applied DF to some
extent. However, as we attempt to support drawing styles, this
approach is no longer viable, as applying DF on top of styles
at random times makes styles useless in the context of
comments.

(One might argue, that the look of comments should ideally be
treated as an app view setting, and not as a formatting of an
individual shape. This definitely makes sense, but has compat.
implications, as both LO and Excel allow formatting individual
comments (e.g. show a comment, right click > Area...). However
we will probably do it anyway if we ever implement threaded
comments like in recent Excel [1], as the callout shape based
approach seems to not scale to it.)

One way around it could be to explicitly disable any style
interaction with comments. But this will be unfortunate, as
styles have a clear advantage of being able to consistently
maintain the same formatting for several elements, much more
that the fragile approach of mixing the default formatting and
user-applied formatting in the same formatting layer. Not to
mention the possibility to define several custom styles. In
addition there is a request in tdf#55682 to disconnect the
formatting of comments from the default cell style, having a
dedicated style instead, which I find reasonable.

So this commit introduces a comment style, and uses it for new
comments instead of DF, making it easy to format all comments at
once. And a style based formatting is never overriden with DF,
unless explicitly set by the user. Changing Tools > Options... >
LibreOffice > AC > Notes background still has an effect in two
ways: (1) Sets the default background of the comment style for new
documents, and (2) if changed while a document is open, changes
also the comment style of the current document. An undo action
is also added, in case changing the current document wasn't
deliberate. Changing the default cell style no longer has any
effect on comment formatting.

One unfortunate side effect of this change, is that newly
created and permanently visible comments will lose their
default look when opened in an older version. But there is not
much I can do here, as older versions don't support styles, and
I believe the advantage of using styles outweigh this concern.
Hidden comments are not affected by this.

[1] see https://support.microsoft.com/en-us/office/the-difference-between-threaded-comments-and-notes-75a51eec-4092-42ab-abf8-7669077b7be3

Change-Id: I84215791b9e6ce393c6d979aa2b19ef70c76dff9
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/150352
Tested-by: Jenkins
Reviewed-by: Maxim Monastirsky <momonasmon@gmail.com>
7 files changed
tree: 0716bc9ea72532d4fded3920742c6fa1ee5e58f5
  1. .git-hooks/
  2. .github/
  3. .vscode/
  4. accessibility/
  5. android/
  6. animations/
  7. apple_remote/
  8. avmedia/
  9. basctl/
  10. basegfx/
  11. basic/
  12. bean/
  13. bin/
  14. binaryurp/
  15. bridges/
  16. canvas/
  17. chart2/
  18. cli_ure/
  19. codemaker/
  20. comphelper/
  21. compilerplugins/
  22. config_host/
  23. configmgr/
  24. connectivity/
  25. cppcanvas/
  26. cppu/
  27. cppuhelper/
  28. cpputools/
  29. cui/
  30. dbaccess/
  31. desktop/
  32. distro-configs/
  33. docmodel/
  34. drawinglayer/
  35. editeng/
  36. embeddedobj/
  37. embedserv/
  38. emfio/
  39. eventattacher/
  40. extensions/
  41. external/
  42. extras/
  43. filter/
  44. forms/
  45. formula/
  46. fpicker/
  47. framework/
  48. helpcompiler/
  49. hwpfilter/
  50. i18nlangtag/
  51. i18npool/
  52. i18nutil/
  53. icon-themes/
  54. idl/
  55. idlc/
  56. include/
  57. instsetoo_native/
  58. io/
  59. ios/
  60. javaunohelper/
  61. jurt/
  62. jvmaccess/
  63. jvmfwk/
  64. l10ntools/
  65. librelogo/
  66. libreofficekit/
  67. lingucomponent/
  68. linguistic/
  69. lotuswordpro/
  70. m4/
  71. nlpsolver/
  72. o3tl/
  73. odk/
  74. offapi/
  75. officecfg/
  76. onlineupdate/
  77. oovbaapi/
  78. oox/
  79. opencl/
  80. osx/
  81. package/
  82. pch/
  83. postprocess/
  84. pyuno/
  85. qadevOOo/
  86. readlicense_oo/
  87. registry/
  88. remotebridges/
  89. reportbuilder/
  90. reportdesign/
  91. ridljar/
  92. sal/
  93. salhelper/
  94. sax/
  95. sc/
  96. scaddins/
  97. sccomp/
  98. schema/
  99. scp2/
  100. scripting/
  101. sd/
  102. sdext/
  103. setup_native/
  104. sfx2/
  105. shell/
  106. slideshow/
  107. smoketest/
  108. solenv/
  109. soltools/
  110. sot/
  111. starmath/
  112. static/
  113. stoc/
  114. store/
  115. svgio/
  116. svl/
  117. svtools/
  118. svx/
  119. sw/
  120. swext/
  121. sysui/
  122. test/
  123. testtools/
  124. toolkit/
  125. tools/
  126. ucb/
  127. ucbhelper/
  128. udkapi/
  129. uitest/
  130. UnoControls/
  131. unodevtools/
  132. unoidl/
  133. unoil/
  134. unotest/
  135. unotools/
  136. unoxml/
  137. ure/
  138. uui/
  139. vbahelper/
  140. vcl/
  141. winaccessibility/
  142. wizards/
  143. writerfilter/
  144. writerperfect/
  145. xmerge/
  146. xmlhelp/
  147. xmloff/
  148. xmlreader/
  149. xmlscript/
  150. xmlsecurity/
  151. .buckconfig
  152. .buckversion
  153. .clang-format
  154. .editorconfig
  155. .git-blame-ignore-revs
  156. .gitattributes
  157. .gitignore
  158. .gitmodules
  159. .gitpod.dockerfile
  160. .gitpod.yml
  161. .gitreview
  162. antivirusDetection.vbs
  163. autogen.sh
  164. BUCK
  165. config.guess
  166. config.sub
  167. config_host.mk.in
  168. config_host_lang.mk.in
  169. configure.ac
  170. COPYING
  171. COPYING.LGPL
  172. COPYING.MPL
  173. cpp.hint
  174. download.lst
  175. g
  176. hardened_runtime.xcent.in
  177. install-sh
  178. install_deps.sh
  179. leak-suppress.txt
  180. Library_merged.mk
  181. lo.xcent.in
  182. logerrit
  183. Makefile.fetch
  184. Makefile.gbuild
  185. Makefile.in
  186. README.cross
  187. README.help.md
  188. README.md
  189. README.Solaris
  190. Repository.mk
  191. RepositoryExternal.mk
  192. RepositoryFixes.mk
  193. RepositoryModule_build.mk
  194. RepositoryModule_host.mk
  195. sanitize-ubsan-excludelist
  196. setup.cfg
  197. TEMPLATE.SOURCECODE.HEADER
  198. tsan-suppress.txt
README.md

LibreOffice

Coverity Scan Build Status CII Best Practices Translation status

LibreOffice is an integrated office suite based on copyleft licenses and compatible with most document formats and standards. Libreoffice is backed by The Document Foundation, which represents a large independent community of enterprises, developers and other volunteers moved by the common goal of bringing to the market the best software for personal productivity. LibreOffice is open source, and free to download, use and distribute.

A quick overview of the LibreOffice code structure.

Overview

You can develop for LibreOffice in one of two ways, one recommended and one much less so. First the somewhat less recommended way: it is possible to use the SDK to develop an extension, for which you can read the API docs and Developers Guide. This re-uses the (extremely generic) UNO APIs that are also used by macro scripting in StarBasic.

The best way to add a generally useful feature to LibreOffice is to work on the code base however. Overall this way makes it easier to compile and build your code, it avoids any arbitrary limitations of our scripting APIs, and in general is far more simple and intuitive - if you are a reasonably able C++ programmer.

The Build Chain and Runtime Baselines

These are the current minimal operating system and compiler versions to run and compile LibreOffice, also used by the TDF builds:

  • Windows:
    • Runtime: Windows 7
    • Build: Cygwin + Visual Studio 2019 version 16.10
  • macOS:
    • Runtime: 10.15
    • Build: 12 (13 for aarch64) + Xcode 14
  • Linux:
    • Runtime: RHEL 7 or CentOS 7
    • Build: either GCC 7.0.0; or Clang 8.0.1 with libstdc++ 7.3.0
  • iOS (only for LibreOfficeKit):
    • Runtime: 11.4 (only support for newer i devices == 64 bit)
    • Build: Xcode 9.3 and iPhone SDK 11.4
  • Android:
    • Build: NDK r23 and SDK 30.0.3
  • Emscripten / WASM:
    • Runtime: a browser with SharedMemory support (threads + atomics)
    • Build: Qt 5.15 with Qt supported Emscripten 1.39.8
    • See README.wasm

Java is required for building many parts of LibreOffice. In TDF Wiki article Development/Java, the exact modules that depend on Java are listed.

The baseline for Java is Java Development Kit (JDK) Version 11 or later. It is possible to build LibreOffice with JDK version 9, but it is no longer supported by the JDK vendors, thus it should be avoided.

If you want to use Clang with the LibreOffice compiler plugins, the minimal version of Clang is 12.0.1. Since Xcode doesn't provide the compiler plugin headers, you have to compile your own Clang to use them on macOS.

You can find the TDF configure switches in the distro-configs/ directory.

To setup your initial build environment on Windows and macOS, we provide the LibreOffice Development Environment (LODE) scripts.

For more information see the build instructions for your platform in the TDF wiki.

The Important Bits of Code

Each module should have a README.md file inside it which has some degree of documentation for that module; patches are most welcome to improve those. We have those turned into a web page here:

https://docs.libreoffice.org/

However, there are two hundred modules, many of them of only peripheral interest for a specialist audience. So - where is the good stuff, the code that is most useful. Here is a quick overview of the most important ones:

ModuleDescription
sal/this provides a simple System Abstraction Layer
tools/this provides basic internal types: Rectangle, Color etc.
vcl/this is the widget toolkit library and one rendering abstraction
framework/UNO framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from /uiconfig/ files
sfx2/legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
svx/drawing model related helper code, including much of Draw/Impress

Then applications

ModuleDescription
desktop/this is where the main() for the application lives, init / bootstrap. the name dates back to an ancient StarOffice that also drew a desktop
sw/Writer
sc/Calc
sd/Draw / Impress

There are several other libraries that are helpful from a graphical perspective:

ModuleDescription
basegfx/algorithms and data-types for graphics as used in the canvas
canvas/new (UNO) canvas rendering model with various backends
cppcanvas/C++ helper classes for using the UNO canvas
drawinglayer/View code to render drawable objects and break them down into primitives we can render more easily.

Rules for #include Directives (C/C++)

Use the "..." form if and only if the included file is found next to the including file. Otherwise, use the <...> form. (For further details, see the mail Re: C[++]: Normalizing include syntax ("" vs <>).)

The UNO API include files should consistently use double quotes, for the benefit of external users of this API.

loplugin:includeform (compilerplugins/clang/includeform.cxx) enforces these rules.

Finding Out More

Beyond this, you can read the README.md files, send us patches, ask on the mailing list libreoffice@lists.freedesktop.org (no subscription required) or poke people on IRC #libreoffice-dev on irc.libera.chat - we're a friendly and generally helpful mob. We know the code can be hard to get into at first, and so there are no silly questions.