=head1 NAME Win32::GUI::Header - Create and manipulate list header controls =head1 DESCRIPTION [TBD] =for comment $Id: per_package_method_section.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head1 METHODS L apply to most windows, controls and resources. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 new B Creates a new Header object; can also be called as PARENT->AddHeader(%OPTIONS). Class specific B<%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 L. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 ChangeItem B Changes the options for an item in the Header control. Returns nonzero if successful, zero otherwise. For a list of the available options see L. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 Clear B Deletes all items from the control. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 Count B See L =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 CreateDragImage B Creates a transparent version of an item image within an existing Header. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 DeleteItem B Deletes the zero-based B item from the Header. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 GetImageList B Retrieves the handle to the image list that has been set for an existing header control. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 GetItem B Retrieves information about an item in a Header control. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 GetItemCount B Returns the number of items in the Header control. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 GetItemRect B Returns a four element array defining the rectangle of the specified zero-based B item; the array contains (left, top, right, bottom). If not succesful returns undef. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 GetOrderArray B Returns an array defining left-to-right of items. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 GetUnicodeFormat B Retrieves the UNICODE character format flag for the control. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 HitTest B 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. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 InsertItem B 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 =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 ItemRect B See L =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 OrderToIndex B Retrieves an index value for an item based on its order in the Header. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 Reset B See L. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 SetImageList B Assigns an image list to an Header. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 SetItem B Set the options for an item in the Header control. Returns nonzero if successful, zero otherwise. For a list of the available options see L. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 SetOrderArray B Sets the left-to-right order of Header items. =for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 SetUnicodeFormat B Sets the UNICODE character format flag for the control. =for comment $Id: per_package_event_section.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head1 EVENTS L apply to most windows and controls. =for comment $Id: per_package_event.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 BeginTrack B 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. =for comment $Id: per_package_event.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 DividerDblClick B Sent when the user double-clicked on a divider of the Header control. =for comment $Id: per_package_event.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 EndTrack B 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. =for comment $Id: per_package_event.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 ItemClick B Sent when the user clicked on a Header item. =for comment $Id: per_package_event.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 ItemDblClick B Sent when the user double-clicked on a Header item. =for comment $Id: per_package_event.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $ =head2 Track B 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. =for comment $Id: pod_postamble.tpl,v 1.2 2005/08/03 21:45:59 robertemay Exp $ =head1 VERSION Documentation for Win32::GUI v1.06 created 14 Feb 2008 This document is autogenerated by the build process. Edits made here will be lost. Edit F instead. =head1 SUPPORT Homepage: L. For further support join the users mailing list(C) from the website at L. There is a searchable list archive at L. =head1 COPYRIGHT and LICENCE Copyright (c) 1997..2008 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.