Automatic generation produced by ISE Eiffel
note description: "Contains information about a button in a toolbar." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2013-01-28 14:34:19 -0900 (Mon, 28 Jan 2013) $" revision: "$Revision: 91020 $" class interface WEL_TOOL_BAR_BUTTON create make -- Allocate `item` -- (from WEL_STRUCTURE) ensure -- from WEL_STRUCTURE not_shared: not shared make_button (a_bitmap_index, a_command_id: INTEGER_32) -- Make a button using a_bitmap_index and -- a_command_id. ensure bitmap_index_set: bitmap_index = a_bitmap_index command_id_set: command_id = a_command_id make_drop_down_button (a_bitmap_index, a_command_id: INTEGER_32) -- Make a drop down button using a_bitmap_index and -- a_command_id. make_check (a_bitmap_index, a_command_id: INTEGER_32) -- Make a check button using a_bitmap_index and -- a_command_id. ensure bitmap_index_set: bitmap_index = a_bitmap_index command_id_set: command_id = a_command_id make_check_group (a_bitmap_index, a_command_id: INTEGER_32) -- Make a check group using a_bitmap_index and -- a_command_id. ensure bitmap_index_set: bitmap_index = a_bitmap_index command_id_set: command_id = a_command_id make_group (a_bitmap_index, a_command_id: INTEGER_32) -- Make an enabled check group using a_bitmap_index -- and a_command_id. ensure bitmap_index_set: bitmap_index = a_bitmap_index command_id_set: command_id = a_command_id make_separator -- Make a separator providing a small gap between -- groups. make_by_pointer (a_pointer: POINTER) -- Set `item` with a_pointer. -- Since `item` is shared, it does not need -- to be freed. -- Caution: a_pointer must be a pointer -- coming from Windows. -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = a_pointer shared: shared feature -- Access bitmap_index: INTEGER_32 -- Zero-based index of button image command_id: INTEGER_32 -- Command identifier associated with the button. This -- identifier is used in a Wm_command message when the -- button is chosen. data: INTEGER_32 -- Application-defined value generating_type: TYPE [detachable WEL_TOOL_BAR_BUTTON] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) state: INTEGER_32 -- Button state flags. -- See class WEL_TB_STATE_CONSTANTS for values string_index: INTEGER_32 -- Zero-based index of button string. ensure positive_result: Result >= 0 style: INTEGER_32 -- Button style flags. -- See class WEL_TB_STYLE_CONSTANTS for values Tbstate_checked: INTEGER_32 = 1 -- The button has the Tbstyle_checked style and is -- being pressed. -- (from WEL_TB_STATE_CONSTANTS) Tbstate_enabled: INTEGER_32 = 4 -- The button accepts user input. A button not having -- this state does not accept user input and is grayed. -- (from WEL_TB_STATE_CONSTANTS) Tbstate_hidden: INTEGER_32 = 8 -- The button is not visible and cannot receive user -- input. -- (from WEL_TB_STATE_CONSTANTS) Tbstate_indeterminate: INTEGER_32 = 16 -- The button is grayed. -- (from WEL_TB_STATE_CONSTANTS) Tbstate_pressed: INTEGER_32 = 2 -- The button is being pressed. -- (from WEL_TB_STATE_CONSTANTS) Tbstate_wrap: INTEGER_32 = 32 -- A line break follows the button. The button must -- also have the Tbstate_enabled state. -- (from WEL_TB_STATE_CONSTANTS) feature -- Access -- A toolbar can have a combination of the following styles. Tbstyle_altdrag: INTEGER_32 = 1024 -- Allows the user to change the position of a toolbar -- button by dragging it while holding down the ALT key. -- If this style is not specified, the user must hold -- down the SHIFT key while dragging a button. Note -- that the Ccs_adjustable style must be specified to -- enable toolbar buttons to be dragged. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_autosize: INTEGER_32 = 16 -- The toolbar will not assign the standard width to -- the button. Instead, the buttons width will be calculated -- based on the width of the text plus the image of the -- button. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_button: INTEGER_32 = 0 -- Creates a standard push button. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_check: INTEGER_32 = 2 -- Creates a button that toggles between the pressed -- and not pressed states each time the user clicks it. -- The button has a different background color when it -- is in the pressed state. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_checkgroup: INTEGER_32 = 6 -- Creates a check button that stays pressed until -- another button in the group is pressed. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_customerase: INTEGER_32 = 8192 -- Generates NM_CUSTOMDRAW notification messages when -- it processes WM_ERASEBKGND. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_dropdown: INTEGER_32 = 8 -- Creates a drop-down list button. If the toolbar has -- the TBSTYLE_EX_DRAWDDARROWS extended style, an arrow -- will be displayed next to the button. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_flat: INTEGER_32 = 2048 -- Creates a transparent toolbar with flat buttons. -- The apparence of the button change when the user -- move the mouse on the button. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_group: INTEGER_32 = 4 -- Creates a button that stays pressed until another -- button in the group is pressed. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_list: INTEGER_32 = 4096 -- Places button text to the right of button bitmaps. -- To avoid repainting problems, this style should be -- set before the toolbar control becomes visible. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_sep: INTEGER_32 = 1 -- Creates a separator, providing a small gap between -- button groups. A button that has this style does not -- receive user input. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_tooltips: INTEGER_32 = 256 -- Creates a tooltip control that an application can -- use to display descriptive text for the buttons in -- the toolbar. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_transparent: INTEGER_32 = 32768 -- Version 4.71. Creates a transparent toolbar. In a transparent toolbar, -- the toolbar is transparent but the buttons are not. Button text appears -- under button bitmaps. To prevent repainting problems, this style should -- be set before the toolbar control becomes visible. -- A button in a toolbar can have a combination of the following styles. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_wrapable: INTEGER_32 = 512 -- Creates a toolbar that can have multiple lines of -- buttons. Toolbar buttons can "wrap" to the next -- line when the toolbar becomes too narrow to include -- all buttons on the same line. Wrapping occurs on -- separation and non-group boundaries. -- (from WEL_TB_STYLE_CONSTANTS) feature -- Measurement Structure_size: INTEGER_32 -- Size to allocate (in bytes) ensure -- from WEL_STRUCTURE positive_result: Result > 0 feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: WEL_TOOL_BAR_BUTTON): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: WEL_TOOL_BAR_BUTTON): 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 `item` exist? -- (from WEL_ANY) ensure -- from WEL_ANY Result = (item /= default_pointer) 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)) shared: BOOLEAN -- Is `item` shared by another object? -- If False (by default), `item` will -- be destroyed by `destroy_item`. -- If True, `item` will not be destroyed. -- (from WEL_ANY) feature -- Status setting set_shared -- Set `shared` to True. -- (from WEL_ANY) ensure -- from WEL_ANY shared: shared set_unshared -- Set `shared` to False. -- (from WEL_ANY) ensure -- from WEL_ANY unshared: not shared feature -- Element change set_bitmap_index (a_bitmap_index: INTEGER_32) -- Set `bitmap_index` with a_bitmap_index. ensure bitmap_index_set: bitmap_index = a_bitmap_index set_command_id (a_command_id: INTEGER_32) -- Set `command_id` with a_command_id. ensure command_id_set: command_id = a_command_id set_data (a_data: INTEGER_32) -- Set `data` with a_data. ensure data_set: data = a_data set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item set_state (a_state: INTEGER_32) -- Set `state` with a_state. ensure state_set: state = a_state set_string_index (a_string_index: INTEGER_32) -- Set `string_index` with a_string_index. require positive_index: a_string_index >= 0 ensure string_index_set: string_index = a_string_index set_style (a_style: INTEGER_32) -- Set `style` with a_style. ensure style_set: style = a_style feature -- Removal dispose -- Destroy the inner structure of Current. -- -- This function should be called by the GC when the -- object is collected or by the user if Current is -- no more usefull. -- (from WEL_ANY) feature -- Duplication frozen deep_copy (other: WEL_TOOL_BAR_BUTTON) -- 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: WEL_TOOL_BAR_BUTTON -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: WEL_TOOL_BAR_BUTTON) -- 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: WEL_TOOL_BAR_BUTTON -- 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: WEL_TOOL_BAR_BUTTON -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations copy (other: WEL_TOOL_BAR_BUTTON) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from WEL_STRUCTURE) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen default: detachable WEL_TOOL_BAR_BUTTON -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class initialize -- Fill Current with zeros. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists initialize_with_character (a_character: CHARACTER_8) -- Fill current with a_character. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists is_equal (other: WEL_TOOL_BAR_BUTTON): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from WEL_STRUCTURE) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result memory_copy (source_pointer: POINTER; length: INTEGER_32) -- Copy length bytes from source_pointer to `item`. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE length_small_enough: length <= Structure_size length_large_enough: length > 0 exists: exists feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Tool bar button styles Btns_autosize: INTEGER_32 = 16 -- Version 5.80. Specifies that the toolbar control should -- not assign the standard width to the button. Instead, -- the button's width will be calculated based on the width -- of the text plus the image of the button. -- Use the equivalent style flag, TBSTYLE_AUTOSIZE, for -- version 4.72 and earlier. -- (from WEL_TB_STYLE_CONSTANTS) Btns_dropdown: INTEGER_32 = 8 -- Version 5.80. Creates a drop-down style button that -- can display a list when the button is clicked. Instead -- of the WM_COMMAND message used for normal buttons, -- drop-down buttons send a TBN_DROPDOWN notification. -- An application can then have the notification handler -- display a list of options. Use the equivalent style -- flag, TBSTYLE_DROPDOWN, for version 4.72 and earlier. -- If the toolbar has the TBSTYLE_EX_DRAWDDARROWS extended -- style, drop-down buttons will have a drop-down arrow -- displayed in a separate section to their right. If the -- arrow is clicked, a TBN_DROPDOWN notification will be -- sent. If the associated button is clicked, a WM_COMMAND -- message will be sent. -- (from WEL_TB_STYLE_CONSTANTS) Btns_showtext: INTEGER_32 = 64 -- Version 5.81. Specifies that button text should be -- displayed. All buttons can have text, but only those -- buttons with the BTNS_SHOWTEXT button style will -- display it. This button style must be used with the -- TBSTYLE_LIST style and the TBSTYLE_EX_MIXEDBUTTONS -- extended style. If you set text for buttons that do -- not have the BTNS_SHOWTEXT style, the toolbar control -- will automatically display it as a ToolTip when the -- cursor hovers over the button. This feature allows your -- application to avoid handling the TBN_GETINFOTIP -- notification for the toolbar. -- (from WEL_TB_STYLE_CONSTANTS) feature -- Tool bar extended styles Tbstyle_ex_doublebuffer: INTEGER_32 = 128 -- Version 6. This style requires the toolbar to be double -- buffered. Double buffering is a mechanism that detects when -- the toolbar has changed. -- Note Comctl32.dll version 6 is not redistributable but it -- is included in Microsoft Windows XP or later. To use -- Comctl32.dll version 6, specify it in a manifest. For more -- information on manifests, see Using Windows XP Visual Styles. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_ex_drawddarrows: INTEGER_32 = 1 -- Version 4.71. This style allows buttons to have a separate -- dropdown arrow. Buttons that have the BTNS_DROPDOWN style -- will be drawn with a drop-down arrow in a separate section, -- to the right of the button. If the arrow is clicked, only -- the arrow portion of the button will depress, and the toolbar -- control will send a TBN_DROPDOWN notification to prompt the -- application to display the dropdown menu. If the main part -- of the button is clicked, the toolbar control sends a -- WM_COMMAND message with the button's ID. The application -- normally responds by launching the first command on the menu. -- There are many situations where you may want to have only -- some of the dropdown buttons on a toolbar with separated. -- To do so, set the TBSTYLE_EX_DRAWDDARROWS extended style. -- Give those buttons that will not have separated arrows the -- BTNS_WHOLEDROPDOWN style. Buttons with this style will have -- an arrow displayed next to the image. However, the arrow will -- not be separate and when any part of the button is clicked, -- the toolbar control will send a TBN_DROPDOWN notification. -- To prevent repainting problems, this style should be set -- before the toolbar control becomes visible. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_ex_hideclippedbuttons: INTEGER_32 = 16 -- Version 5.81. This style hides partially clipped buttons. -- The most common use of this style is for toolbars that are -- part of a rebar control. If an adjacent band covers part of -- a button, the button will not be displayed. However, if the -- rebar band has the RBBS_USECHEVRON style, the button will be -- displayed on the chevron's dropdown menu. -- (from WEL_TB_STYLE_CONSTANTS) Tbstyle_ex_mixedbuttons: INTEGER_32 = 8 -- Version 5.81. This style allows you to set text for all -- buttons, but only display it for those buttons with the -- BTNS_SHOWTEXT button style. The TBSTYLE_LIST style must also -- be set. Normally, when a button does not display text, your -- application must handle TBN_GETINFOTIP to display a ToolTip. -- With the TBSTYLE_EX_MIXEDBUTTONS extended style, text that -- is set but not displayed on a button will automatically be -- used as the button's ToolTip text. Your application only -- needs to handle TBN_GETINFOTIP if it needs more flexibility -- in specifying the ToolTip text. -- (from WEL_TB_STYLE_CONSTANTS) invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note 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_TOOL_BAR_BUTTON -- Generated by Eiffel Studio --
For more details: eiffel.org