grc.gui.BlockTreeWindow.BlockTreeWindow Class Reference

List of all members.

Public Member Functions
def	__init__
def	add_block
Public Attributes
	platform
	get_flow_graph
	treestore
	treeview
	add_button
	categories
Private Member Functions
def	_get_selected_block_key
def	_update_add_button
def	_add_selected_block
def	_handle_mouse_button_press
def	_handle_selection_change
def	_handle_add_button

---

Detailed Description

The block selection panel.

Definition at line 32 of file BlockTreeWindow.py.

---

Member Function Documentation

def grc.gui.BlockTreeWindow.BlockTreeWindow.__init__	(		self,
			platform,
			get_flow_graph
	)

BlockTreeWindow constructor. Create a tree view of the possible blocks in the platform. The tree view nodes will be category names, the leaves will be block names. A mouse double click or button press action will trigger the add block event.

Parameters:

	platform	the particular platform will all block prototypes
	get_flow_graph	get the selected flow graph

Definition at line 35 of file BlockTreeWindow.py.

def grc.gui.BlockTreeWindow.BlockTreeWindow.add_block	(		self,
			category,
			block = None
	)

Block Tree Methods Add a block with category to this selection window. Add only the category when block is None.

Parameters:

	category	the category string
	block	the block object or None

Definition at line 80 of file BlockTreeWindow.py.

def grc.gui.BlockTreeWindow.BlockTreeWindow._get_selected_block_key

(

self

)

[private]

Helper Methods Get the currently selected block key.

Returns:

the key of the selected block or a empty string

Definition at line 106 of file BlockTreeWindow.py.

def grc.gui.BlockTreeWindow.BlockTreeWindow._update_add_button

(

self

)

[private]

Update the add button's sensitivity. The button should be active only if a block is selected.

Definition at line 115 of file BlockTreeWindow.py.

def grc.gui.BlockTreeWindow.BlockTreeWindow._add_selected_block

(

self

)

[private]

Add the selected block with the given key to the flow graph.

Definition at line 123 of file BlockTreeWindow.py.

def grc.gui.BlockTreeWindow.BlockTreeWindow._handle_mouse_button_press	(		self,
			widget,
			event
	)			[private]

Event Handlers Handle the mouse button press. If a left double click is detected, call add selected block.

Definition at line 133 of file BlockTreeWindow.py.

def grc.gui.BlockTreeWindow.BlockTreeWindow._handle_selection_change	(		self,
			selection
	)			[private]

Handle a selection change in the tree view. If a selection changes, set the add button sensitive.

Definition at line 141 of file BlockTreeWindow.py.

def grc.gui.BlockTreeWindow.BlockTreeWindow._handle_add_button	(		self,
			widget
	)			[private]

Handle the add button clicked signal. Call add selected block.

Definition at line 148 of file BlockTreeWindow.py.

---

Member Data Documentation

grc.gui.BlockTreeWindow.BlockTreeWindow.platform

Definition at line 45 of file BlockTreeWindow.py.

grc.gui.BlockTreeWindow.BlockTreeWindow.get_flow_graph

Definition at line 46 of file BlockTreeWindow.py.

grc.gui.BlockTreeWindow.BlockTreeWindow.treestore

Definition at line 48 of file BlockTreeWindow.py.

grc.gui.BlockTreeWindow.BlockTreeWindow.treeview

Definition at line 49 of file BlockTreeWindow.py.

grc.gui.BlockTreeWindow.BlockTreeWindow.add_button

Definition at line 66 of file BlockTreeWindow.py.

grc.gui.BlockTreeWindow.BlockTreeWindow.categories

Definition at line 70 of file BlockTreeWindow.py.

---

The documentation for this class was generated from the following file:

• src/grc/gui/BlockTreeWindow.py (r9379/r9021)

---