apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
Gtk2_VarDump


Classes:
Gtk2_VarDump
   Gtk2_VarDump
   Gtk2_VarDump_ColTreeView
   Gtk2_VarDump_List
   Gtk2_VarDump_Pane
   Gtk2_VarDump_Tree

Class: Gtk2_VarDump_Tree

Source Location: /Gtk2_VarDump-1.0.0/VarDump/Tree.php

Class Overview

GtkTreeView
   |
   --Gtk2_VarDump_ColTreeView
      |
      --Gtk2_VarDump_Tree

Treeview for Gtk2_VarDump


Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class: Gtk2_VarDump_ColTreeView

Gtk2_VarDump_ColTreeView::__construct()
Gtk2_VarDump_ColTreeView::createColumns()
Creates GtkTreeView columns out of an string array and appends them to the tree view.

Class Details

[line 9]
Treeview for Gtk2_VarDump


[ Top ]

Class Variables

$list =  null

[line 15]

List view for plain values
  • Access: protected

Type:   Gtk2_VarDump_List


[ Top ]


Method Detail

__construct (Constructor)   [line 19]

Gtk2_VarDump_Tree __construct( )

  • Access: public

Overrides Gtk2_VarDump_ColTreeView::__construct() (parent method not documented)
[ Top ]

appendChildren   [line 121]

void appendChildren( mixed $variable, GtkTreeIter $node, [int $nStop = 1])

Appends all the children of the given variable to $node
  • Access: protected

Parameters:

mixed   $variable   —  The variable, whose children shall be appended
GtkTreeIter   $node   —  The parent node to which the new ones shall be appended
int   $nStop   —  After how many levels appending shall be stopped

[ Top ]

build   [line 30]

void build( )

Create the GUI and set up all the things
  • Access: protected

[ Top ]

buildTree   [line 85]

void buildTree( mixed $variable, string $name, [GtkTreeIter $parent = null], [int $nStop = 1])

Appends the given $variable to the tree on the right.

$name is used as title for the node, $parent is the parent node to which the new node will be appended.

  • Access: protected

Parameters:

mixed   $variable   —  The variable to append
string   $name   —  The title for the variable (e.g. array key)
GtkTreeIter   $parent   —  The parent node to which the new node shall be appended
int   $nStop   —  After how many levels appending shall be stopped

[ Top ]

clickedTree   [line 221]

void clickedTree( GtkTreeView $tree, GdkEvent $event)

The tree has been clicked, and the currently selected row will be expanded or collapsed, depending which mouse button has been clicked.

The left mouse button will expand the node, the right mouse button will collapse it. Middle mouse button and a double-clicked left button will expand all children but *only* if they have been expanded before - it would be too dangerous to expand all children to any depth recursively if there are loops.

  • Access: public

Parameters:

GtkTreeView   $tree   —  The tree which has been clicked
GdkEvent   $event   —  The event data for the click event

[ Top ]

expandTree   [line 164]

void expandTree( GtkTreeView $tree, GtkTreeIter $iterator)

Called whenever a tree row is expanded.

It is used to load the children of the node's children if they haven't been loaded yet.

  • Access: public

Parameters:

GtkTreeView   $tree   —  The tree on which the signal has been emitted
GtkTreeIter   $iterator   —  The node which has been expanded

[ Top ]

selectTreeRow   [line 193]

void selectTreeRow( array $selection)

Called whenever a row on the left tree has been selected.

It is used to show the children of the selected variable on the right list.

  • Access: public

Parameters:

array   $selection   —  Array consisting of the model and the currently selected node (GtkTreeIter)

[ Top ]

setList   [line 54]

void setList( Gtk2_VarDump_List $list)

Set the list that displays the simple values
  • Access: public

Parameters:

Gtk2_VarDump_List   $list   —  List object

[ Top ]

setVariable   [line 67]

void setVariable( mixed $variable, [string $name = ''])

Set the variable (and their name) to display.
  • Access: public

Parameters:

mixed   $variable   —  Variable to display
string   $name   —  Name of the variable

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:19:43 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.