Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions
nsILookAndFeel Class Reference

#include <nsILookAndFeel.h>

Inheritance diagram for nsILookAndFeel:
Inheritance graph
[legend]
Collaboration diagram for nsILookAndFeel:
Collaboration graph
[legend]

List of all members.

Public Types

enum  nsColorID {
  eColor_WindowBackground, eColor_WindowForeground, eColor_WidgetBackground, eColor_WidgetForeground,
  eColor_WidgetSelectBackground, eColor_WidgetSelectForeground, eColor_Widget3DHighlight, eColor_Widget3DShadow,
  eColor_TextBackground, eColor_TextForeground, eColor_TextSelectBackground, eColor_TextSelectForeground,
  eColor_TextSelectBackgroundDisabled, eColor_TextSelectBackgroundAttention, eColor_activeborder, eColor_activecaption,
  eColor_appworkspace, eColor_background, eColor_buttonface, eColor_buttonhighlight,
  eColor_buttonshadow, eColor_buttontext, eColor_captiontext, eColor_graytext,
  eColor_highlight, eColor_highlighttext, eColor_inactiveborder, eColor_inactivecaption,
  eColor_inactivecaptiontext, eColor_infobackground, eColor_infotext, eColor_menu,
  eColor_menutext, eColor_scrollbar, eColor_threeddarkshadow, eColor_threedface,
  eColor_threedhighlight, eColor_threedlightshadow, eColor_threedshadow, eColor_window,
  eColor_windowframe, eColor_windowtext, eColor__moz_buttondefault, eColor__moz_field,
  eColor__moz_fieldtext, eColor__moz_dialog, eColor__moz_dialogtext, eColor__moz_dragtargetzone,
  eColor__moz_cellhighlight, eColor__moz_cellhighlighttext, eColor__moz_buttonhoverface, eColor__moz_buttonhovertext,
  eColor__moz_menuhover, eColor__moz_menuhovertext, eColor__moz_mac_focusring, eColor__moz_mac_menuselect,
  eColor__moz_mac_menushadow, eColor__moz_mac_menutextdisable, eColor__moz_mac_menutextselect, eColor__moz_mac_accentlightesthighlight,
  eColor__moz_mac_accentregularhighlight, eColor__moz_mac_accentface, eColor__moz_mac_accentlightshadow, eColor__moz_mac_accentregularshadow,
  eColor__moz_mac_accentdarkshadow, eColor__moz_mac_accentdarkestshadow, eColor__moz_mac_alternateprimaryhighlight, eColor__moz_mac_secondaryhighlight,
  eColor_LAST_COLOR
}
enum  nsMetricID {
  eMetric_WindowTitleHeight, eMetric_WindowBorderWidth, eMetric_WindowBorderHeight, eMetric_Widget3DBorder,
  eMetric_TextFieldBorder, eMetric_TextFieldHeight, eMetric_TextVerticalInsidePadding, eMetric_TextShouldUseVerticalInsidePadding,
  eMetric_TextHorizontalInsideMinimumPadding, eMetric_TextShouldUseHorizontalInsideMinimumPadding, eMetric_ButtonHorizontalInsidePaddingNavQuirks, eMetric_ButtonHorizontalInsidePaddingOffsetNavQuirks,
  eMetric_CheckboxSize, eMetric_RadioboxSize, eMetric_ListShouldUseHorizontalInsideMinimumPadding, eMetric_ListHorizontalInsideMinimumPadding,
  eMetric_ListShouldUseVerticalInsidePadding, eMetric_ListVerticalInsidePadding, eMetric_CaretBlinkTime, eMetric_CaretWidth,
  eMetric_ShowCaretDuringSelection, eMetric_SelectTextfieldsOnKeyFocus, eMetric_SubmenuDelay, eMetric_MenusCanOverlapOSBar,
  eMetric_SkipNavigatingDisabledMenuItem, eMetric_DragFullWindow, eMetric_DragThresholdX, eMetric_DragThresholdY,
  eMetric_UseAccessibilityTheme, eMetric_IsScreenReaderActive, eMetric_ScrollArrowStyle, eMetric_ScrollSliderStyle,
  eMetric_TreeOpenDelay, eMetric_TreeCloseDelay, eMetric_TreeLazyScrollDelay, eMetric_TreeScrollDelay,
  eMetric_TreeScrollLinesMax, eMetric_TabFocusModel, eMetric_AlertNotificationOrigin
}
enum  { eMetric_ScrollArrowStyleSingle, eMetric_ScrollArrowStyleBothAtBottom, eMetric_ScrollArrowStyleBothAtEachEnd, eMetric_ScrollArrowStyleBothAtTop }
enum  { eMetric_ScrollThumbStyleNormal, eMetric_ScrollThumbStyleProportional }
enum  nsMetricFloatID {
  eMetricFloat_TextFieldVerticalInsidePadding, eMetricFloat_TextFieldHorizontalInsidePadding, eMetricFloat_TextAreaVerticalInsidePadding, eMetricFloat_TextAreaHorizontalInsidePadding,
  eMetricFloat_ListVerticalInsidePadding, eMetricFloat_ListHorizontalInsidePadding, eMetricFloat_ButtonVerticalInsidePadding, eMetricFloat_ButtonHorizontalInsidePadding
}

Public Member Functions

NS_IMETHOD GetColor (const nsColorID aID, nscolor &aColor)=0
NS_IMETHOD GetMetric (const nsMetricID aID, PRInt32 &aMetric)=0
NS_IMETHOD GetMetric (const nsMetricFloatID aID, float &aMetric)=0
NS_IMETHOD LookAndFeelChanged ()=0

Detailed Description

Definition at line 52 of file nsILookAndFeel.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
eMetric_ScrollArrowStyleSingle 
eMetric_ScrollArrowStyleBothAtBottom 
eMetric_ScrollArrowStyleBothAtEachEnd 
eMetric_ScrollArrowStyleBothAtTop 

Definition at line 212 of file nsILookAndFeel.h.

       {
    eMetric_ScrollArrowStyleSingle,                       // single arrow at each end
    eMetric_ScrollArrowStyleBothAtBottom,                 // both arrows at bottom/right, none at top/left
    eMetric_ScrollArrowStyleBothAtEachEnd,                // both arrows at both ends
    eMetric_ScrollArrowStyleBothAtTop                     // both arrows at top/left, none at bottom/right
  };
anonymous enum
Enumerator:
eMetric_ScrollThumbStyleNormal 
eMetric_ScrollThumbStyleProportional 

Definition at line 218 of file nsILookAndFeel.h.

Enumerator:
eColor_WindowBackground 
eColor_WindowForeground 
eColor_WidgetBackground 
eColor_WidgetForeground 
eColor_WidgetSelectBackground 
eColor_WidgetSelectForeground 
eColor_Widget3DHighlight 
eColor_Widget3DShadow 
eColor_TextBackground 
eColor_TextForeground 
eColor_TextSelectBackground 
eColor_TextSelectForeground 
eColor_TextSelectBackgroundDisabled 
eColor_TextSelectBackgroundAttention 
eColor_activeborder 
eColor_activecaption 
eColor_appworkspace 
eColor_background 
eColor_buttonface 
eColor_buttonhighlight 
eColor_buttonshadow 
eColor_buttontext 
eColor_captiontext 
eColor_graytext 
eColor_highlight 
eColor_highlighttext 
eColor_inactiveborder 
eColor_inactivecaption 
eColor_inactivecaptiontext 
eColor_infobackground 
eColor_infotext 
eColor_menu 
eColor_menutext 
eColor_scrollbar 
eColor_threeddarkshadow 
eColor_threedface 
eColor_threedhighlight 
eColor_threedlightshadow 
eColor_threedshadow 
eColor_window 
eColor_windowframe 
eColor_windowtext 
eColor__moz_buttondefault 
eColor__moz_field 
eColor__moz_fieldtext 
eColor__moz_dialog 
eColor__moz_dialogtext 
eColor__moz_dragtargetzone 
eColor__moz_cellhighlight 
eColor__moz_cellhighlighttext 
eColor__moz_buttonhoverface 
eColor__moz_buttonhovertext 
eColor__moz_menuhover 
eColor__moz_menuhovertext 
eColor__moz_mac_focusring 
eColor__moz_mac_menuselect 
eColor__moz_mac_menushadow 
eColor__moz_mac_menutextdisable 
eColor__moz_mac_menutextselect 
eColor__moz_mac_accentlightesthighlight 
eColor__moz_mac_accentregularhighlight 
eColor__moz_mac_accentface 
eColor__moz_mac_accentlightshadow 
eColor__moz_mac_accentregularshadow 
eColor__moz_mac_accentdarkshadow 
eColor__moz_mac_accentdarkestshadow 
eColor__moz_mac_alternateprimaryhighlight 
eColor__moz_mac_secondaryhighlight 
eColor_LAST_COLOR 

Definition at line 58 of file nsILookAndFeel.h.

               {

    // WARNING : NO NEGATIVE VALUE IN THIS ENUMERATION
    // see patch in bug 57757 for more information

    eColor_WindowBackground,
    eColor_WindowForeground,
    eColor_WidgetBackground,
    eColor_WidgetForeground,
    eColor_WidgetSelectBackground,
    eColor_WidgetSelectForeground,
    eColor_Widget3DHighlight,
    eColor_Widget3DShadow,
    eColor_TextBackground,
    eColor_TextForeground,
    eColor_TextSelectBackground,
    eColor_TextSelectForeground,
    eColor_TextSelectBackgroundDisabled,
    eColor_TextSelectBackgroundAttention,

    // New CSS 2 color definitions
    eColor_activeborder,
    eColor_activecaption,
    eColor_appworkspace,
    eColor_background,
    eColor_buttonface,
    eColor_buttonhighlight,
    eColor_buttonshadow,
    eColor_buttontext,
    eColor_captiontext,
    eColor_graytext,
    eColor_highlight,
    eColor_highlighttext,
    eColor_inactiveborder,
    eColor_inactivecaption,
    eColor_inactivecaptiontext,
    eColor_infobackground,
    eColor_infotext,
    eColor_menu,
    eColor_menutext,
    eColor_scrollbar,
    eColor_threeddarkshadow,
    eColor_threedface,
    eColor_threedhighlight,
    eColor_threedlightshadow,
    eColor_threedshadow,
    eColor_window,
    eColor_windowframe,
    eColor_windowtext,

    eColor__moz_buttondefault,
    // Colors which will hopefully become CSS3
    eColor__moz_field,
    eColor__moz_fieldtext,
    eColor__moz_dialog,
    eColor__moz_dialogtext,
    eColor__moz_dragtargetzone,                         //used to highlight valid regions to drop something onto

    eColor__moz_cellhighlight,                               //used to cell text background, selected but not focus
    eColor__moz_cellhighlighttext,                           //used to cell text, selected but not focus
    eColor__moz_buttonhoverface,                             //used to button text background, when mouse is over
    eColor__moz_buttonhovertext,                             //used to button text, when mouse is over
    eColor__moz_menuhover,                                   //used to menu item background, when mouse is over
    eColor__moz_menuhovertext,                               //used to menu item text, when mouse is over

    //colours needed by Mac Classic skin
    eColor__moz_mac_focusring,                          //ring around text fields and lists
    eColor__moz_mac_menuselect,                         //colour used when mouse is over a menu item
    eColor__moz_mac_menushadow,                         //colour used to do shadows on menu items
    eColor__moz_mac_menutextdisable,                    // color used to display text for disabled menu items
    eColor__moz_mac_menutextselect,                     //colour used to display text while mouse is over a menu item

       //all of the accent colours
       eColor__moz_mac_accentlightesthighlight,
    eColor__moz_mac_accentregularhighlight,
    eColor__moz_mac_accentface,
    eColor__moz_mac_accentlightshadow,
    eColor__moz_mac_accentregularshadow,
    eColor__moz_mac_accentdarkshadow,
    eColor__moz_mac_accentdarkestshadow,
    
    //new in 10.2
    eColor__moz_mac_alternateprimaryhighlight, //active list highlight
    eColor__moz_mac_secondaryhighlight,        //inactive light hightlight
  
    // keep this one last, please
    eColor_LAST_COLOR
  } nsColorID;
Enumerator:
eMetricFloat_TextFieldVerticalInsidePadding 
eMetricFloat_TextFieldHorizontalInsidePadding 
eMetricFloat_TextAreaVerticalInsidePadding 
eMetricFloat_TextAreaHorizontalInsidePadding 
eMetricFloat_ListVerticalInsidePadding 
eMetricFloat_ListHorizontalInsidePadding 
eMetricFloat_ButtonVerticalInsidePadding 
eMetricFloat_ButtonHorizontalInsidePadding 

Definition at line 225 of file nsILookAndFeel.h.

Enumerator:
eMetric_WindowTitleHeight 
eMetric_WindowBorderWidth 
eMetric_WindowBorderHeight 
eMetric_Widget3DBorder 
eMetric_TextFieldBorder 
eMetric_TextFieldHeight 
eMetric_TextVerticalInsidePadding 
eMetric_TextShouldUseVerticalInsidePadding 
eMetric_TextHorizontalInsideMinimumPadding 
eMetric_TextShouldUseHorizontalInsideMinimumPadding 
eMetric_ButtonHorizontalInsidePaddingNavQuirks 
eMetric_ButtonHorizontalInsidePaddingOffsetNavQuirks 
eMetric_CheckboxSize 
eMetric_RadioboxSize 
eMetric_ListShouldUseHorizontalInsideMinimumPadding 
eMetric_ListHorizontalInsideMinimumPadding 
eMetric_ListShouldUseVerticalInsidePadding 
eMetric_ListVerticalInsidePadding 
eMetric_CaretBlinkTime 
eMetric_CaretWidth 
eMetric_ShowCaretDuringSelection 
eMetric_SelectTextfieldsOnKeyFocus 
eMetric_SubmenuDelay 
eMetric_MenusCanOverlapOSBar 
eMetric_SkipNavigatingDisabledMenuItem 
eMetric_DragFullWindow 
eMetric_DragThresholdX 
eMetric_DragThresholdY 
eMetric_UseAccessibilityTheme 
eMetric_IsScreenReaderActive 
eMetric_ScrollArrowStyle 
eMetric_ScrollSliderStyle 
eMetric_TreeOpenDelay 
eMetric_TreeCloseDelay 
eMetric_TreeLazyScrollDelay 
eMetric_TreeScrollDelay 
eMetric_TreeScrollLinesMax 
eMetric_TabFocusModel 
eMetric_AlertNotificationOrigin 

Definition at line 149 of file nsILookAndFeel.h.

               {
    eMetric_WindowTitleHeight,
    eMetric_WindowBorderWidth,
    eMetric_WindowBorderHeight,
    eMetric_Widget3DBorder,
    eMetric_TextFieldBorder,                              // Native border size
    eMetric_TextFieldHeight,
    eMetric_TextVerticalInsidePadding,                    // needed only because of GTK
    eMetric_TextShouldUseVerticalInsidePadding,           // needed only because of GTK
    eMetric_TextHorizontalInsideMinimumPadding,  
    eMetric_TextShouldUseHorizontalInsideMinimumPadding,  // needed only because of GTK
    eMetric_ButtonHorizontalInsidePaddingNavQuirks,  
    eMetric_ButtonHorizontalInsidePaddingOffsetNavQuirks, 
    eMetric_CheckboxSize,
    eMetric_RadioboxSize,
    
    eMetric_ListShouldUseHorizontalInsideMinimumPadding,  // needed only because of GTK
    eMetric_ListHorizontalInsideMinimumPadding,         

    eMetric_ListShouldUseVerticalInsidePadding,           // needed only because of GTK
    eMetric_ListVerticalInsidePadding,                    // needed only because of GTK

    eMetric_CaretBlinkTime,                               // default, may be overriden by OS
    eMetric_CaretWidth,                                   // pixel width of caret
    eMetric_ShowCaretDuringSelection,                       // show the caret when text is selected?
    eMetric_SelectTextfieldsOnKeyFocus,                   // select textfields when focused via tab/accesskey?
    eMetric_SubmenuDelay,                                 // delay before submenus open
    eMetric_MenusCanOverlapOSBar,                         // can popups overlap menu/task bar?
    eMetric_SkipNavigatingDisabledMenuItem,               // skip navigating to disabled menu item?
    eMetric_DragFullWindow,                               // show window contents while dragging?
    eMetric_DragThresholdX,                               // begin a drag if the mouse is moved further than the threshold while the button is down
    eMetric_DragThresholdY,
    eMetric_UseAccessibilityTheme,                        // Accessibility theme being used?
    eMetric_IsScreenReaderActive,                         // Screen reader being used?

    eMetric_ScrollArrowStyle,                             // position of scroll arrows in a scrollbar
    eMetric_ScrollSliderStyle,                            // is scroll thumb proportional or fixed?

    eMetric_TreeOpenDelay,                                // delay for opening spring loaded folders
    eMetric_TreeCloseDelay,                               // delay for closing spring loaded folders
    eMetric_TreeLazyScrollDelay,                          // delay for triggering the tree scrolling
    eMetric_TreeScrollDelay,                              // delay for scrolling the tree
    eMetric_TreeScrollLinesMax,                           // the maximum number of lines to be scrolled at ones
    eMetric_TabFocusModel,                                // What type of tab-order to use

    /*
     * eMetric_AlertNotificationOrigin indicates from which corner of the
     * screen alerts slide in, and from which direction (horizontal/vertical).
     * 0, the default, represents bottom right, sliding vertically.
     * Use any bitwise combination of the following constants:
     * NS_ALERT_HORIZONTAL (1), NS_ALERT_LEFT (2), NS_ALERT_TOP (4).
     *
     *       6       4
     *     +-----------+
     *    7|           |5
     *     |           |
     *    3|           |1
     *     +-----------+
     *       2       0
     */
    eMetric_AlertNotificationOrigin
  } nsMetricID;

Member Function Documentation

NS_IMETHOD nsILookAndFeel::GetColor ( const nsColorID  aID,
nscolor aColor 
) [pure virtual]

Implemented in nsXPLookAndFeel.

Here is the caller graph for this function:

NS_IMETHOD nsILookAndFeel::GetMetric ( const nsMetricID  aID,
PRInt32 aMetric 
) [pure virtual]
NS_IMETHOD nsILookAndFeel::GetMetric ( const nsMetricFloatID  aID,
float &  aMetric 
) [pure virtual]

Implemented in nsXPLookAndFeel, and nsLookAndFeel.


The documentation for this class was generated from the following file: