indexing description: "Common type for several control which backgound and foreground colors can be changed" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $" revision: "$Revision: 56675 $" deferred class interface WEL_COLOR_CONTROL feature -- Access background_color: WEL_COLOR_REF -- Background color used for the background of the -- control require exists: exists ensure background_color_not_void: Result /= Void color_3ddkshadow: INTEGER_32 is 21 -- Dark shadow for three-dimensional display elements. -- -- Declared in Windows as COLOR_3DDKSHADOW -- (from WEL_COLOR_CONSTANTS) color_3dface: INTEGER_32 is 15 -- Face color for three-dimensional display elements and -- for dialog box backgrounds. -- -- Declared in Windows as COLOR_3DFACE -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_btnface. -- (from WEL_COLOR_CONSTANTS) color_3dhighlight: INTEGER_32 is 20 -- Highlight color for three-dimensional display elements -- (for edges facing the light source.) -- -- Declared in Windows as COLOR_3DHILIGHT -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_3dhilight, Color_btnhilight and Color_btnhighlight. -- (from WEL_COLOR_CONSTANTS) color_3dhilight: INTEGER_32 is 20 -- Highlight color for three-dimensional display elements -- (for edges facing the light source.) -- -- Declared in Windows as COLOR_3DHILIGHT -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_3dhighlight, Color_btnhilight and Color_btnhighlight. -- (from WEL_COLOR_CONSTANTS) color_3dlight: INTEGER_32 is 22 -- Light color for three-dimensional display elements -- (for edges facing the light source.) -- -- Declared in Windows as COLOR_3DLIGHT -- (from WEL_COLOR_CONSTANTS) color_3dshadow: INTEGER_32 is 16 -- Shadow color for three-dimensional display elements -- (for edges facing away from the light source). -- -- Declared in Windows as COLOR_3DSHADOW -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_btnshadow. -- (from WEL_COLOR_CONSTANTS) color_activeborder: INTEGER_32 is 10 -- Active window border. -- -- Declared in Windows as COLOR_ACTIVEBORDER -- (from WEL_COLOR_CONSTANTS) color_activecaption: INTEGER_32 is 2 -- Active window title bar. -- -- Windows 98/Me, Windows 2000 or later: -- Specifies the left side color in the color gradient of an active -- window's title bar if the gradient effect is enabled. -- -- Declared in Windows as COLOR_ACTIVECAPTION -- (from WEL_COLOR_CONSTANTS) color_appworkspace: INTEGER_32 is 12 -- Background color of multiple document interface (MDI) applications. -- -- Declared in Windows as COLOR_APPWORKSPACE -- (from WEL_COLOR_CONSTANTS) color_background: INTEGER_32 is 1 -- Desktop. -- -- Declared in Windows as COLOR_BACKGROUND -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_desktop. -- (from WEL_COLOR_CONSTANTS) color_btnface: INTEGER_32 is 15 -- Face color for three-dimensional display elements and -- for dialog box backgrounds. -- -- Declared in Windows as COLOR_3DFACE -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_3dface. -- (from WEL_COLOR_CONSTANTS) color_btnhighlight: INTEGER_32 is 20 -- Highlight color for three-dimensional display elements -- (for edges facing the light source.) -- -- Declared in Windows as COLOR_3DHILIGHT -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_3dhilight, Color_3dhighlight and Color_btnhilight. -- (from WEL_COLOR_CONSTANTS) color_btnhilight: INTEGER_32 is 20 -- Highlight color for three-dimensional display elements -- (for edges facing the light source.) -- -- Declared in Windows as COLOR_3DHILIGHT -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_3dhilight, Color_3dhighlight and Color_btnhighlight. -- (from WEL_COLOR_CONSTANTS) color_btnshadow: INTEGER_32 is 16 -- Shadow color for three-dimensional display elements -- (for edges facing away from the light source). -- -- Declared in Windows as COLOR_3DSHADOW -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_3dshadow. -- (from WEL_COLOR_CONSTANTS) color_btntext: INTEGER_32 is 18 -- Text on push buttons. -- -- Declared in Windows as COLOR_BTNTEXT -- (from WEL_COLOR_CONSTANTS) color_captiontext: INTEGER_32 is 9 -- Text in caption, size box, and scroll bar arrow box. -- -- Declared in Windows as COLOR_CAPTIONTEXT -- (from WEL_COLOR_CONSTANTS) color_desktop: INTEGER_32 is 1 -- Desktop. -- -- Declared in Windows as COLOR_BACKGROUND -- Was declared in WEL_COLOR_CONSTANTS as synonym of Color_background. -- (from WEL_COLOR_CONSTANTS) color_gradientactivecaption: INTEGER_32 is 27 -- Windows 98/Me, Windows 2000 or later: -- Right side color in the color gradient of an active window's -- title bar. COLOR_ACTIVECAPTION specifies the left side color. -- Use SPI_GETGRADIENTCAPTIONS with the SystemParametersInfo -- function to determine whether the gradient effect is enabled. -- -- Declared in Windows as COLOR_GRADIENTACTIVECAPTION -- (from WEL_COLOR_CONSTANTS) color_gradientinactivecaption: INTEGER_32 is 28 -- Windows 98/Me, Windows 2000 or later: -- Right side color in the color gradient of an inactive window's -- title bar. COLOR_INACTIVECAPTION specifies the left side color. -- -- Declared in Windows as COLOR_GRADIENTINACTIVECAPTION -- (from WEL_COLOR_CONSTANTS) color_graytext: INTEGER_32 is 17 -- Grayed (disabled) text. This color is set to 0 if the current -- display driver does not support a solid gray color. -- -- Declared in Windows as COLOR_GRAYTEXT -- (from WEL_COLOR_CONSTANTS) color_highlight: INTEGER_32 is 13 -- Item(s) selected in a control. -- -- Declared in Windows as COLOR_HIGHLIGHT -- (from WEL_COLOR_CONSTANTS) color_highlighttext: INTEGER_32 is 14 -- Text of item(s) selected in a control. -- -- Declared in Windows as COLOR_HIGHLIGHTTEXT -- (from WEL_COLOR_CONSTANTS) color_hotlight: INTEGER_32 is 26 -- Windows 98/Me, Windows 2000 or later: -- Color for a hot-tracked item. Single clicking a hot-tracked -- item executes the item. -- -- Declared in Windows as COLOR_HOTLIGHT -- (from WEL_COLOR_CONSTANTS) color_inactiveborder: INTEGER_32 is 11 -- Inactive window border. -- -- Declared in Windows as COLOR_INACTIVEBORDER -- (from WEL_COLOR_CONSTANTS) color_inactivecaption: INTEGER_32 is 3 -- Inactive window caption. -- -- Windows 98/Me, Windows 2000 or later: -- Specifies the left side color in the color gradient of an inactive -- window's title bar if the gradient effect is enabled. -- -- Declared in Windows as COLOR_INACTIVECAPTION -- (from WEL_COLOR_CONSTANTS) color_inactivecaptiontext: INTEGER_32 is 19 -- Color of text in an inactive caption. -- -- Declared in Windows as COLOR_INACTIVECAPTIONTEXT -- (from WEL_COLOR_CONSTANTS) color_infobk: INTEGER_32 is 24 -- Background color for tooltip controls. -- -- Declared in Windows as COLOR_INFOBK -- (from WEL_COLOR_CONSTANTS) color_infotext: INTEGER_32 is 23 -- Text color for tooltip controls. -- -- Declared in Windows as COLOR_INFOTEXT -- (from WEL_COLOR_CONSTANTS) color_menu: INTEGER_32 is 4 -- Menu background. -- -- Declared in Windows as COLOR_MENU -- (from WEL_COLOR_CONSTANTS) color_menubar: INTEGER_32 is 30 -- Windows XP: -- The background color for the menu bar when menus appear as -- flat menus (see SystemParametersInfo). However, Color_menu -- continues to specify the background color of the menu popup. -- -- Declared in Windows as COLOR_MENUBAR -- (from WEL_COLOR_CONSTANTS) color_menuhilight: INTEGER_32 is 29 -- Windows XP: -- The color used to highlight menu items when the menu appears -- as a flat menu (see SystemParametersInfo). The highlighted -- menu item is outlined with COLOR_HIGHLIGHT. -- -- Declared in Windows as COLOR_MENUHILIGHT -- (from WEL_COLOR_CONSTANTS) color_menutext: INTEGER_32 is 7 -- Text in menus. -- -- Declared in Windows as COLOR_MENUTEXT -- (from WEL_COLOR_CONSTANTS) color_scrollbar: INTEGER_32 is 0 -- Scroll bar gray area. -- -- Declared in Windows as COLOR_SCROLLBAR -- (from WEL_COLOR_CONSTANTS) color_window: INTEGER_32 is 5 -- Window background. -- -- Declared in Windows as COLOR_WINDOW -- (from WEL_COLOR_CONSTANTS) color_windowframe: INTEGER_32 is 6 -- Window frame. -- -- Declared in Windows as COLOR_WINDOWFRAME -- (from WEL_COLOR_CONSTANTS) color_windowtext: INTEGER_32 is 8 -- Text in windows. -- -- Declared in Windows as COLOR_WINDOWTEXT -- (from WEL_COLOR_CONSTANTS) foreground_color: WEL_COLOR_REF -- foreground color used for the text of the -- control require exists: exists ensure foreground_color_not_void: Result /= Void generating_type: STRING_8 -- Name of current object's generating type -- (type of which it is a direct instance) -- (from ANY) generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) feature -- Comparison frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN -- Are `some' and `other' either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY shallow_implies_deep: standard_equal (some, other) implies Result both_or_none_void: (some = Void) implies (Result = (other = Void)) same_type: (Result and (some /= Void)) implies some.same_type (other) symmetric: Result implies deep_equal (other, some) frozen equal (some: ANY; other: like arg #1): BOOLEAN -- Are `some' and `other' either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other)) is_equal (other: like Current): BOOLEAN -- Is `other' attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other.is_equal (Current) consistent: standard_is_equal (other) implies Result frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN -- Are `some' and `other' either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other)) frozen standard_is_equal (other: like Current): BOOLEAN -- Is `other' attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of `other' (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void exists: BOOLEAN -- Does the control exists ? same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of `other'? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) valid_color_constant (c: INTEGER_32): BOOLEAN -- Is `c' a valid color constant? -- (from WEL_COLOR_CONSTANTS) feature -- Duplication copy (other: like Current) -- Update current object using fields of object attached -- to `other', so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: is_equal (other) frozen deep_copy (other: like Current) -- Effect equivalent to that of: -- copy (`other' . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: like Current -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_equal: deep_equal (Current, Result) frozen standard_copy (other: like Current) -- Copy every field of `other' onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: like Current -- New object field-by-field identical to `other'. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: like Current -- New object equal to `Current' -- twin calls copy; to change copying/twining semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result.is_equal (Current) feature -- Basic operations frozen default: like Current -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type `POINTER' -- (Avoid the need to write `p'.default for -- some `p' of type `POINTER'.) -- (from ANY) default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) feature -- Output io: STD_FILES -- Handle to standard file setup -- (from ANY) out: STRING_8 -- New string containing terse printable representation -- of current object -- Was declared in ANY as synonym of tagged_out. -- (from ANY) print (some: ANY) -- Write terse external representation of `some' -- on standard output. -- (from ANY) frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- Was declared in ANY as synonym of out. -- (from ANY) feature -- Platform operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) indexing copyright: "Copyright (c) 1984-2006, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 356 Storke Road, Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class WEL_COLOR_CONTROL