Win32::GUI::Header - Create and manipulate list header controls
[TBD]
Common methods apply to most windows, controls and resources.
new(PARENT, %OPTIONS)
Creates a new Header object; can also be called as PARENT->AddHeader(%OPTIONS).
Class specific %OPTIONS are:
-buttons => 0/1 (default 0) Set/Unset buttons style. Header items look like push buttons and can be clicked. -dragdrop => 0/1 (default 0) Set/Unset dragdrop style. -fulldrag => 0/1 (default 0) Set/Unset fulldrag style. -hidden => 0/1 (default 0) Set/Unset hidden style. -horizontal => 0/1 (default 0) Set/Unset horizontal style. -hottrack => 0/1 (default 0) Set/Unset hottrack style. -hottrack => 0/1 (default 0) Set/Unset hottrack style. -imagelist => Win32::GUI::ImageList object. Set imagelist.
See also the common options.
ChangeItem(INDEX, %OPTIONS)
Changes the options for an item in the Header control. Returns nonzero if successful, zero otherwise. For a list of the available options see InsertItem().
Clear()
Deletes all items from the control.
Count()
See GetItemCount()
CreateDragImage(INDEX)
Creates a transparent version of an item image within an existing Header.
DeleteItem(INDEX)
Deletes the zero-based INDEX item from the Header.
GetImageList()
Retrieves the handle to the image list that has been set for an existing header control.
GetItem(INDEX)
Retrieves information about an item in a Header control.
GetItemCount()
Returns the number of items in the Header control.
GetItemRect(INDEX)
Returns a four element array defining the rectangle of the specified zero-based INDEX item; the array contains (left, top, right, bottom). If not succesful returns undef.
GetOrderArray()
Returns an array defining left-to-right of items.
GetUnicodeFormat()
Retrieves the UNICODE character format flag for the control.
HitTest(X, Y)
Checks if the specified point is on an Header item; it returns the index of the found item or -1 if none was found. If called in an array context, it returns an additional value containing more info about the position of the specified point.
InsertItem(%OPTIONS)
Inserts a new item in the Header control. Returns the newly created item zero-based index or -1 on errors. %OPTIONS can be:
-index => position -image => index of an image from the associated ImageList -bitmap => Win32::GUI::Bitmap object -width => pixels -height => pixels -text => string -align => left|center|right
ItemRect(INDEX)
See GetItemRect()
OrderToIndex()
Retrieves an index value for an item based on its order in the Header.
Reset()
See Clear().
SetImageList(flag)
Assigns an image list to an Header.
SetItem(INDEX, %OPTIONS)
Set the options for an item in the Header control. Returns nonzero if successful, zero otherwise. For a list of the available options see InsertItem().
SetOrderArray(...)
Sets the left-to-right order of Header items.
SetUnicodeFormat(flag)
Sets the UNICODE character format flag for the control.
Common events apply to most windows and controls.
BeginTrack(INDEX, WIDTH)
Sent when a divider of the Header control is being moved; the event must return 0 to prevent moving the divider, 1 to allow it. Passes the zero-based INDEX of the item being resized and its current WIDTH.
DividerDblClick(INDEX)
Sent when the user double-clicked on a divider of the Header control.
EndTrack(INDEX, WIDTH)
Sent when a divider of the Header control has been moved. Passes the zero-based INDEX of the item being resized and its current WIDTH.
ItemClick(INDEX)
Sent when the user clicked on a Header item.
ItemDblClick(INDEX)
Sent when the user double-clicked on a Header item.
Track(INDEX, WIDTH)
Sent while a divider of the Header control is being moved; the event must return 1 to continue moving the divider, 0 to end its movement. Passes the zero-based INDEX of the item being resized and its current WIDTH.
Documentation for Win32::GUI v1.12 created 03 Jun 2015
This document is autogenerated by the build process. Edits made here will be lost. Edit docs/per_package.tpl instead.
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 (c) 1997..2015 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.
To install Win32::GUI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Win32::GUI
CPAN shell
perl -MCPAN -e shell install Win32::GUI
For more information on module installation, please visit the detailed CPAN module installation guide.