Automatic generation produced by ISE Eiffel
note description: "[ Enhancement of the toolbar. This toolbar appears flat and use imagelist to store bitmaps - Win95+IE3 required Note: The common controls dll (WEL_COMMON_CONTROLS_DLL) needs to be loaded to use this control and IE3 or above installed. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2009-02-24 15:44:31 -0800 (Tue, 24 Feb 2009) $" revision: "$Revision: 77298 $" class interface WEL_IMAGELIST_TOOL_BAR create make (a_parent: WEL_WINDOW; an_id: INTEGER_32) -- Create a toolbar with `a_parent' as parent and -- `an_id' as id. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR a_parent_not_void: a_parent /= Void a_parent_exists: a_parent.exists ensure -- from WEL_TOOL_BAR exists: exists parent_set: parent = a_parent id_set: id = an_id feature -- Access bitmaps_height: INTEGER_32 -- height of all bitmaps located in this imageList require exists: exists bitmaps_width: INTEGER_32 -- width of all bitmaps located in this imageList require exists: exists buttons_height: INTEGER_32 -- Height of the buttons in the toolbar. require exists: exists buttons_width: INTEGER_32 -- Width of the buttons in the toolbar. require exists: exists commands: detachable WEL_COMMAND_MANAGER -- Command manager associated to the current window. -- (from WEL_WINDOW) default_processing: BOOLEAN -- (from WEL_RETURN_VALUE) font: WEL_FONT -- Font with which the control is drawing its text. -- (from WEL_CONTROL) require -- from WEL_CONTROL exists: exists ensure -- from WEL_CONTROL result_not_void: Result /= Void generating_type: TYPE [detachable WEL_IMAGELIST_TOOL_BAR] -- 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 has_return_value: BOOLEAN -- Should the window procedure return a value? -- (from WEL_RETURN_VALUE) id: INTEGER_32 -- Control id -- (from WEL_CONTROL) item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) message_return_value: POINTER -- Return value of the window procedure. -- (from WEL_RETURN_VALUE) require -- from WEL_RETURN_VALUE has_return_value: has_return_value parent: detachable WEL_WINDOW -- Parent window -- (from WEL_WINDOW) 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 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 definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal (other: attached WEL_IMAGELIST_TOOL_BAR): 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) is_equal (other: attached WEL_IMAGELIST_TOOL_BAR): 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 ~ Current consistent: standard_is_equal (other) implies Result 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 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 (other: attached WEL_IMAGELIST_TOOL_BAR): 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 absolute_x: INTEGER_32 -- Absolute x position -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW Result = window_rect.x absolute_y: INTEGER_32 -- Absolute y position -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW Result = window_rect.y background_brush: detachable WEL_BRUSH -- Current window background color used to refresh the window when -- requested by the WM_ERASEBKGND windows message. -- By default there is no background -- (from WEL_WINDOW) ensure -- from WEL_WINDOW new_object: Result /= Void implies Result /= background_brush background_brush_gdip: detachable WEL_GDIP_BRUSH -- GDI+ version of background_brush -- Result void if GDI+ not available -- (from WEL_WINDOW) button_checked (command_id: INTEGER_32): BOOLEAN -- Is the button identified by `command_id' checked? -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists button_count: INTEGER_32 -- Number of buttons in toolbar -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR positive_result: Result >= 0 button_enabled (command_id: INTEGER_32): BOOLEAN -- Is the button identified by `command_id' enabled? -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists button_hidden (command_id: INTEGER_32): BOOLEAN -- Is the button identified by `command_id' hidden? -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists button_indeterminate (command_id: INTEGER_32): BOOLEAN -- Is the button identified by `command_id' -- indeterminate? -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists button_pressed (command_id: INTEGER_32): BOOLEAN -- Is the button identified by `command_id' pressed? -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists button_rect (index: INTEGER_32): WEL_RECT -- Rectangle of button at the zero-based `index'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists index_large_enough: index >= 0 index_small_enough: index < button_count ensure -- from WEL_TOOL_BAR result_not_void: Result /= Void captured_window: detachable WEL_WINDOW -- Current window which has been captured. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists window_captured: window_captured client_rect: WEL_RECT -- Client rectangle -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW result_not_void: Result /= Void command (message: INTEGER_32): WEL_COMMAND -- Command associated to `message' -- (from WEL_WINDOW) require -- from WEL_WINDOW positive_message: message >= 0 command_exists: command_exists (message) ensure -- from WEL_WINDOW result_not_void: Result /= Void command_argument (message: INTEGER_32): detachable ANY -- Command argument associated to `message' -- (from WEL_WINDOW) require -- from WEL_WINDOW positive_message: message >= 0 command_exists: command_exists (message) command_exists (message: INTEGER_32): BOOLEAN -- Does a command associated to `message' exist? -- (from WEL_WINDOW) require -- from WEL_WINDOW positive_message: message >= 0 ensure -- from WEL_WINDOW definition: Result implies attached commands as l_commands_var and then l_commands_var.item (message) /= Void commands_enabled: BOOLEAN -- Is the commands execution enabled? -- (from WEL_WINDOW) 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 enabled: BOOLEAN -- Is the window enabled for mouse and keyboard input? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ex_style: INTEGER_32 -- Window ex_style -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists exists: BOOLEAN -- Does the item exist? -- (from WEL_ANY) ensure -- from WEL_ANY Result = (item /= default_pointer) find_button (a_x, a_y: INTEGER_32): INTEGER_32 -- Determines where a point lies in a toolbar control. -- -- Returns an integer value. If the return value is zero or a positive value, -- it is the zero-based index of the nonseparator item in which the point lies. -- If the return value is negative, the point does not lie within a button. -- The absolute value of the return value is the index of a separator item -- or the nearest nonseparator item. require exists: exists focused_window: detachable WEL_WINDOW -- Current window which has the focus. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists get_max_height: INTEGER_32 -- Retrieves the common height of all of the visible buttons and separators in the toolbar. require exists: exists get_max_size: WEL_SIZE -- Retrieves the total size of all of the visible buttons and separators in the toolbar require exists: exists get_max_width: INTEGER_32 -- Retrieves the total width of all of the visible buttons and separators in the toolbar. require exists: exists has_bitmap: BOOLEAN -- Does the toolbar contains one bitmap or more? -- (from WEL_TOOL_BAR) has_capture: BOOLEAN -- Does this window have the capture? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists has_focus: BOOLEAN -- Does this window have the focus? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists has_horizontal_scroll_bar: BOOLEAN -- Does this window have a horizontal scroll bar? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists has_system_font: BOOLEAN -- Does the control use the system font? -- (from WEL_CONTROL) require -- from WEL_CONTROL exists: exists has_vertical_scroll_bar: BOOLEAN -- Does this window have a vertical scroll bar? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists height: INTEGER_32 -- Window height -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists i_th_button (index: INTEGER_32): WEL_TOOL_BAR_BUTTON -- Button at the zero-based `index'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists index_large_enough: index >= 0 index_small_enough: index < button_count ensure -- from WEL_TOOL_BAR result_not_void: Result /= Void is_inside: BOOLEAN -- Is the current window inside another window? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists last_bitmap_index: INTEGER_32 -- Last bitmap index added by add_bitmaps. -- (from WEL_TOOL_BAR) last_string_index: INTEGER_32 -- Last string index added by add_strings. -- (from WEL_TOOL_BAR) maximal_height: INTEGER_32 -- Maximal height allowed for the window -- (from WEL_WINDOW) ensure -- from WEL_WINDOW result_large_enough: Result >= minimal_height maximal_width: INTEGER_32 -- Maximal width allowed for the window -- (from WEL_WINDOW) ensure -- from WEL_WINDOW result_large_enough: Result >= minimal_width maximized: BOOLEAN -- Is the window maximized? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists minimal_height: INTEGER_32 -- Minimal height allowed for the window -- Zero by default. -- (from WEL_WINDOW) ensure -- from WEL_WINDOW positive_result: Result >= 0 result_small_enough: Result <= maximal_height minimal_width: INTEGER_32 -- Minimal width allowed for the window -- Zero by default. -- (from WEL_WINDOW) ensure -- from WEL_WINDOW positive_result: Result >= 0 result_small_enough: Result <= maximal_width minimized: BOOLEAN -- Is the window minimized? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists placement: WEL_WINDOW_PLACEMENT -- Window placement information -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW result_not_void: Result /= Void 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) shown: BOOLEAN -- Is the window shown? -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists style: INTEGER_32 -- Window style -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists tooltip: detachable WEL_TOOLTIP -- The tooltip associated with the toolbar -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR tooltip_exists: tooltip_exists tooltip_exists: BOOLEAN -- Is there a tooltip associated to the toolbar? -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists valid_hwnd_constant (c: POINTER): BOOLEAN -- Is `c' a valid hwnd constant? -- (from WEL_HWND_CONSTANTS) width: INTEGER_32 -- Window width -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists window_captured: BOOLEAN -- Has a window been captured? -- (from WEL_WINDOW) window_rect: WEL_RECT -- Window rectangle (absolute position) -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW result_not_void: Result /= Void x: INTEGER_32 -- Window x position -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW parent = Void implies Result = absolute_x y: INTEGER_32 -- Window y position -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW parent = Void implies Result = absolute_y feature -- Status setting check_button (command_id: INTEGER_32) -- Checks a button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_is_checked: button_checked (command_id) clear_indeterminate_state (command_id: INTEGER_32) -- Clear the indeterminate state of the button -- identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_not_indeterminate: not button_indeterminate (command_id) disable -- Disable mouse and keyboard input -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW disabled: not enabled disable_button (command_id: INTEGER_32) -- Disable the button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_disabled: not button_enabled (command_id) disable_commands -- Disable commands execution. -- (from WEL_WINDOW) ensure -- from WEL_WINDOW commands_disabled: not commands_enabled disable_default_processing -- Disable default window processing. -- The standard window procedure will not be called for -- each messages received by the window and then the -- normal behavior will not occur. -- (from WEL_WINDOW) ensure -- from WEL_WINDOW default_processing_disabled: not default_processing disable_drag_accept_files -- Disallow `Current' from being a file drag and drop target. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists disable_hot_item -- Unset the hot item. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists enable -- Enable mouse and keyboard input. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW enabled: enabled enable_button (command_id: INTEGER_32) -- Enable the button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_enabled: button_enabled (command_id) enable_commands -- Enable commands execution. -- (from WEL_WINDOW) ensure -- from WEL_WINDOW commands_enabled: commands_enabled enable_default_processing -- Enable default window processing. -- The standard window procedure will be called for -- each messages received by the window and then the -- normal behavior will occur. -- (from WEL_WINDOW) ensure -- from WEL_WINDOW default_processing_enabled: default_processing enable_drag_accept_files -- Allow `Current' to be a file drag and drop target. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists enable_hot_item (command_id: INTEGER_32) -- Set hot item for button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists hide -- Hide the window -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW hidden: not shown hide_button (command_id: INTEGER_32) -- Hide the button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_hidden: button_hidden (command_id) maximize -- Maximize the window -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW maximized: maximized minimize -- Minimize the window and display its icon -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW minimized: minimized press_button (command_id: INTEGER_32) -- Press the button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_pressed: button_pressed (command_id) release_button (command_id: INTEGER_32) -- Release the button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_not_pressed: not button_pressed (command_id) release_capture -- Release the mouse capture after a call -- to set_capture. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists has_capture: has_capture ensure -- from WEL_WINDOW not_has_capture: not has_capture restore -- Restore the window to its -- original size and position after -- minimize or maximize -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_bitmap_size (a_width, a_height: INTEGER_32) -- Sets the size of the bitmapped images to be added to -- the toolbar. -- The size can be set only before adding any -- bitmaps to the toolbar. If an application does -- not explicitly set the bitmap size, the size -- defaults to 16 by 15 pixels. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists positive_width: a_width >= 0 positive_height: a_height >= 0 no_bitmap_present: not has_bitmap set_button_size (a_width, a_height: INTEGER_32) -- Set the size of the buttons to be added to the -- toolbar. -- The size can be set only before adding any buttons -- to the toolbar. If an application does not -- explicitly set the button size, the size defaults -- to 24 by 22 pixels. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists positive_width: a_width >= 0 positive_height: a_height >= 0 no_existing_buttons: button_count = 0 set_capture -- Set the mouse capture to the `Current' window. -- Once the window has captured the mouse, all -- mouse input is directed to this window, regardless -- of whether the cursor is over that window. Only -- one window can have the mouse capture at a time. -- -- Works only for windows in the same thread as your -- application. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists has_not_capture: not has_capture set_ex_style (an_ex_style: INTEGER_32) -- Set `an_ex_style' with ex_style. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_focus -- Set the focus to `Current' -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_identifier (index, an_id: INTEGER_32) -- Set the identifier for the button at zero-based -- `index' to `an_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists index_large_enough: index >= 0 index_small_enough: index < button_count set_indeterminate_state (command_id: INTEGER_32) -- Set the indeterminate state of the button -- identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_indeterminate: button_indeterminate (command_id) set_rows (a_row_count: INTEGER_32) -- Try to set items in toolbar to show in `a_row_count' -- rows. The actual result maybe different base on buttons' -- pixmaps' widths and buttons texts' widths. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists valid: a_row_count > 0 set_shared -- Set shared to True. -- (from WEL_ANY) ensure -- from WEL_ANY shared: shared set_style (a_style: INTEGER_32) -- Set style with `a_style'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_tooltip (a_tooltip: WEL_TOOLTIP) -- Associate a tooltip control with the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists a_tooltip_not_void: a_tooltip /= Void a_tooltip_exists: a_tooltip.exists ensure -- from WEL_TOOL_BAR tooltip_exists: tooltip_exists tooltip_set: tooltip = a_tooltip set_unshared -- Set shared to False. -- (from WEL_ANY) ensure -- from WEL_ANY unshared: not shared show -- Show the window -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists show_button (command_id: INTEGER_32) -- Show the button identified by `command_id'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_shown: not button_hidden (command_id) uncheck_button (command_id: INTEGER_32) -- Unchecks a button identified by `command_id' -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists ensure -- from WEL_TOOL_BAR button_unchecked: not button_checked (command_id) update_cached_style (new_ex_style, old_ex_style: INTEGER_32) -- Update Window cache buffer for Window style. -- (from WEL_WINDOW) feature -- Element change add_bitmaps (tb_bitmap: WEL_TOOL_BAR_BITMAP; bitmap_count: INTEGER_32) -- Add bitmaps. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists bitmap_not_void: tb_bitmap /= Void bitmap_exists: tb_bitmap.exists positive_bitmap_count: bitmap_count > 0 add_buttons (buttons: ARRAY [WEL_TOOL_BAR_BUTTON]) -- Add buttons. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists buttons_not_void: buttons /= Void buttons_not_empty: not buttons.is_empty ensure -- from WEL_TOOL_BAR count_increased: button_count = old button_count + buttons.count add_strings (strings: ARRAY [READABLE_STRING_GENERAL]) -- Add strings to the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists string_not_void: strings /= Void strings_not_empty: not strings.is_empty disable_redraw -- Disable redrawing of `Current' until next call to enable_redraw. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists enable_redraw -- Ensure `Current' is redrawn as required. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists get_image_list: WEL_IMAGE_LIST require exists: exists has_system_window_locked: BOOLEAN -- Is there any window locked ? -- (from WEL_WINDOW) insert_button (index: INTEGER_32; button: WEL_TOOL_BAR_BUTTON) -- Insert `button' to the left of the button -- at the zero-based `index'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists button_not_void: button /= Void button_exists: button.exists index_large_enough: index >= 0 index_small_enough: index <= button_count ensure -- from WEL_TOOL_BAR buttons_increased: button_count = old button_count + 1 lock_window_update -- Disables drawing in the current window. A locked window cannot be moved. -- Only one window can be locked at a time. To unlock a window locked with -- lock_window_update , call 'unlock_window_update'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW has_system_window_locked set_font (a_font: WEL_FONT) -- Set font with `a_font'. -- (from WEL_CONTROL) require -- from WEL_CONTROL exists: exists a_font_not_void: a_font /= Void a_font_exists: a_font.exists ensure -- from WEL_CONTROL font_set: not has_system_font implies font.item = a_font.item set_height (a_height: INTEGER_32) -- Set height with `a_height' -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_hot_image_list (an_image_list: detachable WEL_IMAGE_LIST) -- Set the hot imageList to `an_image_list'. -- -- To remove the imagelist, set `an_image_list' to Void. require exists: exists set_image_list (an_image_list: detachable WEL_IMAGE_LIST) -- Set the default imageList to `an_image_list'. -- -- To remove the imagelist, set `an_image_list' to Void. require exists: exists set_item (an_item: POINTER) -- Set item with `an_item' -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item set_parent (a_parent: detachable WEL_WINDOW) -- Change the parent of the current window. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_placement (a_placement: WEL_WINDOW_PLACEMENT) -- Set placement with `a_placement' -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists a_placement_not_void: a_placement /= Void a_placement_exists: a_placement.exists set_timer (timer_id, time_out: INTEGER_32) -- Set a timer identified by `timer_id' with a -- `time_out' value (in milliseconds). -- See also on_timer, kill_timer. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists positive_timer_id: timer_id > 0 positive_time_out: time_out > 0 set_width (a_width: INTEGER_32) -- Set width with `a_width' -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_x (a_x: INTEGER_32) -- Set x with `a_x' -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_y (a_y: INTEGER_32) -- Set y with `a_y' -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists unlock_window_update -- Unlock a locked window. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists feature -- Removal delete_button (index: INTEGER_32) -- Delete the button at the zero-based `index'. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists index_large_enough: index >= 0 index_small_enough: index < button_count ensure -- from WEL_TOOL_BAR buttons_decreased: button_count = old button_count - 1 destroy -- Destroy the window. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists ensure -- from WEL_WINDOW not_exists: not exists feature -- Resizing get_button_height: INTEGER_32 -- Get the height of the buttons. require exists: exists get_button_width: INTEGER_32 -- Get the width of the buttons. require exists: exists feature -- Duplication copy (other: attached WEL_IMAGELIST_TOOL_BAR) -- 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: Current ~ other frozen deep_copy (other: attached WEL_IMAGELIST_TOOL_BAR) -- 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: attached WEL_IMAGELIST_TOOL_BAR -- 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: attached WEL_IMAGELIST_TOOL_BAR) -- 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: attached WEL_IMAGELIST_TOOL_BAR -- 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: attached WEL_IMAGELIST_TOOL_BAR -- 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 ~ Current feature -- Basic operations frozen as_attached: attached WEL_IMAGELIST_TOOL_BAR -- Attached version of Current -- (Can be used during transitional period to convert -- non-void-safe classes to void-safe ones.) -- (from ANY) auto_size -- Resize tooolbar after changes. -- An application sends the TB_AUTOSIZE message after -- causing the size of a toolbar to change either by -- setting the button or bitmap size or by adding strings -- for the first time. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists bring_to_top -- Bring this window to the top of the Z order. -- -- Note: -- * If the window is a top-level window, it is activated. -- * If the window is a child window, the top-level parent window -- associated with the child window is activated. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists frozen default: detachable WEL_IMAGELIST_TOOL_BAR -- 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_process_notification (notification_code: INTEGER_32) -- Process a `notification_code' which has not been -- processed by process_notification. -- (from WEL_CONTROL) require -- from WEL_CONTROL exists: exists default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) disable_horizontal_scroll_bar -- Disable the horizontal scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists disable_vertical_scroll_bar -- Disable the vertical scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists frozen do_nothing -- Execute a null action. -- (from ANY) enable_horizontal_scroll_bar -- Enable the horizontal scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists enable_vertical_scroll_bar -- Enable the vertical scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists go_to_next_group_item (a_parent: WEL_COMPOSITE_WINDOW; after: BOOLEAN) -- Find the previous or following control with the -- Wm_tabstop style in the current group in `a_parent' -- depending on the value of `after'. -- (from WEL_CONTROL) require -- from WEL_CONTROL valid_parent: a_parent /= Void and then a_parent.exists go_to_next_tab_item (a_parent: WEL_COMPOSITE_WINDOW; after: BOOLEAN) -- Find the previous or following control with the -- Wm_tabstop style in `a_parent depending on the -- value of `after'. -- (from WEL_CONTROL) require -- from WEL_CONTROL valid_parent: a_parent /= Void and then a_parent.exists hide_horizontal_scroll_bar -- Hide the horizontal scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists hide_scroll_bars -- Hide the horizontal and vertical scroll bars. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists hide_vertical_scroll_bar -- Hide the vertical scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists insert_after (a_window: WEL_WINDOW) -- Insert the current window after `a_window'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists a_window_not_void: a_window /= Void a_window_not_current: a_window /= Current a_window_exists: a_window.exists invalidate -- Invalide the entire client area of the window. The -- background will be erased before. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists invalidate_rect (rect: WEL_RECT; erase_background: BOOLEAN) -- Invalidate the area `rect' and erase -- the background if `erase_background' is True. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists rect_not_void: rect /= Void rect_exists: rect.exists invalidate_region (region: WEL_REGION; erase_background: BOOLEAN) -- Invalidate the area `region' and erase -- the background if `erase_background' is True. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists region_not_void: region /= Void region_exists: region.exists invalidate_without_background -- Invalidate the entire client area of the window. The -- background will not be erased. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists kill_timer (timer_id: INTEGER_32) -- Kill the timer identified by `timer_id'. -- See also set_timer, on_timer. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists positive_timer_id: timer_id > 0 move (a_x, a_y: INTEGER_32) -- Move the window to `a_x', `a_y'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists move_and_resize (a_x, a_y, a_width, a_height: INTEGER_32; repaint: BOOLEAN) -- Move the window to `a_x', `a_y' position and -- resize it with `a_width', `a_height'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists put_command (a_command: WEL_COMMAND; message: INTEGER_32; argument: detachable ANY) -- Put `a_command' associated to `message'. -- (from WEL_WINDOW) require -- from WEL_WINDOW a_command_not_void: a_command /= Void positive_message: message >= 0 ensure -- from WEL_WINDOW command_added: command (message) = a_command and command_argument (message) = argument remove_command (message: INTEGER_32) -- Remove the command associated to `message'. -- (from WEL_WINDOW) require -- from WEL_WINDOW positive_message: message >= 0 command_exists: command_exists (message) ensure -- from WEL_WINDOW command_removed: not command_exists (message) reposition -- Reposition the bar according to the parent. -- This function needs to be called in the -- on_size function of the parent. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists resize (a_width, a_height: INTEGER_32) -- Resize the window with `a_width', `a_height'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists scroll (a_x, a_y: INTEGER_32) -- Scroll the contents of the window's client area. -- `a_x' and `a_y' specify the amount of horizontal -- and vertical scrolling. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists set_class_icon (new_icon: WEL_ICON) -- Replace the current icon for the class which this window -- belongs to. -- -- The SetClassLong function replaces the specified 32-bit (long) -- value at the specified offset into the extra class memory -- or the WNDCLASSEX structure for the class to which the -- specified window belongs. -- (from WEL_WINDOW) require -- from WEL_WINDOW new_icon_not_void: new_icon /= Void new_icon_exists: new_icon.exists set_class_small_icon (new_icon: WEL_ICON) -- Replace the current icon for the class which this window -- belongs to. -- -- The SetClassLong function replaces the specified 32-bit (long) -- value at the specified offset into the extra class memory -- or the WNDCLASSEX structure for the class to which the -- specified window belongs. -- (from WEL_WINDOW) require -- from WEL_WINDOW new_icon_not_void: new_icon /= Void new_icon_exists: new_icon.exists set_z_order (z_order: POINTER) -- Set the z-order of the window. -- See class WEL_HWND_CONSTANTS for `z_order' values. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists valid_hwnd_constant: valid_hwnd_constant (z_order) show_horizontal_scroll_bar -- Show the horizontal scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists show_scroll_bars -- Show the horizontal and vertical scroll bars. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists show_vertical_scroll_bar -- Show the vertical scroll bar. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists show_with_option (cmd_show: INTEGER_32) -- Set the window's visibility with `cmd_show'. -- See class WEL_SW_CONSTANTS for `cmd_show' value. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists parent_shown: attached parent as l_parent implies l_parent.exists and l_parent.shown update -- Update the client area by sending a Wm_paint message. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists validate -- Validate the entire client area of the window. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists validate_rect (rect: WEL_RECT) -- Validate the area `rect'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists rect_not_void: rect /= Void rect_exists: rect.exists validate_region (region: WEL_REGION) -- Validate the area `region'. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists region_not_void: region /= Void region_exists: region.exists win_help (help_file: READABLE_STRING_GENERAL; a_command, data: INTEGER_32) -- Start the Windows Help program with `help_file'. -- `a_command' specifies the type of help requested. See -- class WEL_HELP_CONSTANTS for `a_command' values. -- 'data' is depandant on 'a_command'. Check MSDN for more details. -- (from WEL_WINDOW) require -- from WEL_WINDOW exists: exists help_file_not_void: help_file /= Void feature -- Element Change set_default_processing (value: BOOLEAN) -- Enable or disable default processing of window messages. -- (from WEL_RETURN_VALUE) ensure -- from WEL_RETURN_VALUE value_set: default_processing = value set_message_return_value (value: POINTER) -- Set the window-procedure-return-value. -- (from WEL_RETURN_VALUE) ensure -- from WEL_RETURN_VALUE has_return_value: has_return_value value_set: message_return_value = value feature -- Notifications on_tbn_beginadjust -- The user has begun customizing the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists on_tbn_begindrag (info: WEL_NM_TOOL_BAR) -- The user has begun dragging a button in the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists info_not_void: info /= Void info_exists: info.exists on_tbn_custhelp -- The user has chosen the Help button in the -- customize toolbar dialog box. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists on_tbn_dropdown (info: WEL_NM_TOOL_BAR) -- The user clicks a button that use the -- Tbstyle_dropdown style. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists info_not_void: info /= Void info_exists: info.exists on_tbn_endadjust -- The user has stopped customizing the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists on_tbn_enddrag (info: WEL_NM_TOOL_BAR) -- The user has stopped dragging a button in the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists info_not_void: info /= Void info_exists: info.exists on_tbn_getbuttoninfo (info: WEL_NM_TOOL_BAR) -- Retrieves toolbar customization. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists info_not_void: info /= Void info_exists: info.exists on_tbn_querydelete (info: WEL_NM_TOOL_BAR) -- A button may be deleted from the toolbar while -- the user is customizing the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists info_not_void: info /= Void info_exists: info.exists on_tbn_queryinsert (info: WEL_NM_TOOL_BAR) -- A button may be inserted to the left of the -- specified button while the user is customizing -- the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists info_not_void: info /= Void info_exists: info.exists on_tbn_reset -- The user has reset the content of the customise -- toolbar dialog box. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists on_tbn_toolbarchange -- The user has customized the toolbar. -- (from WEL_TOOL_BAR) require -- from WEL_TOOL_BAR exists: exists feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY 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) 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 operating_environment_not_void: Result /= Void feature -- Registration is_registered: BOOLEAN -- Is `window' registered? -- (from WEL_WINDOW) frozen register_current_window -- Register `Current' in window manager. -- (from WEL_WINDOW) ensure -- from WEL_WINDOW registered: is_registered 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_IMAGELIST_TOOL_BAR -- Generated by Eiffel Studio --
For more details: docs.eiffel.com