
=head1 NAME

Win32::GUI::Tooltip - Create and manipulate Tooltip controls

=head1 DESCRIPTION

[TBD]

=for comment $Id: per_package_method_section.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head1 METHODS

L<Common methods|Win32::GUI::Reference::Methods> apply to most windows, controls and resources.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 new

B<new(PARENT, %OPTIONS)>

Creates a new Tooltip object

Class specific B<%OPTIONS> are:

  -alwaystip => 0/1
  -noprefix => 0/1

See also the L<common options|Win32::GUI::Reference::Options>.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Activate

B<Activate([FLAG=TRUE])>

Activates or deactivates a tooltip control.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Add

B<Add(@OPTIONS)>

See L<AddTool()|Win32::GUI::Tooltip/AddTool>

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 AddTool

B<AddTool(@OPTIONS)>

Registers a tool with a Tooltip.

B<@OPTIONS>:

 -text   => STRING
   Tool text
 -needtext => 0/1
    Use NeedText Event.
 -window => HANDLE
    Window handle for the tool.
 -id => ID
    ID for the tool.
 -flags  => FLAGS
    Set of bit flags
    -absolute => 0/1
    -centertip => 0/1
    -idishwnd => 0/1
    -rtlreading => 0/1
    -subclass => 0/1
    -track => 0/1
    -transparent => 0/1
 -rect => [LEFT,TOP,RIGHT,BOTTOM]
    Aera of the tool

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Count

B<Count()>

Returns the number of tools in the Tooltip.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Del

B<Del(ID)>

See L<DelTool()|Win32::GUI::Tooltip/DelTool>

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 DelTool

B<DelTool(ID)>

Removes a tool from a Tooltip.

B<ID> is Tool ID (a number or a window handle).

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 EnumTools

B<EnumTools(ID)>

Retrieves the information for the tool in a tooltip control.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetCurrentTool

B<GetCurrentTool()>

Retrieves the information for the current tool in a tooltip control.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetDelayTime

B<GetDelayTime([FLAG=TTDT_INITIAL])>

Retrieves the initial, pop-up, and reshow durations currently set for a tooltip control.

B<FLAG> :

  TTDT_RESHOW  = 1 : Length of time it takes for subsequent tooltip windows to appear
                     as the pointer moves from one tool to another.
  TTDT_AUTOPOP = 2 : Length of time the tooltip window remains visible if the pointer is
                     stationary within a tool's bounding rectangle.
  TTDT_INITIAL = 3 : Length of time the pointer must remain stationary within a tool's
                     bounding rectangle before the tooltip window appears.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetMargin

B<GetMargin()>

Retrieves the top, left, bottom, and right margins set for a tooltip window.
A margin is the distance, in pixels, between the tooltip window border and
the text contained within the tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetMaxTipWidth

B<GetMaxTipWidth()>

Retrieves the maximum width for a tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetText

B<GetText(ID)>

Retrieves the information a tooltip control maintains about a tool.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetTipBkColor

B<GetTipBkColor()>

Retrieves the background color in a tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetTipTextColor

B<GetTipTextColor()>

Retrieves the text color in a tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetToolCount

B<GetToolCount()>

See L<Count()|Win32::GUI::Tooltip/Count>

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 GetToolInfo

B<GetToolInfo(ID)>

Retrieves the information that a tooltip control maintains about a tool.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 HitTest

B<HitTest(X,Y)>

Retrieves the information that a tooltip control maintains about a tool.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 NewToolRect

B<NewToolRect(ID, LEFT, TOP, RIGHT, BOTTOM)>

Sets a new bounding rectangle for a tool.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Pop

B<Pop()>

Removes a displayed tooltip window from view.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 SetDelayTime

B<SetDelayTime(TIME,[FLAG=TTDT_INITIAL])>

Sets the initial, pop-up, and reshow durations for a tooltip control.

B<FLAG> :

  TTDT_RESHOW  = 1 : Length of time it takes for subsequent tooltip windows to appear
                     as the pointer moves from one tool to another.
  TTDT_AUTOPOP = 2 : Length of time the tooltip window remains visible if the pointer
                     is stationary within a tool's bounding rectangle.
  TTDT_INITIAL = 3 : Length of time the pointer must remain stationary within a tool's
                     bounding rectangle before the tooltip window appears.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 SetMargin

B<SetMargin(LEFT, TOP, RIGHT, BOTTOM)>

Sets the top, left, bottom, and right margins for a tooltip window.
A margin is the distance, in pixels, between the tooltip window border and
the text contained within the tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 SetMaxTipWidth

B<SetMaxTipWidth(WIDTH)>

Sets the maximum width for a tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 SetTipBkColor

B<SetTipBkColor(COLOR)>

Sets the background color in a tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 SetTipTextColor

B<SetTipTextColor(COLOR)>

Sets the text color in a tooltip window.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 SetToolInfo

B<SetToolInfo(@OPTIONS)>

Sets the information that a tooltip control maintains for a tool.

B<@OPTIONS>: See L<Add()|Win32::GUI::Tooltip/Add>.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 TrackActivate

B<TrackActivate(ID, FLAG)>

Activates or deactivates a tracking tooltip.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 TrackPosition

B<TrackPosition(X,Y)>

Sets the position of a tracking tooltip.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Update

B<Update()>

Forces the current tool to be redrawn.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 UpdateTipText

B<UpdateTipText(ID, STRING, [INSTANCE=NULL])>

Sets the tooltip text for a tool.

=for comment $Id: per_package_method.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 WindowFromPoint

B<WindowFromPoint(X, Y)>

Allows a subclass procedure to cause a tooltip to display text for a window
other than the one beneath the mouse cursor.




=for comment $Id: per_package_event_section.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head1 EVENTS

L<Common events|Win32::GUI::Reference::Events> apply to most windows and controls.

=for comment $Id: per_package_event.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 NeedText

B<NeedText(ID)>

[TBD]

=for comment $Id: per_package_event.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Pop

B<Pop(ID)>

[TBD]

=for comment $Id: per_package_event.tpl,v 1.1 2005/06/26 16:41:00 robertemay Exp $

=head2 Show

B<Show(ID)>

[TBD]





=for comment $Id: pod_postamble.tpl,v 1.2 2005/08/03 21:45:59 robertemay Exp $

=head1 VERSION

Documentation for Win32::GUI v1.03 created 08 Feb 2008

This document is autogenerated by the build process. Edits made here will be lost.
Edit F<docs/per_package.tpl> instead.

=head1 SUPPORT

Homepage: L<http://perl-win32-gui.sourceforge.net/>.

For further support join the users mailing list(C<perl-win32-gui-users@lists.sourceforge.net>) from the website
at L<http://lists.sourceforge.net/lists/listinfo/perl-win32-gui-users>.  There is a searchable list archive at L<http://sourceforge.net/mail/?group_id=16572>.

=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.


