/ 
Win32-GUI-1.14
River stage one • 9 direct dependents • 9 total dependents
/ Win32::GUI::StatusBar

NAME

Win32::GUI::StatusBar - Create and manipulate status bar controls

DESCRIPTION

[TBD]

METHODS

Common methods apply to most windows, controls and resources.

new

new(PARENT, %OPTIONS)

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

Class specific %OPTIONS are:

-sizegrip   => 0/1 (default 0)
    Set/Unset size grip style.

See also the common options.

GetBorders

GetBorders()

Gets the border values for the status bar. Returns an array containing width of the horizontal border, width of the vertical border, and the width of the border between parts.

GetIcon

GetIcon(PART)

Retrieves the icon for a part in a status bar.

GetParts

GetParts()

Retrieves a count of the parts in a status window. In Array context, return an list of coordinates for the current parts. A value of -1 in the final coordinate means the last part will expand rightwards to fill the statusbar.

GetRect

GetRect(part)

Gets the bounding rectangle for the given part of the status bar. Returns left, top, right, bottom co-ordinates, or undef on failure. This is useful for drawing in the status bar.

GetText

GetText(part)

Retrieves the text from the specified part of a status window. In array context, return an array (TEXT,STYLE)

GetTextLength

GetTextLength(part)

Retrieves the text from the specified part of a status window. In array context, return an array (LENGTH,STYLE)

GetTipText

GetTipText(part)

Retrieves the tooltip text for a part in a status bar.

GetUnicodeFormat

GetUnicodeFormat()

Retrieves the UNICODE character format flag for the control.

Icon

Icon(part,[icon])

See SetIcon()

IsSimple

IsSimple()

Checks a status bar control to determine if it is in simple mode.

Parts

Parts([x1, x2, x3...])

Divides the statusbar into sections. The list of co-ordinates define the right-hand edge of each part.

This method will return a list of co-ordinates for the current parts. A value of -1 in the final co-ordinate means the last part will expand rightwards to fill the statusbar.

PartText

PartText(part,[string,[flags]])

Sets or gets the text in a particular part of the status bar.

Flags are as follows:

0
     The text is drawn with a border to appear lower than the plane of
     the window.

SBT_NOBORDERS = 256
     The text is drawn without borders.

SBT_POPOUT = 512
     The text is drawn with a border to appear higher than the plane of
     the window.

SBT_RTLREADING = 1024
     The text will be displayed in the opposite direction to the text
     in the parent window.

SBT_OWNERDRAW = 4096
     The text is drawn by the parent window.

When called with no string or flags, in scalar context the method will return the text string in the specified part of the status bar. In array context, the method will return the text string and the style flags of the text in the specified part.

SetBkColor

SetBkColor([color])

Sets the background color of the status bar. If no color is given, it sets the background color to the default background color.

SetIcon

SetIcon(part,[icon])

Sets or unsets the icon for a particular part of the status bar. If icon is set to 0 or less, the icon for the specified part of the status bar is removed. icon should be a Win32::GUI::Icon object.

SetMinHeight

SetMinHeight(height)

Sets the minimum height of a status window's drawing area, and redraws the status bar.

The minimum height produced will be: height + (2 * vertical border width)

SetParts

SetParts(x1,[x2, x3...])

Sets the number of parts in a status window and the coordinate of the right edge of each part.

SetText

SetText(part,text,[type=0])

Sets the text in the specified part of a status window. Type of drawing operation :

0 = The text is drawn with a border to appear lower than the plane of the window.
SBT_NOBORDERS = The text is drawn without borders.
SBT_OWNERDRAW = The text is drawn by the parent window.
SBT_POPOUT = The text is drawn with a border to appear higher than the plane of the window.
SBT_RTLREADING = Displays text using right-to-left reading order on Hebrew or Arabic systems.

SetTipText

SetTipText(part,string)

Sets the tooltip text for a particular part of the status bar.

From SDK documentation: This ToolTip text is displayed in two situations: When the corresponding pane in the status bar contains only an icon. When the corresponding pane in the status bar contains text that is truncated due to the size of the pane.

SetUnicodeFormat

SetUnicodeFormat()

Sets the UNICODE character format flag for the control.

Simple

Simple([simplemode])

If simplemode is not 0, turns simple mode on. Otherwise, turns simple mode off. Simple mode means the statusbar just shows text, with only one partition.

Returns the status of simple mode (0 = off, non-zero = on)

Tip

Tip(part,string)

See SetTipText()

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.