GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PADRE::WX::TREECTRL (3)

.ds Aq ’

NAME

Padre::Wx::TreeCtrl - A Wx::TreeCtrl with various extra convenience methods

CONTENTS

DESCRIPTION

<B>Padre::Wx::TreeCtrlB> is a direct subclass of Wx::TreeCtrl with a handful of additional methods that make life easier when writing GUI components for Padre that use trees.

METHODS

    lock_scroll



  SCOPE: {
      my $lock = $tree->lock_scroll;
 
      # Apply changes to the tree
  }



When making changes to Wx::TreeCtrl objects, many changes to the tree structure also include an implicit movement of the scroll position to focus on the node that was changed.

When generating changes to trees that are not the immediate focus of the user this can be extremely flickery and disconcerting, especially when generating entire large trees.

The lock_scroll method creates a guard object which combines an update lock with a record of the scroll position of the tree.

When the object is destroyed, the scroll position of the tree is returned to the original position immediately before the update lock is released.

The effect is that the tree has changed silently, with the scroll position remaining unchanged.

    GetChildByText



  my $item = $tree->GetChildByText("Foo");



The GetChildByText method is a convenience method for searching through a tree to find a specific item based on the item text of the child.

It returns the item ID of the first node containing the search text or undef if no element in the tree contains the search text.

    GetChildrenPlData



  my @data = $tree->GetChildrenPlData;



The GetChildrenPlData method fetches a list of Perl data elements (via GetPlData) for <B>allB> nodes in the tree.

The list is returned based on a depth-first top-down node order.

    GetExpandedPlData



  my @data = $tree->GetExpandedPlData;



The GetExpandedPlData method is a variation of the GetChildrenPlData method. It returns a list of Perl data elements in depth-first top-down node order, but only for nodes which are expanded (via IsExpanded).

COPYRIGHT & LICENSE

Copyright 2008-2013 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.

The full text of the license can be found in the LICENSE file included with this module.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PADRE::WX::TREECTRL (3) 2013-11-09

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.