NAME
Win32::GUI::ImageList - Create and manipulate imagelist resources
DESCRIPTION
[TBD]
METHODS
Common methods apply to most windows, controls and resources.
new
new(X, Y, FLAGS, INITAL, GROW)
Creates an ImageList object; X and Y specify the size of the images, FLAGS [TBD]. INITIAL and GROW specify the number of images the ImageList actually contains (INITIAL) and the number of images for which memory is allocated (GROW).
See also the common options.
newFromImage
newFromImage(IMAGE,CX,[FLAG=LR_LOADFROMFILE],[TYPE=IMAGE_BITMAP],[COLORMASK=CLR_DEFAULT],[HINSTANCE=NULL],[GROW=1])
See LoadImage()
Add
Add(BITMAP, [BITMAPMASK])
Adds a bitmap to the ImageList; both BITMAP and BITMAPMASK can be either Win32::GUI::Bitmap objects or filenames.
AddBitmap
AddBitmap(BITMAP, [BITMAPMASK])
Adds a Win32::GUI::Bitmap object to the ImageList. BITMAPMASK is optional. See also Add().
AddBitmapMasked
AddBitmapMasked(BITMAP, COLORMASK)
Adds a Win32::GUI::Bitmap object to the ImageList. COLORMASK is color used to generate the mask. See also AddMasked().
AddIcon
AddIcon(ICON)
Add a icon specified by ICON (must be a Win32::GUI::Icon object).
AddMasked
AddMasked(BITMAP, COLORMASK)
Adds a bitmap to the ImageList; BITMAP can be either Win32::GUI::Bitmap object or filename.
BackColor
BackColor([COLOR])
Gets or sets the background color for the ImageList.
BeginDrag
BeginDrag(INDEX, X, Y)
Creates a temporary image list that is used for dragging.
Clear
Clear()
Removes all the images from the ImageList.
Count
Count()
Returns the number of images in the ImageList.
Create
Create(X, Y, FLAGS, INITAL, GROW)
Creates a new image list. See new()
Destroy
Destroy()
Destroys an image list.
DragEnter
DragEnter(WINDOW, X, Y)
Locks updates to the specified window during a drag operation and displays the drag image at the specified position within the window.
Class method : Win32::GUI::ImageList::DragEnter($window, $x, $y)
DragLeave
DragLeave(WINDOW)
Unlocks the specified window and hides the drag image, allowing the window to be updated.
Class method : Win32::GUI::ImageList::DragLeave($window)
DragMove
DragMove(X, Y)
Locks updates to the specified window during a drag operation and displays the drag image at the specified position within the window.
Class method : Win32::GUI::ImageList::DragMove($x, $y)
DragShowNolock
DragShowNolock(FLAG)
Shows or hides the image being dragged.
Class method : Win32::GUI::ImageList::DragShowNolock($flag)
Draw
Draw(INDEX, DC, X, Y, [STYLE=ILD_NORMAL])
Draws an image list item in the specified device context.
DrawEx
DrawEx(INDEX, DC, X, Y, DX, DY, BKCOLOR, FGCOLOR, [STYLE=ILD_NORMAL])
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.
DrawIndirect
DrawIndirect(INDEX, DC, X, Y, CX, CY, XBITMAP, YBITMAP, BKCOLOR, FGCOLOR, [STYLE=ILD_NORMAL], [ROP=SRCCOPY])
Draws an image list item in the specified device context.
Duplicate
Duplicate()
Creates a duplicate of an existing image list. Return a new Win32::GUI::ImageList object.
EndDrag
EndDrag()
Ends a drag operation.
Class method : Win32::GUI::ImageList::EndDrag()
GetBkColor
GetBkColor()
Retrieves the current background color for an image list.
GetDragImage
GetDragImage()
Retrieves the temporary image list that is used for the drag image.
Class method : Win32::GUI::ImageList::GetDragImage()
GetIcon
GetIcon(index, [flags=ILD_NORMAL])
Creates an Win32::GUI::Icon object from an image and mask in an image list.
GetIconSize
GetIconSize()
Retrieves the dimensions of images in an image list. All images in an image list have the same dimensions.
GetImageCount
GetImageCount()
See Count()
LoadImage
LoadImage(IMAGE,CX,[FLAG=LR_LOADFROMFILE],[TYPE=IMAGE_BITMAP],[COLORMASK=CLR_DEFAULT],[HINSTANCE=NULL],[GROW=1])
Return a new Win32::GUI::ImageList object.
Merge
Merge(INDEX1,INDEX2, DX,DY,[IMAGELIST=SELF])
Creates a new image by combining two existing images. The function also creates a new image list in which to store the image. Return a new Win32::GUI::ImageList object.
Remove
Remove(INDEX)
Removes the specified zero-based INDEX image from the ImageList.
RemoveAll
RemoveAll()
See Clear()
Replace
Replace(INDEX, BITMAP, [BITMAPMASK])
Replaces the specified zero-based INDEX image with the image specified by BITMAP (must be a Win32::GUI::Bitmap object). BITMAPMASK is optional.
ReplaceIcon
ReplaceIcon(INDEX, ICON)
Replaces the specified zero-based INDEX image with the icon specified by ICON (must be a Win32::GUI::Icon object).
SetBkColor
SetBkColor(COLOR)
Sets the background color for an image list.
SetDragCursorImage
SetDragCursorImage(INDEX, X, Y)
Creates a new drag image by combining the specified image (typically a mouse cursor image) with the current drag image.
SetIconSize
SetIconSize(CX, CY)
Sets the dimensions of images in an image list and removes all images from the list.
SetImageCount
SetImageCount(COUNT)
Resizes an existing image list.
SetOverlayImage
SetOverlayImage(INDEX, OVERLAY)
Adds a specified image to the list of images to be used as overlay masks.
Size
Size([X, Y])
Gets or sets the size of the images in the ImageList; if no parameter is given, returns a 2 element array (X, Y), otherwise sets the size to the given parameters. If X and Y is given, also removes all images from the list.
EVENTS
Common events apply to most windows and controls.
VERSION
Documentation for Win32::GUI v1.14 created 01 Jun 2017
This document is autogenerated by the build process. Edits made here will be lost. Edit docs/per_package.tpl instead.
SUPPORT
Homepage: http://perl-win32-gui.sourceforge.net/.
For further support join the users mailing list from the website at http://lists.sourceforge.net/lists/listinfo/perl-win32-gui-users. There is a searchable list archive at http://sourceforge.net/p/perl-win32-gui/mailman/perl-win32-gui-users/.
COPYRIGHT and LICENCE
Copyright (c) 1997..2017 Aldo Calpini. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.