INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "Visual Eiffel Library.", "Win32 API: Image List Functions"
project: "Visual Eiffel Win32 Library"
revision: "$Revision: 1.2 $"
copyright: "Copyright (C) 1996-2005 Object Tools Group"
license: "http://visual-eiffel.com/license"
cluster: winlib
class WAPI_IMAGE_LIST_FUNCTIONS
inherit

WAPI_ERROR_SERVER
end
feature -- Access

ImageList_Add (himl, hbmimage, hbmmask: INTEGER): INTEGER
-- The `ImageList_Add' function adds an image or images to an image list.
require
correct_himl: himl /= null_
correct_hbmimage: hbmimage /= null_

frozen ImageList_AddIcon (himl, hicon: INTEGER): INTEGER
-- The `ImageList_AddIcon' macro adds an icon or cursor to an image list.
-- `ImageList_AddIcon' calls the `ImageList_ReplaceIcon' function.

ImageList_AddMasked (himl, hbmimage, crmask: INTEGER): INTEGER
-- The `ImageList_AddMasked' function adds an image or images
-- to an image list, generating a mask from the specified bitmap.
require
correct_himl: himl /= null_
correct_hbmimage: hbmimage /= null_

ImageList_Create (cx, cy: INTEGER; flags: BIT 32; cinitial, cgrow: INTEGER): INTEGER
-- The `ImageList_Create' function creates a new image list.
require
correct_cx: cx >= 0
correct_cy: cy >= 0
correct_cinitial: cinitial >= 0
correct_cgrow: cgrow >= 0

ImageList_Destroy (himl: INTEGER)
-- The `ImageList_Destroy' function destroys an image list.
require
correct_himl: himl /= null_

ImageList_Draw (himl, i, hdcdst, x, y: INTEGER; fstyle: BIT 32)
-- The `ImageList_Draw' function draws an image list item in the
-- specified device context.
require
correct_himl: himl /= null_
correct_i: i >= 0
correct_hdcdst: hdcdst /= null_

ImageList_DrawEx (himl, i, hdcdst, x, y, dx, dy, rgbbk, rgbfg: INTEGER; fstyle: BIT 32)
-- The `ImageList_DrawEx' function draws an image list item in the
-- specified device context. The function uses the specified drawing
-- style and blends the image with the specified color.
require
correct_himl: himl /= null_
correct_i: i >= 0
correct_hdcdst: hdcdst /= null_

frozen ImageList_ExtractIcon (hi, himl, i: INTEGER): INTEGER
-- The `ImageList_ExtractIcon' function creates an icon or cursor
-- based on an image and mask in an image list.
-- `ImageList_ExtractIcon' is a macro that calls the
-- `ImageList_GetIcon' function.

ImageList_GetBkColor (himl: INTEGER): INTEGER
-- The `ImageList_GetBkColor' function retrieves the current
-- background color for an image list.
require
correct_himl: himl /= null_

ImageList_GetIcon (himl, i: INTEGER; flags: BIT 32): INTEGER
-- The `ImageList_GetIcon' function creates an icon or cursor based
-- on an image and mask in an image list.
require
correct_himl: himl /= null_
correct_i: i >= 0

ImageList_GetIconSize (himl: INTEGER; cx, cy: POINTER)
-- The `ImageList_GetIconSize' function retrieves the dimensions
-- of images in an image list.
-- All images in an image list have the same dimensions.
require
correct_himl: himl /= null_
correct_cx: cx /= default_pointer
correct_cy: cy /= default_pointer

ImageList_GetImageCount (himl: INTEGER): INTEGER
-- The `ImageList_GetImageCount' function retrieves the number
-- of images in an image list.
require
correct_himl: himl /= null_

ImageList_GetImageInfo (himl, i: INTEGER; pimageinfo: POINTER): BOOLEAN
-- The `ImageList_GetImageInfo' function retrieves information
-- about an image.
require
correct_himl: himl /= null_
correct_i: i >= 0
correct_pimageinfo: pimageinfo /= default_pointer

ImageList_LoadImage (hi: INTEGER; lpbmp: POINTER; cx, cgrow, crmask: INTEGER; utype: INTEGER; uflags: BIT 32): INTEGER
-- The `ImageList_LoadImage' function creates an image list from
-- the specified bitmap, cursor, or icon resource.

ImageList_Merge (himl1, i1, himl2, i2, dx, dy: INTEGER): INTEGER
-- The `ImageList_Merge' function creates a new image by combining
-- two existing images.
-- The function also creates a new image list to store the image.
require
correct_himl1: himl1 /= null_
correct_himl2: himl2 /= null_
correct_i1: i1 >= 0
correct_i2: i2 >= 0

ImageList_Remove (himl, i: INTEGER): BOOLEAN
-- The `ImageList_Remove' function removes an image from an image list.
require
correct_himl: himl /= null_
correct_i: i >= 0

frozen ImageList_RemoveAll (himl: INTEGER): BOOLEAN

ImageList_Replace (himl, i, hbmimage, hbmmask: INTEGER): BOOLEAN
-- The `ImageList_Replace' function replaces an image
-- in an image list with a new image.
require
correct_himl: himl /= null_
correct_i: i >= 0
correct_hbmimage: hbmimage /= null_

ImageList_ReplaceIcon (himl, i, hicon: INTEGER): INTEGER
-- The `ImageList_ReplaceIcon' function replaces an image with
-- an icon or cursor.
require
correct_himl: himl /= null_
correct_i: i >= 0
correct_hicon: hicon /= null_

ImageList_SetBkColor (himl, clrbk: INTEGER): INTEGER
-- The `ImageList_SetBkColor' function sets the background color
-- for an image list.
require
correct_himl: himl /= null_

ImageList_SetIconSize (himl, cx, cy: INTEGER): BOOLEAN
-- The `ImageList_SetIconSize' function sets the dimensions of images
-- in an image list and removes all images from the list.
require
correct_himl: himl /= null_

ImageList_SetOverlayImage (himl, iimage, ioverlay: INTEGER)
-- The `ImageList_SetOverlayImage' function adds the index
-- of an image to the list of images to be used as overlay masks.
-- Up to four indices can be added to the list.
require
correct_himl: himl /= null_
feature -- Image lists Drag'n'Drop

ImageList_BeginDrag (himl, itrack, dxhotspot, dyhotspot: INTEGER)
-- The `ImageList_BeginDrag' function begins dragging an image.
require
valid_himl: himl /= null_

ImageList_DragEnter (hwndlock, x, y: INTEGER)
-- The `ImageList_DragEnter' function locks updates to the specified
-- window during a drag operation and displays the drag image at the
-- specified position within the window.

ImageList_DragLeave (hwndlock: INTEGER)
-- The `ImageList_DragLeave' function unlocks the specified window
-- and hides the drag image, allowing the window to be updated.

ImageList_DragMove (x, y: INTEGER)
-- The `ImageList_DragMove' function moves the image that is being
-- dragged during a drag-and-drop operation. This function is
-- typically called in response to a `WM_MOUSEMOVE' message.

ImageList_DragShowNolock (fshow: BOOLEAN)
-- The `ImageList_DragShowNolock' function shows or hides the image
-- being dragged.

ImageList_EndDrag
-- The `ImageList_EndDrag' function ends a drag operation.

ImageList_SetDragCursorImage (himl, idrag, dxhotspot, dyhotspot: INTEGER)
-- The `ImageList_SetDragCursorImage' function creates
-- a new drag image by combining the specified image
-- (typically a mouse cursor image) with the current drag image.
require
correct_himl: himl /= null_
end -- class WAPI_IMAGE_LIST_FUNCTIONS

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES