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/. */
9 #ifndef MOZILLA_INTERNAL_API
10 # error "This header is only usable from within libxul (MOZILLA_INTERNAL_API)."
17 #include "mozilla/Maybe.h"
18 #include "mozilla/widget/ThemeChangeKind.h"
19 #include "mozilla/ColorScheme.h"
27 using Modifiers
= uint16_t;
28 struct StyleColorSchemeFlags
;
35 class FullLookAndFeel
;
38 enum class StyleSystemColor
: uint8_t;
39 enum class StyleSystemColorScheme
: uint8_t;
40 enum class StyleSystemFont
: uint8_t;
44 using ColorID
= StyleSystemColor
;
45 using ColorScheme
= mozilla::ColorScheme
;
47 // When modifying this list, also modify nsXPLookAndFeel::sIntPrefs
48 // in widget/xpwidgts/nsXPLookAndFeel.cpp.
50 // default, may be overriden by OS
52 // Amount of blinks that happen before the caret stops blinking.
54 // pixel width of caret
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
62 // can popups overlap menu/task bar?
64 // should overlay scrollbars be used?
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
74 // Accessibility theme being used?
75 UseAccessibilityTheme
,
77 // position of scroll arrows in a scrollbar
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
,
87 // delay for opening spring loaded folders
89 // delay for closing spring loaded folders
91 // delay for triggering the tree scrolling
93 // delay for scrolling the tree
95 // the maximum number of lines to be scrolled at ones
97 // What type of tab-order to use
99 // Should menu items blink when they're chosen?
100 ChosenMenuItemsShouldBlink
,
103 * A Boolean value to determine whether the Windows accent color
104 * should be applied to the title bar.
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.
109 WindowsAccentColorInTitlebar
,
112 * A Boolean value to determine whether the macOS Big Sur-specific
113 * theming should be used.
118 * A Boolean value to determine whether macOS is in RTL mode or not.
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).
137 AlertNotificationOrigin
,
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.
148 * IME and spell checker underline styles, the values should be
149 * NS_DECORATION_LINE_STYLE_*. They are defined below.
151 IMERawInputUnderlineStyle
,
152 IMESelectedRawTextUnderlineStyle
,
153 IMEConvertedTextUnderlineStyle
,
154 IMESelectedConvertedTextUnderline
,
155 SpellCheckerUnderlineStyle
,
158 * If this metric != 0, support window dragging on the menubar.
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.
165 ScrollbarButtonAutoRepeatBehavior
,
167 * Delay before showing a tooltip.
171 * A Boolean value to determine whether swipe animations should be used.
173 SwipeAnimationEnabled
,
176 * Controls whether overlay scrollbars display when the user moves
177 * the mouse in a scrollable frame.
179 ScrollbarDisplayOnMouseMove
,
182 * Overlay scrollbar animation constants.
184 ScrollbarFadeBeginDelay
,
185 ScrollbarFadeDuration
,
188 * Distance in pixels to offset the context menu from the cursor
191 ContextMenuOffsetVertical
,
192 ContextMenuOffsetHorizontal
,
195 * A boolean value indicating whether client-side decorations are
196 * supported by the user's GTK version.
201 * A boolean value indicating whether client-side decorations should
202 * contain a minimize button.
204 GTKCSDMinimizeButton
,
207 * A boolean value indicating whether client-side decorations should
208 * contain a maximize button.
210 GTKCSDMaximizeButton
,
213 * A boolean value indicating whether client-side decorations should
214 * contain a close button.
219 * An Integer value that will represent the position of the Minimize button
220 * in GTK Client side decoration header.
222 GTKCSDMinimizeButtonPosition
,
225 * An Integer value that will represent the position of the Maximize button
226 * in GTK Client side decoration header.
228 GTKCSDMaximizeButtonPosition
,
231 * An Integer value that will represent the position of the Close button
232 * in GTK Client side decoration header.
234 GTKCSDCloseButtonPosition
,
237 * A boolean value indicating whether titlebar buttons are located
238 * in left titlebar corner.
240 GTKCSDReversedPlacement
,
243 * A boolean value indicating whether or not the OS is using a dark theme,
244 * which we may want to switch to as well if not overridden by the user.
249 * Corresponding to prefers-reduced-motion.
250 * https://drafts.csswg.org/mediaqueries-5/#prefers-reduced-motion
254 PrefersReducedMotion
,
257 * Corresponding to prefers-reduced-transparency.
258 * https://drafts.csswg.org/mediaqueries-5/#prefers-reduced-transparency
262 PrefersReducedTransparency
,
265 * Corresponding to inverted-colors.
266 * https://drafts.csswg.org/mediaqueries-5/#inverted
273 * Corresponding to PointerCapabilities in ServoTypes.h
279 PrimaryPointerCapabilities
,
281 * Corresponding to union of PointerCapabilities values in ServoTypes.h
282 * E.g. if there is a mouse and a digitizer, the value will be
283 * 'Coarse | Fine | Hover'.
285 AllPointerCapabilities
,
287 /** The scrollbar size, in CSS pixels. */
290 /** A boolean value to determine whether a touch device is present */
291 TouchDeviceSupportPresent
,
293 /** GTK titlebar radius */
297 * Corresponding to dynamic-range.
298 * https://drafts.csswg.org/mediaqueries-5/#dynamic-range
305 /** Whether XUL panel animations are enabled. */
308 /* Whether we should hide the cursor while typing */
309 HideCursorWhileTyping
,
311 /* The StyleGtkThemeFamily of the current GTK theme. */
315 * Not an ID; used to define the range of valid IDs. Must be last.
320 // This is a common enough integer that seems worth the shortcut.
321 static bool UseOverlayScrollbars() {
322 return GetInt(IntID::UseOverlayScrollbars
);
325 // Returns keyCode value of a modifier key which is used for accesskey.
326 // Returns 0 if the platform doesn't support access key.
327 static uint32_t GetMenuAccessKey();
328 // Modifier mask for the menu accesskey.
329 static Modifiers
GetMenuAccessKeyModifiers();
332 eScrollArrow_None
= 0,
333 eScrollArrow_StartBackward
= 0x1000,
334 eScrollArrow_StartForward
= 0x0100,
335 eScrollArrow_EndBackward
= 0x0010,
336 eScrollArrow_EndForward
= 0x0001
340 // single arrow at each end
341 eScrollArrowStyle_Single
=
342 eScrollArrow_StartBackward
| eScrollArrow_EndForward
,
343 // both arrows at bottom/right, none at top/left
344 eScrollArrowStyle_BothAtBottom
=
345 eScrollArrow_EndBackward
| eScrollArrow_EndForward
,
346 // both arrows at both ends
347 eScrollArrowStyle_BothAtEachEnd
=
348 eScrollArrow_EndBackward
| eScrollArrow_EndForward
|
349 eScrollArrow_StartBackward
| eScrollArrow_StartForward
,
350 // both arrows at top/left, none at bottom/right
351 eScrollArrowStyle_BothAtTop
=
352 eScrollArrow_StartBackward
| eScrollArrow_StartForward
355 // When modifying this list, also modify nsXPLookAndFeel::sFloatPrefs
356 // in widget/nsXPLookAndFeel.cpp.
358 IMEUnderlineRelativeSize
,
359 SpellCheckerUnderlineRelativeSize
,
361 // The width/height ratio of the cursor. If used, the CaretWidth int metric
362 // should be added to the calculated caret width.
365 // GTK text scale factor.
368 // Mouse pointer scaling factor.
371 // Not an ID; used to define the range of valid IDs. Must be last.
375 using FontID
= mozilla::StyleSystemFont
;
377 static ColorScheme
SystemColorScheme() {
378 return GetInt(IntID::SystemUsesDarkTheme
) ? ColorScheme::Dark
379 : ColorScheme::Light
;
382 static bool IsDarkColor(nscolor
);
384 static ColorScheme
ColorSchemeForStyle(
385 const dom::Document
&, const StyleColorSchemeFlags
&,
386 ColorSchemeMode
= ColorSchemeMode::Used
);
387 static ColorScheme
ColorSchemeForFrame(
388 const nsIFrame
*, ColorSchemeMode
= ColorSchemeMode::Used
);
390 // Whether standins for native colors should be used (that is, colors faked,
391 // taken from win7, mostly). This forces light appearance, effectively.
392 enum class UseStandins
: bool { No
, Yes
};
393 static UseStandins
ShouldUseStandins(const dom::Document
&, ColorID
);
395 // Returns a native color value (might be overwritten by prefs) for a given
399 // ColorID::TextSelectForeground might return NS_SAME_AS_FOREGROUND_COLOR.
400 // ColorID::IME* might return NS_TRANSPARENT, NS_SAME_AS_FOREGROUND_COLOR or
401 // NS_40PERCENT_FOREGROUND_COLOR.
402 // These values have particular meaning. Then, they are not an actual
404 static Maybe
<nscolor
> GetColor(ColorID
, ColorScheme
, UseStandins
);
406 // Gets the color with appropriate defaults for UseStandins, ColorScheme etc
407 // for a given frame.
408 static Maybe
<nscolor
> GetColor(ColorID
, const nsIFrame
*);
410 // Versions of the above which returns the color if found, or a default (which
411 // defaults to opaque black) otherwise.
412 static nscolor
Color(ColorID aId
, ColorScheme aScheme
,
413 UseStandins aUseStandins
,
414 nscolor aDefault
= NS_RGB(0, 0, 0)) {
415 return GetColor(aId
, aScheme
, aUseStandins
).valueOr(aDefault
);
418 static nscolor
Color(ColorID aId
, nsIFrame
* aFrame
,
419 nscolor aDefault
= NS_RGB(0, 0, 0)) {
420 return GetColor(aId
, aFrame
).valueOr(aDefault
);
423 static float GetTextScaleFactor() {
424 float f
= GetFloat(FloatID::TextScaleFactor
, 1.0f
);
425 if (MOZ_UNLIKELY(f
<= 0.0f
)) {
431 struct ZoomSettings
{
432 float mFullZoom
= 1.0f
;
433 float mTextZoom
= 1.0f
;
436 static ZoomSettings
SystemZoomSettings();
439 * GetInt() and GetFloat() return a int or float value for aID. The result
440 * might be distance, time, some flags or a int value which has particular
441 * meaning. See each document at definition of each ID for the detail.
442 * The result is always 0 when they return error. Therefore, if you want to
443 * use a value for the default value, you should use the other method which
444 * returns int or float directly.
446 static nsresult
GetInt(IntID
, int32_t* aResult
);
447 static nsresult
GetFloat(FloatID aID
, float* aResult
);
449 static int32_t GetInt(IntID aID
, int32_t aDefault
= 0) {
451 if (NS_FAILED(GetInt(aID
, &result
))) {
457 static float GetFloat(FloatID aID
, float aDefault
= 0.0f
) {
459 if (NS_FAILED(GetFloat(aID
, &result
))) {
466 * Retrieve the name and style of a system-theme font. Returns true
467 * if the system theme specifies this font, false if a default should
468 * be used. In the latter case neither aName nor aStyle is modified.
470 * Size of the font should be in CSS pixels, not device pixels.
472 * @param aID Which system-theme font is wanted.
473 * @param aName The name of the font to use.
474 * @param aStyle Styling to apply to the font.
476 static bool GetFont(FontID aID
, nsString
& aName
, gfxFontStyle
& aStyle
);
479 * GetPasswordCharacter() returns a unicode character which should be used
480 * for a masked character in password editor. E.g., '*'.
482 static char16_t
GetPasswordCharacter();
485 * If the latest character in password field shouldn't be hidden by the
486 * result of GetPasswordCharacter(), GetEchoPassword() returns TRUE.
489 static bool GetEchoPassword();
492 * Whether we should be drawing in the titlebar by default.
494 static bool DrawInTitlebar();
496 enum class TitlebarAction
{
502 WindowMaximizeToggle
,
503 // We don't support more actions (maximize-horizontal, maximize-vertical,..)
504 // as they're implemented as part of Wayland gtk_surface1 protocol
505 // which is not accessible to us.
508 enum class TitlebarEvent
{
514 * Get system defined action for titlebar events.
516 static TitlebarAction
GetTitlebarAction(TitlebarEvent aEvent
);
519 * The millisecond to mask password value.
520 * This value is only valid when GetEchoPassword() returns true.
522 static uint32_t GetPasswordMaskDelay();
524 /** Gets theme information for about:support */
525 static void GetThemeInfo(nsACString
&);
528 * When system look and feel is changed, Refresh() must be called. Then,
529 * cached data would be released.
531 static void Refresh();
534 * GTK's initialization code can't be run off main thread, call this
535 * if you plan on using LookAndFeel off main thread later.
537 * This initialized state may get reset due to theme changes, so it
538 * must be called prior to each potential off-main-thread LookAndFeel
539 * call, not just once.
541 static void NativeInit();
543 static void SetData(widget::FullLookAndFeel
&& aTables
);
544 static void NotifyChangedAllWindows(widget::ThemeChangeKind
);
545 static bool HasPendingGlobalThemeChange() { return sGlobalThemeChanged
; }
546 static void HandleGlobalThemeChange() {
547 if (MOZ_UNLIKELY(HasPendingGlobalThemeChange())) {
548 DoHandleGlobalThemeChange();
553 static void DoHandleGlobalThemeChange();
554 // Set to true when ThemeChanged needs to be called on mTheme (and other
555 // global LookAndFeel. This is used because mTheme is a service, so there's
556 // no need to notify it from more than one prescontext.
557 static bool sGlobalThemeChanged
;
560 } // namespace mozilla
562 // ---------------------------------------------------------------------
563 // Special colors for ColorID::IME* and ColorID::SpellCheckerUnderline
564 // ---------------------------------------------------------------------
566 // For background color only.
567 constexpr nscolor NS_TRANSPARENT
= NS_RGBA(0x01, 0x00, 0x00, 0x00);
568 // For foreground color only.
569 constexpr nscolor NS_SAME_AS_FOREGROUND_COLOR
= NS_RGBA(0x02, 0x00, 0x00, 0x00);
570 constexpr nscolor NS_40PERCENT_FOREGROUND_COLOR
=
571 NS_RGBA(0x03, 0x00, 0x00, 0x00);
573 #define NS_IS_SELECTION_SPECIAL_COLOR(c) \
574 ((c) == NS_TRANSPARENT || (c) == NS_SAME_AS_FOREGROUND_COLOR || \
575 (c) == NS_40PERCENT_FOREGROUND_COLOR)
577 // ------------------------------------------
578 // Bits for IntID::AlertNotificationOrigin
579 // ------------------------------------------
581 #define NS_ALERT_HORIZONTAL 1
582 #define NS_ALERT_LEFT 2
583 #define NS_ALERT_TOP 4
585 #endif /* __LookAndFeel */