++ed by:
KEEDI AERO XLAT

3 PAUSE users
3 non-PAUSE users.

kmx
and 1 contributors

NAME

Win32::GUI::TabStrip - Create and manipulate tab strip controls

DESCRIPTION

[TBD]

METHODS

Common methods apply to most windows, controls and resources.

new

new(PARENT, %OPTIONS)

Creates a new TabStrip object; can also be called as PARENT->AddTabStrip(%OPTIONS).

Class specific %OPTIONS are:

  -alignright=> 0/1 (default 0)
  -bottom    => 0/1 (default 0)
  -buttons   => 0/1 (default 0)
    if enabled items look like push buttons
  -hottrack  => 0/1 (default 0)
  -imagelist => Win32::GUI::ImageList object
  -justify   => 0/1 (default 0)
  -forceiconleft => 0/1 (default 0)
  -forcelabelleft => 0/1 (default 0)
  -fixedwidth => 0/1 (default 0)
  -focusbottondown => 0/1 (default 0)
  -focusnever => 0/1 (default 0)
  -flat      => 0/1 (default 0)
  -flatseparator => 0/1 (default 0)
  -raggedright => 0/1 (default 0)
  -multiline => 0/1 (default 0)
    The control can have more than one line
  -multiselect => 0/1 (default 0)
  -vertical  => 0/1 (default 0)
  -tooltip => Win32::GUI::Tooltip object

See also the common options.

AdjustRect

AdjustRect(LEFT, TOP, RIGHT, BOTTOM, [FLAG=0])

Calculates a tab control's display area given a window rectangle, or calculates the window rectangle that would correspond to a specified display area. If FLAG is 0, rect specifies a window rectangle and receives the corresponding display area. Otherwise, rect specifies a display rectangle and receives the corresponding window rectangle.

ChangeItem

ChangeItem(ITEM, %OPTIONS)

Change most of the options used when the item was created (see InsertItem()). Allowed %OPTIONS are:

    -image
    -text

Count

Count()

Returns the number of items in the TabStrip.

DeleteAllItems

DeleteAllItems()

See Reset()

DeleteItem

DeleteItem(ITEM)

Removes the specified ITEM from the TabStrip.

DeselectAll

DeselectAll([ExcludeFocus=0])

Resets items in a tab control, clearing any that were set to the TCIS_BUTTONPRESSED state. If ExcludeFocus is set to 0, all tab items will be reset. Otherwise, all but the currently selected tab item will be reset.

DisplayArea

DisplayArea()

Retrieve position en size of Display Area. Return an array (x, y, width, heigth)

GetCurFocus

GetCurFocus()

Returns the index of the item that has the focus in a tab control

GetCurSel

GetCurSel()

See SelectedItem()

GetExtendedStyle

GetExtendedStyle()

Retrieves the extended styles that are currently in use for TabStrip.

GetImageList

GetImageList()

Retrieves the image list handle associated with a tab control.

GetItem

GetItem(ITEM)

Retrieves information about an ITEM in the TabStrip.

GetItemCount

GetItemCount()

See Count()

GetItemRect

GetItemRect(index)

Retrieves the bounding rectangle for a tab in a tab control

GetRowCount

GetRowCount()

See RowCount()

GetString

GetString(ITEM)

Returns the string associated with the specified ITEM in the TabStrip.

GetToolTips

GetToolTips()

Retrieves the handle to the tooltip control associated with a tab control.

GetUnicodeFormat

GetUnicodeFormat()

Retrieves the UNICODE character format flag.

HighlightItem

HighlightItem(index, [fHighlight=1])

Sets the highlight state of a tab item. If fHighlight is nonzero, the tab is highlighted. If fHighlight is zero, the tab is set to its default state.

HitTest

HitTest(X,Y)

Determines which tab, if any, is at a specified screen position.

InsertItem

InsertItem(%OPTIONS)

Adds an item to the TabStrip. Allowed %OPTIONS are:

 -image => NUMBER
   the index of an image from the associated ImageList
 -index => NUMBER
   the position for the new item (if not specified, the item
   is added at the end of the control)
 -text  => STRING
   the text that will appear on the item

MinTabWidth

MinTabWidth(WIDTH)

Sets the minimum width of items in a tab control.

Padding

Padding(X,Y)

Sets the amount of space (padding) around each tab's icon and label in a tab control.

RemoveImage

RemoveImage(iImage)

Removes an image from a tab control's image list. The tab control updates each tab's image index, so each tab remains associated with the same image as before. If a tab is using the image being removed, the tab will be set to have no image.

Reset

Reset()

Deletes all items from the TabStrip.

RowCount

RowCount()

Retrieves the current number of rows of tabs in a tab control.

Select

Select(INDEX)

Selects a tab in a tab control. Returns the index of the previously selected tab if successful, or -1 otherwise.

SelectedItem

SelectedItem()

Returns the zero-based index of the currently selected item.

SetCurFocus

SetCurFocus(index)

Sets the focus to a specified tab in a tab control. Returns the index of the previously selected tab if successful, or -1 otherwise.

SetCurSel

SetCurSel(INDEX)

See Select()

SetExtendedStyle

SetExtendedStyle(STYLE)

Sets the extended styles that the TabStrip will use.

SetImageList

SetImageList(IMAGELIST)

Assigns an image list to a tab control. Return previous imagelist

SetItem

SetItem(ITEM, %OPTIONS)

See ChangeItem()

SetItemSize

SetItemSize(STYLE)

Sets the width and height of tabs in a fixed-width.

SetMinTabWidth

SetMinTabWidth(WIDTH)

See MinTabWidth()

SetPadding

SetPadding(X,Y)

See Padding()

SetToolTips

SetToolTips(TOOLTIP)

Assigns a tooltip to a TabStrip.

SetUnicodeFormat

SetUnicodeFormat(FLAG)

Set the UNICODE character format flag.

EVENTS

Common events apply to most windows and controls.

Change

Change()

Sent when the current selection has changed. Use SelectedItem() to determine the current selection.

Changing

Changing()

Sent before the current selection changes. Use SelectedItem() to determine the current selection. The event should return 0 to prevent the selection changing, 1 to allow it.

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.