include/vcl/settings.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_SETTINGS_HXX
  21 #define INCLUDED_VCL_SETTINGS_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <tools/color.hxx>
  25 #include <tools/gen.hxx>
  26 #include <o3tl/typed_flags_set.hxx>
  27
  28 #include <memory>
  29 #include <vector>
  30
  31 #include <optional>
  32
  33 class BitmapEx;
  34 class LanguageTag;
  35 class SvtSysLocale;
  36
  37 class LocaleDataWrapper;
  38 struct ImplMouseData;
  39 struct ImplMiscData;
  40 struct ImplHelpData;
  41 struct ImplStyleData;
  42 struct ImplAllSettingsData;
  43 enum class ConfigurationHints;
  44
  45 namespace vcl {
  46     class Font;
  47     class I18nHelper;
  48     class IconThemeInfo;
  49 }
  50
  51
  52 enum class MouseSettingsOptions
  53 {
  54     NONE           = 0x00,
  55     AutoCenterPos  = 0x02,
  56     AutoDefBtnPos  = 0x04,
  57 };
  58 namespace o3tl
  59 {
  60     template<> struct typed_flags<MouseSettingsOptions> : is_typed_flags<MouseSettingsOptions, 0x06> {};
  61 }
  62
  63 enum class MouseFollowFlags
  64 {
  65     Menu           = 0x0001,
  66 };
  67 namespace o3tl
  68 {
  69     template<> struct typed_flags<MouseFollowFlags> : is_typed_flags<MouseFollowFlags, 0x01> {};
  70 }
  71
  72 enum class MouseMiddleButtonAction
  73 {
  74     Nothing, AutoScroll, PasteSelection
  75 };
  76
  77 enum class MouseWheelBehaviour
  78 {
  79     Disable, FocusOnly, ALWAYS
  80 };
  81
  82 class VCL_DLLPUBLIC MouseSettings
  83 {
  84 private:
  85     void                            CopyData();
  86     std::shared_ptr<ImplMouseData>  mxData;
  87
  88 public:
  89                                     MouseSettings();
  90
  91     void                            SetOptions( MouseSettingsOptions nOptions );
  92     MouseSettingsOptions            GetOptions() const;
  93
  94     void                            SetDoubleClickTime( sal_uInt64 nDoubleClkTime );
  95     sal_uInt64                      GetDoubleClickTime() const;
  96
  97     void                            SetDoubleClickWidth( sal_Int32 nDoubleClkWidth );
  98     sal_Int32                       GetDoubleClickWidth() const;
  99
 100     void                            SetDoubleClickHeight( sal_Int32 nDoubleClkHeight );
 101     sal_Int32                       GetDoubleClickHeight() const;
 102
 103     void                            SetStartDragWidth( sal_Int32 nDragWidth );
 104     sal_Int32                       GetStartDragWidth() const;
 105
 106     void                            SetStartDragHeight( sal_Int32 nDragHeight );
 107     sal_Int32                       GetStartDragHeight() const;
 108
 109     static sal_uInt16               GetStartDragCode();
 110
 111     static sal_uInt16               GetContextMenuCode();
 112
 113     static sal_uInt16               GetContextMenuClicks();
 114
 115     static sal_Int32                GetScrollRepeat();
 116
 117     static sal_Int32                GetButtonStartRepeat();
 118
 119     void                            SetButtonRepeat( sal_Int32 nRepeat );
 120     sal_Int32                       GetButtonRepeat() const;
 121
 122     static sal_Int32                GetActionDelay();
 123
 124     void                            SetMenuDelay( sal_Int32 nDelay );
 125     sal_Int32                       GetMenuDelay() const;
 126
 127     void                            SetFollow( MouseFollowFlags nFollow );
 128     MouseFollowFlags                GetFollow() const;
 129
 130     void                            SetMiddleButtonAction( MouseMiddleButtonAction nAction );
 131     MouseMiddleButtonAction         GetMiddleButtonAction() const;
 132
 133     void                            SetWheelBehavior( MouseWheelBehaviour nBehavior );
 134     MouseWheelBehaviour             GetWheelBehavior() const;
 135
 136     bool                            operator ==( const MouseSettings& rSet ) const;
 137     bool                            operator !=( const MouseSettings& rSet ) const;
 138 };
 139
 140 struct DialogStyle
 141 {
 142     int content_area_border;
 143     int button_spacing;
 144     int action_area_border;
 145     DialogStyle()
 146         : content_area_border(2)
 147         , button_spacing(6)
 148         , action_area_border(5)
 149     {}
 150 };
 151
 152 enum class StyleSettingsOptions
 153 {
 154     NONE           = 0x0000,
 155     Mono           = 0x0001,
 156     NoMnemonics    = 0x0002,
 157 };
 158 namespace o3tl
 159 {
 160     template<> struct typed_flags<StyleSettingsOptions> : is_typed_flags<StyleSettingsOptions, 0x0003> {};
 161 }
 162
 163 enum class DragFullOptions
 164 {
 165     NONE        = 0x0000,
 166     WindowMove  = 0x0001,
 167     WindowSize  = 0x0002,
 168     Docking     = 0x0010,
 169     Split       = 0x0020,
 170     Scroll      = 0x0040,
 171     All         = WindowMove | WindowSize | Docking | Split | Scroll,
 172 };
 173 namespace o3tl
 174 {
 175     template<> struct typed_flags<DragFullOptions> : is_typed_flags<DragFullOptions, 0x0073> {};
 176 }
 177
 178 enum class SelectionOptions
 179 {
 180     NONE       = 0x0000,
 181     ShowFirst  = 0x0004,
 182 };
 183 namespace o3tl
 184 {
 185     template<> struct typed_flags<SelectionOptions> : is_typed_flags<SelectionOptions, 0x0004> {};
 186 }
 187
 188 enum class DisplayOptions
 189 {
 190     NONE        = 0x0000,
 191     AADisable   = 0x0001,
 192 };
 193 namespace o3tl
 194 {
 195     template<> struct typed_flags<DisplayOptions> : is_typed_flags<DisplayOptions, 0x0001> {};
 196 }
 197
 198 enum class ToolbarIconSize
 199 {
 200     Unknown      = 0,
 201     Small        = 1, // unused
 202     Large        = 2,
 203     Size32       = 3,
 204 };
 205
 206 #define STYLE_CURSOR_NOBLINKTIME    SAL_MAX_UINT64
 207
 208 class VCL_DLLPUBLIC StyleSettings
 209 {
 210     void                            CopyData();
 211
 212 private:
 213     std::shared_ptr<ImplStyleData>  mxData;
 214
 215 public:
 216                                     StyleSettings();
 217
 218     void                            Set3DColors( const Color& rColor );
 219
 220     void                            SetFaceColor( const Color& rColor );
 221     const Color&                    GetFaceColor() const;
 222
 223     Color                           GetFaceGradientColor() const;
 224
 225     Color                           GetSeparatorColor() const;
 226
 227     void                            SetCheckedColor( const Color& rColor );
 228     void                            SetCheckedColorSpecialCase( );
 229     const Color&                    GetCheckedColor() const;
 230
 231     void                            SetLightColor( const Color& rColor );
 232     const Color&                    GetLightColor() const;
 233
 234     void                            SetLightBorderColor( const Color& rColor );
 235     const Color&                    GetLightBorderColor() const;
 236
 237     void                            SetShadowColor( const Color& rColor );
 238     const Color&                    GetShadowColor() const;
 239
 240     void                            SetDarkShadowColor( const Color& rColor );
 241     const Color&                    GetDarkShadowColor() const;
 242
 243     void                            SetDefaultButtonTextColor( const Color& rColor );
 244     const Color&                    GetDefaultButtonTextColor() const;
 245
 246     void                            SetButtonTextColor( const Color& rColor );
 247     const Color&                    GetButtonTextColor() const;
 248
 249     void                            SetDefaultActionButtonTextColor( const Color& rColor );
 250     const Color&                    GetDefaultActionButtonTextColor() const;
 251
 252     void                            SetActionButtonTextColor( const Color& rColor );
 253     const Color&                    GetActionButtonTextColor() const;
 254
 255     void                            SetFlatButtonTextColor( const Color& rColor );
 256     const Color&                    GetFlatButtonTextColor() const;
 257
 258     void                            SetDefaultButtonRolloverTextColor( const Color& rColor );
 259     const Color&                    GetDefaultButtonRolloverTextColor() const;
 260
 261     void                            SetButtonRolloverTextColor( const Color& rColor );
 262     const Color&                    GetButtonRolloverTextColor() const;
 263
 264     void                            SetDefaultActionButtonRolloverTextColor( const Color& rColor );
 265     const Color&                    GetDefaultActionButtonRolloverTextColor() const;
 266
 267     void                            SetActionButtonRolloverTextColor( const Color& rColor );
 268     const Color&                    GetActionButtonRolloverTextColor() const;
 269
 270     void                            SetFlatButtonRolloverTextColor( const Color& rColor );
 271     const Color&                    GetFlatButtonRolloverTextColor() const;
 272
 273     void                            SetDefaultButtonPressedRolloverTextColor( const Color& rColor );
 274     const Color&                    GetDefaultButtonPressedRolloverTextColor() const;
 275
 276     void                            SetButtonPressedRolloverTextColor( const Color& rColor );
 277     const Color&                    GetButtonPressedRolloverTextColor() const;
 278
 279     void                            SetDefaultActionButtonPressedRolloverTextColor( const Color& rColor );
 280     const Color&                    GetDefaultActionButtonPressedRolloverTextColor() const;
 281
 282     void                            SetActionButtonPressedRolloverTextColor( const Color& rColor );
 283     const Color&                    GetActionButtonPressedRolloverTextColor() const;
 284
 285     void                            SetFlatButtonPressedRolloverTextColor( const Color& rColor );
 286     const Color&                    GetFlatButtonPressedRolloverTextColor() const;
 287
 288     void                            SetRadioCheckTextColor( const Color& rColor );
 289     const Color&                    GetRadioCheckTextColor() const;
 290
 291     void                            SetGroupTextColor( const Color& rColor );
 292     const Color&                    GetGroupTextColor() const;
 293
 294     void                            SetLabelTextColor( const Color& rColor );
 295     const Color&                    GetLabelTextColor() const;
 296
 297     void                            SetWindowColor( const Color& rColor );
 298     const Color&                    GetWindowColor() const;
 299
 300     void                            SetWindowTextColor( const Color& rColor );
 301     const Color&                    GetWindowTextColor() const;
 302
 303     void                            SetDialogColor( const Color& rColor );
 304     const Color&                    GetDialogColor() const;
 305
 306     void                            SetDialogTextColor( const Color& rColor );
 307     const Color&                    GetDialogTextColor() const;
 308
 309     void                            SetWorkspaceColor( const Color& rColor );
 310     const Color&                    GetWorkspaceColor() const;
 311
 312     void                            SetFieldColor( const Color& rColor );
 313     const Color&                    GetFieldColor() const;
 314
 315     void                            SetFieldTextColor( const Color& rColor );
 316     const Color&                    GetFieldTextColor() const;
 317
 318     void                            SetFieldRolloverTextColor( const Color& rColor );
 319     const Color&                    GetFieldRolloverTextColor() const;
 320
 321     void                            SetActiveColor( const Color& rColor );
 322     const Color&                    GetActiveColor() const;
 323
 324     void                            SetActiveTextColor( const Color& rColor );
 325     const Color&                    GetActiveTextColor() const;
 326
 327     void                            SetActiveBorderColor( const Color& rColor );
 328     const Color&                    GetActiveBorderColor() const;
 329
 330     void                            SetDeactiveColor( const Color& rColor );
 331     const Color&                    GetDeactiveColor() const;
 332
 333     void                            SetDeactiveTextColor( const Color& rColor );
 334     const Color&                    GetDeactiveTextColor() const;
 335
 336     void                            SetDeactiveBorderColor( const Color& rColor );
 337     const Color&                    GetDeactiveBorderColor() const;
 338
 339     void                            SetAccentColor( const Color& rColor );
 340     const Color&                    GetAccentColor() const;
 341
 342     void                            SetHighlightColor( const Color& rColor );
 343     const Color&                    GetHighlightColor() const;
 344
 345     void                            SetHighlightTextColor( const Color& rColor );
 346     const Color&                    GetHighlightTextColor() const;
 347
 348     void                            SetDisableColor( const Color& rColor );
 349     const Color&                    GetDisableColor() const;
 350
 351     void                            SetWarningColor( const Color& rColor );
 352     const Color&                    GetWarningColor() const;
 353
 354     void                            SetHelpColor( const Color& rColor );
 355     const Color&                    GetHelpColor() const;
 356
 357     void                            SetHelpTextColor( const Color& rColor );
 358     const Color&                    GetHelpTextColor() const;
 359
 360     void                            SetMenuColor( const Color& rColor );
 361     const Color&                    GetMenuColor() const;
 362
 363     void                            SetMenuBarColor( const Color& rColor );
 364     const Color&                    GetMenuBarColor() const;
 365
 366     void                            SetMenuBarRolloverColor( const Color& rColor );
 367     const Color&                    GetMenuBarRolloverColor() const;
 368
 369     void                            SetMenuBorderColor( const Color& rColor );
 370     const Color&                    GetMenuBorderColor() const;
 371
 372     void                            SetMenuTextColor( const Color& rColor );
 373     const Color&                    GetMenuTextColor() const;
 374
 375     void                            SetMenuBarTextColor( const Color& rColor );
 376     const Color&                    GetMenuBarTextColor() const;
 377
 378     void                            SetMenuBarRolloverTextColor( const Color& rColor );
 379     const Color&                    GetMenuBarRolloverTextColor() const;
 380
 381     void                            SetMenuBarHighlightTextColor( const Color& rColor );
 382     const Color&                    GetMenuBarHighlightTextColor() const;
 383
 384     void                            SetMenuHighlightColor( const Color& rColor );
 385     const Color&                    GetMenuHighlightColor() const;
 386
 387     void                            SetMenuHighlightTextColor( const Color& rColor );
 388     const Color&                    GetMenuHighlightTextColor() const;
 389
 390     void                            SetListBoxWindowBackgroundColor( const Color& rColor );
 391     const Color&                    GetListBoxWindowBackgroundColor() const;
 392
 393     void                            SetListBoxWindowTextColor( const Color& rColor );
 394     const Color&                    GetListBoxWindowTextColor() const;
 395
 396     void                            SetListBoxWindowHighlightColor( const Color& rColor );
 397     const Color&                    GetListBoxWindowHighlightColor() const;
 398
 399     void                            SetListBoxWindowHighlightTextColor( const Color& rColor );
 400     const Color&                    GetListBoxWindowHighlightTextColor() const;
 401
 402     void                            SetTabTextColor( const Color& rColor );
 403     const Color&                    GetTabTextColor() const;
 404
 405     void                            SetTabRolloverTextColor( const Color& rColor );
 406     const Color&                    GetTabRolloverTextColor() const;
 407
 408     void                            SetTabHighlightTextColor( const Color& rColor );
 409     const Color&                    GetTabHighlightTextColor() const;
 410
 411     void                            SetToolTextColor( const Color& rColor );
 412     const Color&                    GetToolTextColor() const;
 413
 414     void                            SetLinkColor( const Color& rColor );
 415     const Color&                    GetLinkColor() const;
 416
 417     void                            SetVisitedLinkColor( const Color& rColor );
 418     const Color&                    GetVisitedLinkColor() const;
 419
 420     void                            SetMonoColor( const Color& rColor );
 421     const Color&                    GetMonoColor() const;
 422
 423     void                            SetActiveTabColor( const Color& rColor );
 424     const Color&                    GetActiveTabColor() const;
 425
 426     void                            SetInactiveTabColor( const Color& rColor );
 427     const Color&                    GetInactiveTabColor() const;
 428
 429     void SetAlternatingRowColor(const Color& rColor);
 430     const Color&                    GetAlternatingRowColor() const;
 431
 432     void                            SetHighContrastMode(bool bHighContrast );
 433     bool                            GetHighContrastMode() const;
 434
 435     void                            SetUseSystemUIFonts( bool bUseSystemUIFonts );
 436     bool                            GetUseSystemUIFonts() const;
 437
 438     void SetUseFontAAFromSystem(bool bUseFontAAFromSystem);
 439     bool GetUseFontAAFromSystem() const;
 440
 441     void                            SetUseFlatBorders( bool bUseFlatBorders );
 442     bool                            GetUseFlatBorders() const;
 443
 444     void                            SetUseFlatMenus( bool bUseFlatMenus );
 445     bool                            GetUseFlatMenus() const;
 446
 447     void                            SetUseImagesInMenus( TriState eUseImagesInMenus );
 448     bool                            GetUseImagesInMenus() const;
 449
 450     void                            SetPreferredUseImagesInMenus( bool bPreferredUseImagesInMenus );
 451     bool                            GetPreferredUseImagesInMenus() const;
 452
 453     void                            SetSkipDisabledInMenus( bool bSkipDisabledInMenus );
 454     bool                            GetSkipDisabledInMenus() const;
 455
 456     void                            SetHideDisabledMenuItems( bool bHideDisabledMenuItems );
 457     bool                            GetHideDisabledMenuItems() const;
 458
 459     void                            SetContextMenuShortcuts( TriState eContextMenuShortcuts );
 460     bool                            GetContextMenuShortcuts() const;
 461
 462     void                            SetPreferredContextMenuShortcuts( bool bContextMenuShortcuts );
 463     bool                            GetPreferredContextMenuShortcuts() const;
 464
 465     void                            SetPrimaryButtonWarpsSlider( bool bPrimaryButtonWarpsSlider );
 466     bool                            GetPrimaryButtonWarpsSlider() const;
 467
 468     void                            SetAppFont( const vcl::Font& rFont );
 469     const vcl::Font&                GetAppFont() const;
 470
 471     void                            SetHelpFont( const vcl::Font& rFont );
 472     const vcl::Font&                GetHelpFont() const;
 473
 474     void                            SetTitleFont( const vcl::Font& rFont );
 475     const vcl::Font&                GetTitleFont() const;
 476
 477     void                            SetFloatTitleFont( const vcl::Font& rFont );
 478     const vcl::Font&                GetFloatTitleFont() const;
 479
 480     void                            SetMenuFont( const vcl::Font& rFont );
 481     const vcl::Font&                GetMenuFont() const;
 482
 483     void                            SetToolFont( const vcl::Font& rFont );
 484     const vcl::Font&                GetToolFont() const;
 485
 486     void                            SetGroupFont( const vcl::Font& rFont );
 487     const vcl::Font&                GetGroupFont() const;
 488
 489     void                            SetLabelFont( const vcl::Font& rFont );
 490     const vcl::Font&                GetLabelFont() const;
 491
 492     void                            SetRadioCheckFont( const vcl::Font& rFont );
 493     const vcl::Font&                GetRadioCheckFont() const;
 494
 495     void                            SetPushButtonFont( const vcl::Font& rFont );
 496     const vcl::Font&                GetPushButtonFont() const;
 497
 498     void                            SetFieldFont( const vcl::Font& rFont );
 499     const vcl::Font&                GetFieldFont() const;
 500
 501     void                            SetIconFont( const vcl::Font& rFont );
 502     const vcl::Font&                GetIconFont() const;
 503
 504     void                            SetTabFont( const vcl::Font& rFont );
 505     const vcl::Font&                GetTabFont() const;
 506
 507     static sal_Int32                GetBorderSize();
 508
 509     void                            SetTitleHeight( sal_Int32 nSize );
 510     sal_Int32                       GetTitleHeight() const;
 511
 512     void                            SetFloatTitleHeight( sal_Int32 nSize );
 513     sal_Int32                       GetFloatTitleHeight() const;
 514
 515     void                            SetScrollBarSize( sal_Int32 nSize );
 516     sal_Int32                       GetScrollBarSize() const;
 517
 518     void                            SetMinThumbSize( sal_Int32 nSize );
 519     sal_Int32                       GetMinThumbSize() const;
 520
 521     void                            SetSpinSize( sal_Int32 nSize );
 522     sal_Int32                       GetSpinSize() const;
 523
 524     static sal_Int32                GetSplitSize();
 525
 526     void                            SetCursorSize( sal_Int32 nSize );
 527     sal_Int32                       GetCursorSize() const;
 528
 529     void                            SetCursorBlinkTime( sal_uInt64 nBlinkTime );
 530     sal_uInt64                      GetCursorBlinkTime() const;
 531
 532     void                            SetDragFullOptions( DragFullOptions nOptions );
 533     DragFullOptions                 GetDragFullOptions() const;
 534
 535     void                            SetSelectionOptions( SelectionOptions nOptions );
 536     SelectionOptions                GetSelectionOptions() const;
 537
 538     void                            SetDisplayOptions( DisplayOptions nOptions );
 539     DisplayOptions                  GetDisplayOptions() const;
 540
 541     void                            SetAntialiasingMinPixelHeight( sal_Int32 nMinPixel );
 542     sal_Int32                       GetAntialiasingMinPixelHeight() const;
 543
 544     void                            SetOptions( StyleSettingsOptions nOptions );
 545     StyleSettingsOptions            GetOptions() const;
 546
 547     void                            SetAutoMnemonic( bool bAutoMnemonic );
 548     bool                            GetAutoMnemonic() const;
 549
 550     static bool                     GetDockingFloatsSupported();
 551
 552     void                            SetToolbarIconSize( ToolbarIconSize nSize );
 553     ToolbarIconSize                 GetToolbarIconSize() const;
 554     Size                            GetToolbarIconSizePixel() const;
 555
 556     /** Set the icon theme to use. */
 557     void                            SetIconTheme(const OUString&);
 558
 559     /** Determine which icon theme should be used.
 560      *
 561      * This might not be the same as the one which has been set with SetIconTheme(),
 562      * e.g., if high contrast mode is enabled.
 563      *
 564      * (for the detailed logic @see vcl::IconThemeSelector)
 565      */
 566     OUString                        DetermineIconTheme() const;
 567
 568     /** Obtain the list of icon themes which were found in the config folder
 569      * @see vcl::IconThemeScanner for more details.
 570      */
 571     std::vector<vcl::IconThemeInfo> const & GetInstalledIconThemes() const;
 572
 573     /** Obtain the name of the icon theme which will be chosen automatically for the desktop environment.
 574      * This method will only return icon themes which were actually found on the system.
 575      */
 576     OUString                        GetAutomaticallyChosenIconTheme() const;
 577
 578     /** Set a preferred icon theme.
 579      * This theme will be preferred in GetAutomaticallyChosenIconTheme()
 580      */
 581     void                            SetPreferredIconTheme(const OUString&, bool bDarkIconTheme = false);
 582
 583     const DialogStyle&              GetDialogStyle() const;
 584
 585     BitmapEx const &                GetPersonaHeader() const;
 586
 587     BitmapEx const &                GetPersonaFooter() const;
 588
 589     const std::optional<Color>&   GetPersonaMenuBarTextColor() const;
 590
 591     // global switch to allow EdgeBlenging; currently possible for ValueSet and ListBox
 592     // when activated there using Get/SetEdgeBlending; default is true
 593     void                            SetEdgeBlending(sal_uInt16 nCount);
 594     sal_uInt16                      GetEdgeBlending() const;
 595
 596     // TopLeft (default Color(0xC0, 0xC0, 0xC0)) and BottomRight (default Color(0x40, 0x40, 0x40))
 597     // default colors for EdgeBlending
 598     const Color&                    GetEdgeBlendingTopLeftColor() const;
 599     const Color&                    GetEdgeBlendingBottomRightColor() const;
 600
 601     // maximum line count for ListBox control; to use this, call AdaptDropDownLineCountToMaximum() at the
 602     // ListBox after it's ItemCount has changed/got filled. Default is 25. If more Items exist, a scrollbar
 603     // will be used
 604     void                            SetListBoxMaximumLineCount(sal_uInt16 nCount);
 605     sal_uInt16                      GetListBoxMaximumLineCount() const;
 606
 607     // maximum column count for the ColorValueSet control. Default is 12 and this is optimized for the
 608     // color scheme which has 12-color aligned layout for the part taken over from Symphony. Do
 609     // only change this if you know what you are doing.
 610     void                            SetColorValueSetColumnCount(sal_uInt16 nCount);
 611     sal_uInt16                      GetColorValueSetColumnCount() const;
 612
 613     void                            SetListBoxPreviewDefaultLogicSize(Size const & rSize);
 614     const Size&                     GetListBoxPreviewDefaultPixelSize() const;
 615
 616     // the default LineWidth for ListBox UI previews (LineStyle, LineDash, LineStartEnd). Default is 1.
 617     static sal_uInt16               GetListBoxPreviewDefaultLineWidth();
 618
 619     // defines if previews which contain potentially transparent objects (e.g. the dash/line/LineStartEnd previews and others)
 620     // use the default transparent visualization background (checkered background) as it has got standard in graphic programs nowadays
 621     void                            SetPreviewUsesCheckeredBackground(bool bNew);
 622     bool                            GetPreviewUsesCheckeredBackground() const;
 623
 624     void                            SetStandardStyles();
 625
 626     bool                            operator ==( const StyleSettings& rSet ) const;
 627     bool                            operator !=( const StyleSettings& rSet ) const;
 628
 629     // Batch setters used by various backends
 630     void                            BatchSetBackgrounds( const Color &aBackColor,
 631                                                          bool bCheckedColorSpecialCase = true );
 632     void                            BatchSetFonts( const vcl::Font& aAppFont,
 633                                                    const vcl::Font& aLabelFont );
 634 };
 635
 636
 637 class VCL_DLLPUBLIC MiscSettings
 638 {
 639     std::shared_ptr<ImplMiscData>   mxData;
 640
 641 public:
 642                                     MiscSettings();
 643
 644 #ifdef _WIN32
 645     void                            SetEnableATToolSupport( bool bEnable );
 646 #endif
 647     bool                            GetEnableATToolSupport() const;
 648     bool                            GetDisablePrinting() const;
 649     void                            SetEnableLocalizedDecimalSep( bool bEnable );
 650     bool                            GetEnableLocalizedDecimalSep() const;
 651     // 0 auto, 1 light, 2, dark
 652     static void                     SetDarkMode(int nMode);
 653     static int                      GetDarkMode();
 654     // return if dark mode is active, resolving 'auto' to dark (true) or light (false)
 655     static bool                     GetUseDarkMode();
 656     static void                     SetAppColorMode(int nMode);
 657     static int                      GetAppColorMode();
 658     // return true if system preferences are set to use reduced animation
 659     static bool                     GetUseReducedAnimation();
 660     bool                            operator ==( const MiscSettings& rSet ) const;
 661     bool                            operator !=( const MiscSettings& rSet ) const;
 662 };
 663
 664
 665 class VCL_DLLPUBLIC HelpSettings
 666 {
 667     std::shared_ptr<ImplHelpData>   mxData;
 668
 669 public:
 670                                     HelpSettings();
 671
 672     static sal_Int32                GetTipDelay();
 673     void                            SetTipTimeout( sal_Int32 nTipTimeout );
 674     sal_Int32                       GetTipTimeout() const;
 675     static sal_Int32                GetBalloonDelay();
 676
 677     bool                            operator ==( const HelpSettings& rSet ) const;
 678     bool                            operator !=( const HelpSettings& rSet ) const;
 679 };
 680
 681
 682 enum class AllSettingsFlags {
 683     NONE     = 0x0000,
 684     MOUSE    = 0x0001,
 685     STYLE    = 0x0002,
 686     MISC     = 0x0004,
 687     LOCALE   = 0x0020,
 688 };
 689 namespace o3tl
 690 {
 691     template<> struct typed_flags<AllSettingsFlags> : is_typed_flags<AllSettingsFlags, 0x0027> {};
 692 }
 693
 694 class VCL_DLLPUBLIC AllSettings
 695 {
 696 private:
 697     void                                    CopyData();
 698
 699     std::shared_ptr<ImplAllSettingsData>    mxData;
 700
 701 public:
 702                                             AllSettings();
 703
 704     void                                    SetMouseSettings( const MouseSettings& rSet );
 705     const MouseSettings&                    GetMouseSettings() const;
 706
 707     void                                    SetStyleSettings( const StyleSettings& rSet );
 708     const StyleSettings&                    GetStyleSettings() const;
 709
 710     void                                    SetMiscSettings( const MiscSettings& rSet );
 711     const MiscSettings&                     GetMiscSettings() const;
 712
 713     IF_MERGELIBS(SAL_DLLPRIVATE)
 714     void                                    SetHelpSettings( const HelpSettings& rSet );
 715     IF_MERGELIBS(SAL_DLLPRIVATE)
 716     const HelpSettings&                     GetHelpSettings() const;
 717
 718     void                                    SetLanguageTag(const OUString& rLanguage, bool bCanonicalize);
 719     void                                    SetLanguageTag( const LanguageTag& rLanguageTag );
 720     const LanguageTag&                      GetLanguageTag() const;
 721     const LanguageTag&                      GetUILanguageTag() const;
 722     static bool                             GetLayoutRTL();   // returns true if UI language requires right-to-left Text Layout
 723     static bool                             GetMathLayoutRTL();   // returns true if UI language requires right-to-left Math Layout
 724     static OUString                         GetUIRootDir();
 725     const LocaleDataWrapper&                GetLocaleDataWrapper() const;
 726     const LocaleDataWrapper&                GetUILocaleDataWrapper() const;
 727     IF_MERGELIBS(SAL_DLLPRIVATE)
 728     const LocaleDataWrapper&                GetNeutralLocaleDataWrapper() const;
 729     const vcl::I18nHelper&                  GetLocaleI18nHelper() const;
 730     const vcl::I18nHelper&                  GetUILocaleI18nHelper() const;
 731
 732     SAL_DLLPRIVATE static AllSettingsFlags GetWindowUpdate()
 733     { return AllSettingsFlags::MOUSE | AllSettingsFlags::STYLE | AllSettingsFlags::MISC | AllSettingsFlags::LOCALE; }
 734
 735     AllSettingsFlags                        Update( AllSettingsFlags nFlags, const AllSettings& rSettings );
 736     SAL_DLLPRIVATE AllSettingsFlags         GetChangeFlags( const AllSettings& rSettings ) const;
 737
 738     bool                                    operator ==( const AllSettings& rSet ) const;
 739     bool                                    operator !=( const AllSettings& rSet ) const;
 740     SAL_DLLPRIVATE static void             LocaleSettingsChanged( ConfigurationHints nHint );
 741     SAL_DLLPRIVATE SvtSysLocale&           GetSysLocale();
 742 };
 743
 744 #endif // INCLUDED_VCL_SETTINGS_HXX
 745
 746 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */