widget/LookAndFeel.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef __LookAndFeel
   7 #define __LookAndFeel
   8
   9 #ifndef MOZILLA_INTERNAL_API
  10 #  error "This header is only usable from within libxul (MOZILLA_INTERNAL_API)."
  11 #endif
  12
  13 #include "nsDebug.h"
  14 #include "nsColor.h"
  15 #include "nsString.h"
  16 #include "nsTArray.h"
  17 #include "mozilla/Maybe.h"
  18 #include "mozilla/widget/ThemeChangeKind.h"
  19 #include "mozilla/ColorScheme.h"
  20
  21 struct gfxFontStyle;
  22
  23 class nsIFrame;
  24
  25 namespace mozilla {
  26
  27 using Modifiers = uint16_t;
  28 struct StyleColorSchemeFlags;
  29
  30 namespace dom {
  31 class Document;
  32 }
  33
  34 namespace widget {
  35 class FullLookAndFeel;
  36 }  // namespace widget
  37
  38 enum class StyleSystemColor : uint8_t;
  39 enum class StyleSystemColorScheme : uint8_t;
  40 enum class StyleSystemFont : uint8_t;
  41
  42 class LookAndFeel {
  43  public:
  44   using ColorID = StyleSystemColor;
  45   using ColorScheme = mozilla::ColorScheme;
  46
  47   // When modifying this list, also modify nsXPLookAndFeel::sIntPrefs
  48   // in widget/xpwidgts/nsXPLookAndFeel.cpp.
  49   enum class IntID {
  50     // default, may be overriden by OS
  51     CaretBlinkTime,
  52     // Amount of blinks that happen before the caret stops blinking.
  53     CaretBlinkCount,
  54     // pixel width of caret
  55     CaretWidth,
  56     // show the caret when text is selected?
  57     ShowCaretDuringSelection,
  58     // select textfields when focused via tab/accesskey?
  59     SelectTextfieldsOnKeyFocus,
  60     // delay before submenus open
  61     SubmenuDelay,
  62     // can popups overlap menu/task bar?
  63     MenusCanOverlapOSBar,
  64     // should overlay scrollbars be used?
  65     UseOverlayScrollbars,
  66     // allow H and V overlay scrollbars to overlap?
  67     AllowOverlayScrollbarsOverlap,
  68     // skip navigating to disabled menu item?
  69     SkipNavigatingDisabledMenuItem,
  70     // begin a drag if the mouse is moved further than the threshold while the
  71     // button is down
  72     DragThresholdX,
  73     DragThresholdY,
  74     // Accessibility theme being used?
  75     UseAccessibilityTheme,
  76
  77     // position of scroll arrows in a scrollbar
  78     ScrollArrowStyle,
  79
  80     // each button can take one of four values:
  81     ScrollButtonLeftMouseButtonAction,
  82     // 0 - scrolls one  line, 1 - scrolls one page
  83     ScrollButtonMiddleMouseButtonAction,
  84     // 2 - scrolls to end, 3 - button ignored
  85     ScrollButtonRightMouseButtonAction,
  86
  87     // delay for opening spring loaded folders
  88     TreeOpenDelay,
  89     // delay for closing spring loaded folders
  90     TreeCloseDelay,
  91     // delay for triggering the tree scrolling
  92     TreeLazyScrollDelay,
  93     // delay for scrolling the tree
  94     TreeScrollDelay,
  95     // the maximum number of lines to be scrolled at ones
  96     TreeScrollLinesMax,
  97     // What type of tab-order to use
  98     TabFocusModel,
  99     // Should menu items blink when they're chosen?
 100     ChosenMenuItemsShouldBlink,
 101
 102     /*
 103      * A Boolean value to determine whether the Windows accent color
 104      * should be applied to the title bar.
 105      *
 106      * The value of this metric is not used on other platforms. These platforms
 107      * should return NS_ERROR_NOT_IMPLEMENTED when queried for this metric.
 108      */
 109     WindowsAccentColorInTitlebar,
 110
 111     /*
 112      * A Boolean value to determine whether the macOS Big Sur-specific
 113      * theming should be used.
 114      */
 115     MacBigSurTheme,
 116
 117     /*
 118      * A Boolean value to determine whether macOS is in RTL mode or not.
 119      */
 120     MacRTL,
 121
 122     /*
 123      * AlertNotificationOrigin indicates from which corner of the
 124      * screen alerts slide in, and from which direction (horizontal/vertical).
 125      * 0, the default, represents bottom right, sliding vertically.
 126      * Use any bitwise combination of the following constants:
 127      * NS_ALERT_HORIZONTAL (1), NS_ALERT_LEFT (2), NS_ALERT_TOP (4).
 128      *
 129      *       6       4
 130      *     +-----------+
 131      *    7|           |5
 132      *     |           |
 133      *    3|           |1
 134      *     +-----------+
 135      *       2       0
 136      */
 137     AlertNotificationOrigin,
 138
 139     /**
 140      * If true, clicking on a scrollbar (not as in dragging the thumb) defaults
 141      * to scrolling the view corresponding to the clicked point. Otherwise, we
 142      * only do so if the scrollbar is clicked using the middle mouse button or
 143      * if shift is pressed when the scrollbar is clicked.
 144      */
 145     ScrollToClick,
 146
 147     /**
 148      * IME and spell checker underline styles, the values should be
 149      * NS_DECORATION_LINE_STYLE_*.  They are defined below.
 150      */
 151     IMERawInputUnderlineStyle,
 152     IMESelectedRawTextUnderlineStyle,
 153     IMEConvertedTextUnderlineStyle,
 154     IMESelectedConvertedTextUnderline,
 155     SpellCheckerUnderlineStyle,
 156
 157     /**
 158      * If this metric != 0, support window dragging on the menubar.
 159      */
 160     MenuBarDrag,
 161     /**
 162      * 0: scrollbar button repeats to scroll only when cursor is on the button.
 163      * 1: scrollbar button repeats to scroll even if cursor is outside of it.
 164      */
 165     ScrollbarButtonAutoRepeatBehavior,
 166     /*
 167      * A Boolean value to determine whether swipe animations should be used.
 168      */
 169     SwipeAnimationEnabled,
 170
 171     /*
 172      * Controls whether overlay scrollbars display when the user moves
 173      * the mouse in a scrollable frame.
 174      */
 175     ScrollbarDisplayOnMouseMove,
 176
 177     /*
 178      * Overlay scrollbar animation constants.
 179      */
 180     ScrollbarFadeBeginDelay,
 181     ScrollbarFadeDuration,
 182
 183     /**
 184      * Distance in pixels to offset the context menu from the cursor
 185      * on open.
 186      */
 187     ContextMenuOffsetVertical,
 188     ContextMenuOffsetHorizontal,
 189
 190     /*
 191      * A boolean value indicating whether client-side decorations are
 192      * supported by the user's GTK version.
 193      */
 194     GTKCSDAvailable,
 195
 196     /*
 197      * A boolean value indicating whether client-side decorations should
 198      * contain a minimize button.
 199      */
 200     GTKCSDMinimizeButton,
 201
 202     /*
 203      * A boolean value indicating whether client-side decorations should
 204      * contain a maximize button.
 205      */
 206     GTKCSDMaximizeButton,
 207
 208     /*
 209      * A boolean value indicating whether client-side decorations should
 210      * contain a close button.
 211      */
 212     GTKCSDCloseButton,
 213
 214     /**
 215      * An Integer value that will represent the position of the Minimize button
 216      * in GTK Client side decoration header.
 217      */
 218     GTKCSDMinimizeButtonPosition,
 219
 220     /**
 221      * An Integer value that will represent the position of the Maximize button
 222      * in GTK Client side decoration header.
 223      */
 224     GTKCSDMaximizeButtonPosition,
 225
 226     /**
 227      * An Integer value that will represent the position of the Close button
 228      * in GTK Client side decoration header.
 229      */
 230     GTKCSDCloseButtonPosition,
 231
 232     /*
 233      * A boolean value indicating whether titlebar buttons are located
 234      * in left titlebar corner.
 235      */
 236     GTKCSDReversedPlacement,
 237
 238     /*
 239      * A boolean value indicating whether or not the OS is using a dark theme,
 240      * which we may want to switch to as well if not overridden by the user.
 241      */
 242     SystemUsesDarkTheme,
 243
 244     /**
 245      * Corresponding to prefers-reduced-motion.
 246      * https://drafts.csswg.org/mediaqueries-5/#prefers-reduced-motion
 247      * 0: no-preference
 248      * 1: reduce
 249      */
 250     PrefersReducedMotion,
 251
 252     /**
 253      * Corresponding to prefers-reduced-transparency.
 254      * https://drafts.csswg.org/mediaqueries-5/#prefers-reduced-transparency
 255      * 0: no-preference
 256      * 1: reduce
 257      */
 258     PrefersReducedTransparency,
 259
 260     /**
 261      * Corresponding to inverted-colors.
 262      * https://drafts.csswg.org/mediaqueries-5/#inverted
 263      * 0: none
 264      * 1: inverted
 265      */
 266     InvertedColors,
 267
 268     /**
 269      * Corresponding to PointerCapabilities in ServoTypes.h
 270      * 0: None
 271      * 1: Coarse
 272      * 2: Fine
 273      * 4: Hover
 274      */
 275     PrimaryPointerCapabilities,
 276     /**
 277      * Corresponding to union of PointerCapabilities values in ServoTypes.h
 278      * E.g. if there is a mouse and a digitizer, the value will be
 279      * 'Coarse | Fine | Hover'.
 280      */
 281     AllPointerCapabilities,
 282
 283     /** The scrollbar size, in CSS pixels. */
 284     SystemScrollbarSize,
 285
 286     /** A boolean value to determine whether a touch device is present */
 287     TouchDeviceSupportPresent,
 288
 289     /** GTK titlebar radius */
 290     TitlebarRadius,
 291
 292     /** GTK button-to-button spacing in the inline axis */
 293     TitlebarButtonSpacing,
 294
 295     /**
 296      * Corresponding to dynamic-range.
 297      * https://drafts.csswg.org/mediaqueries-5/#dynamic-range
 298      * 0: Standard
 299      * 1: High
 300      */
 301     DynamicRange,
 302     VideoDynamicRange,
 303
 304     /** Whether XUL panel animations are enabled. */
 305     PanelAnimations,
 306
 307     /* Whether we should hide the cursor while typing */
 308     HideCursorWhileTyping,
 309
 310     /* The StyleGtkThemeFamily of the current GTK theme. */
 311     GTKThemeFamily,
 312
 313     /*
 314      * Not an ID; used to define the range of valid IDs.  Must be last.
 315      */
 316     End,
 317   };
 318
 319   // This is a common enough integer that seems worth the shortcut.
 320   static bool UseOverlayScrollbars() {
 321     return GetInt(IntID::UseOverlayScrollbars);
 322   }
 323
 324   // Returns keyCode value of a modifier key which is used for accesskey.
 325   // Returns 0 if the platform doesn't support access key.
 326   static uint32_t GetMenuAccessKey();
 327   // Modifier mask for the menu accesskey.
 328   static Modifiers GetMenuAccessKeyModifiers();
 329
 330   enum {
 331     eScrollArrow_None = 0,
 332     eScrollArrow_StartBackward = 0x1000,
 333     eScrollArrow_StartForward = 0x0100,
 334     eScrollArrow_EndBackward = 0x0010,
 335     eScrollArrow_EndForward = 0x0001
 336   };
 337
 338   enum {
 339     // single arrow at each end
 340     eScrollArrowStyle_Single =
 341         eScrollArrow_StartBackward | eScrollArrow_EndForward,
 342     // both arrows at bottom/right, none at top/left
 343     eScrollArrowStyle_BothAtBottom =
 344         eScrollArrow_EndBackward | eScrollArrow_EndForward,
 345     // both arrows at both ends
 346     eScrollArrowStyle_BothAtEachEnd =
 347         eScrollArrow_EndBackward | eScrollArrow_EndForward |
 348         eScrollArrow_StartBackward | eScrollArrow_StartForward,
 349     // both arrows at top/left, none at bottom/right
 350     eScrollArrowStyle_BothAtTop =
 351         eScrollArrow_StartBackward | eScrollArrow_StartForward
 352   };
 353
 354   // When modifying this list, also modify nsXPLookAndFeel::sFloatPrefs
 355   // in widget/nsXPLookAndFeel.cpp.
 356   enum class FloatID {
 357     IMEUnderlineRelativeSize,
 358     SpellCheckerUnderlineRelativeSize,
 359
 360     // The width/height ratio of the cursor. If used, the CaretWidth int metric
 361     // should be added to the calculated caret width.
 362     CaretAspectRatio,
 363
 364     // GTK text scale factor.
 365     TextScaleFactor,
 366
 367     // Mouse pointer scaling factor.
 368     CursorScale,
 369
 370     // Not an ID; used to define the range of valid IDs.  Must be last.
 371     End,
 372   };
 373
 374   using FontID = mozilla::StyleSystemFont;
 375
 376   static ColorScheme SystemColorScheme() {
 377     return GetInt(IntID::SystemUsesDarkTheme) ? ColorScheme::Dark
 378                                               : ColorScheme::Light;
 379   }
 380
 381   static bool IsDarkColor(nscolor);
 382
 383   static ColorScheme ColorSchemeForStyle(
 384       const dom::Document&, const StyleColorSchemeFlags&,
 385       ColorSchemeMode = ColorSchemeMode::Used);
 386   static ColorScheme ColorSchemeForFrame(
 387       const nsIFrame*, ColorSchemeMode = ColorSchemeMode::Used);
 388
 389   // Whether standins for native colors should be used (that is, colors faked,
 390   // taken from win7, mostly). This forces light appearance, effectively.
 391   enum class UseStandins : bool { No, Yes };
 392   static UseStandins ShouldUseStandins(const dom::Document&, ColorID);
 393
 394   // Returns a native color value (might be overwritten by prefs) for a given
 395   // color id.
 396   //
 397   // NOTE:
 398   //   ColorID::TextSelectForeground might return NS_SAME_AS_FOREGROUND_COLOR.
 399   //   ColorID::IME* might return NS_TRANSPARENT, NS_SAME_AS_FOREGROUND_COLOR or
 400   //   NS_40PERCENT_FOREGROUND_COLOR.
 401   //   These values have particular meaning.  Then, they are not an actual
 402   //   color value.
 403   static Maybe<nscolor> GetColor(ColorID, ColorScheme, UseStandins);
 404
 405   // Gets the color with appropriate defaults for UseStandins, ColorScheme etc
 406   // for a given frame.
 407   static Maybe<nscolor> GetColor(ColorID, const nsIFrame*);
 408
 409   // Versions of the above which returns the color if found, or a default (which
 410   // defaults to opaque black) otherwise.
 411   static nscolor Color(ColorID aId, ColorScheme aScheme,
 412                        UseStandins aUseStandins,
 413                        nscolor aDefault = NS_RGB(0, 0, 0)) {
 414     return GetColor(aId, aScheme, aUseStandins).valueOr(aDefault);
 415   }
 416
 417   static nscolor Color(ColorID aId, nsIFrame* aFrame,
 418                        nscolor aDefault = NS_RGB(0, 0, 0)) {
 419     return GetColor(aId, aFrame).valueOr(aDefault);
 420   }
 421
 422   static float GetTextScaleFactor() {
 423     float f = GetFloat(FloatID::TextScaleFactor, 1.0f);
 424     if (MOZ_UNLIKELY(f <= 0.0f)) {
 425       return 1.0f;
 426     }
 427     return f;
 428   }
 429
 430   struct ZoomSettings {
 431     float mFullZoom = 1.0f;
 432     float mTextZoom = 1.0f;
 433   };
 434
 435   static ZoomSettings SystemZoomSettings();
 436
 437   /**
 438    * GetInt() and GetFloat() return a int or float value for aID.  The result
 439    * might be distance, time, some flags or a int value which has particular
 440    * meaning.  See each document at definition of each ID for the detail.
 441    * The result is always 0 when they return error.  Therefore, if you want to
 442    * use a value for the default value, you should use the other method which
 443    * returns int or float directly.
 444    */
 445   static nsresult GetInt(IntID, int32_t* aResult);
 446   static nsresult GetFloat(FloatID aID, float* aResult);
 447
 448   static int32_t GetInt(IntID aID, int32_t aDefault = 0) {
 449     int32_t result;
 450     if (NS_FAILED(GetInt(aID, &result))) {
 451       return aDefault;
 452     }
 453     return result;
 454   }
 455
 456   static float GetFloat(FloatID aID, float aDefault = 0.0f) {
 457     float result;
 458     if (NS_FAILED(GetFloat(aID, &result))) {
 459       return aDefault;
 460     }
 461     return result;
 462   }
 463
 464   /**
 465    * Retrieve the name and style of a system-theme font.  Returns true
 466    * if the system theme specifies this font, false if a default should
 467    * be used.  In the latter case neither aName nor aStyle is modified.
 468    *
 469    * Size of the font should be in CSS pixels, not device pixels.
 470    *
 471    * @param aID    Which system-theme font is wanted.
 472    * @param aName  The name of the font to use.
 473    * @param aStyle Styling to apply to the font.
 474    */
 475   static bool GetFont(FontID aID, nsString& aName, gfxFontStyle& aStyle);
 476
 477   /**
 478    * GetPasswordCharacter() returns a unicode character which should be used
 479    * for a masked character in password editor.  E.g., '*'.
 480    */
 481   static char16_t GetPasswordCharacter();
 482
 483   /**
 484    * If the latest character in password field shouldn't be hidden by the
 485    * result of GetPasswordCharacter(), GetEchoPassword() returns TRUE.
 486    * Otherwise, FALSE.
 487    */
 488   static bool GetEchoPassword();
 489
 490   /**
 491    * Whether we should be drawing in the titlebar by default.
 492    */
 493   static bool DrawInTitlebar();
 494
 495   enum class TitlebarAction {
 496     None,
 497     WindowLower,
 498     WindowMenu,
 499     WindowMinimize,
 500     WindowMaximize,
 501     WindowMaximizeToggle,
 502     // We don't support more actions (maximize-horizontal, maximize-vertical,..)
 503     // as they're implemented as part of Wayland gtk_surface1 protocol
 504     // which is not accessible to us.
 505   };
 506
 507   enum class TitlebarEvent {
 508     Double_Click,
 509     Middle_Click,
 510   };
 511
 512   /**
 513    * Get system defined action for titlebar events.
 514    */
 515   static TitlebarAction GetTitlebarAction(TitlebarEvent aEvent);
 516
 517   /**
 518    * The millisecond to mask password value.
 519    * This value is only valid when GetEchoPassword() returns true.
 520    */
 521   static uint32_t GetPasswordMaskDelay();
 522
 523   /** Gets theme information for about:support */
 524   static void GetThemeInfo(nsACString&);
 525
 526   /**
 527    * When system look and feel is changed, Refresh() must be called.  Then,
 528    * cached data would be released.
 529    */
 530   static void Refresh();
 531
 532   /**
 533    * GTK's initialization code can't be run off main thread, call this
 534    * if you plan on using LookAndFeel off main thread later.
 535    *
 536    * This initialized state may get reset due to theme changes, so it
 537    * must be called prior to each potential off-main-thread LookAndFeel
 538    * call, not just once.
 539    */
 540   static void NativeInit();
 541
 542   static void SetData(widget::FullLookAndFeel&& aTables);
 543   static void NotifyChangedAllWindows(widget::ThemeChangeKind);
 544   static bool HasPendingGlobalThemeChange() { return sGlobalThemeChanged; }
 545   static void HandleGlobalThemeChange() {
 546     if (MOZ_UNLIKELY(HasPendingGlobalThemeChange())) {
 547       DoHandleGlobalThemeChange();
 548     }
 549   }
 550
 551  protected:
 552   static void DoHandleGlobalThemeChange();
 553   // Set to true when ThemeChanged needs to be called on mTheme (and other
 554   // global LookAndFeel.  This is used because mTheme is a service, so there's
 555   // no need to notify it from more than one prescontext.
 556   static bool sGlobalThemeChanged;
 557 };
 558
 559 }  // namespace mozilla
 560
 561 // ---------------------------------------------------------------------
 562 //  Special colors for ColorID::IME* and ColorID::SpellCheckerUnderline
 563 // ---------------------------------------------------------------------
 564
 565 // For background color only.
 566 constexpr nscolor NS_TRANSPARENT = NS_RGBA(0x01, 0x00, 0x00, 0x00);
 567 // For foreground color only.
 568 constexpr nscolor NS_SAME_AS_FOREGROUND_COLOR = NS_RGBA(0x02, 0x00, 0x00, 0x00);
 569 constexpr nscolor NS_40PERCENT_FOREGROUND_COLOR =
 570     NS_RGBA(0x03, 0x00, 0x00, 0x00);
 571
 572 #define NS_IS_SELECTION_SPECIAL_COLOR(c)                          \
 573   ((c) == NS_TRANSPARENT || (c) == NS_SAME_AS_FOREGROUND_COLOR || \
 574    (c) == NS_40PERCENT_FOREGROUND_COLOR)
 575
 576 // ------------------------------------------
 577 //  Bits for IntID::AlertNotificationOrigin
 578 // ------------------------------------------
 579
 580 #define NS_ALERT_HORIZONTAL 1
 581 #define NS_ALERT_LEFT 2
 582 #define NS_ALERT_TOP 4
 583
 584 #endif /* __LookAndFeel */