CustomIDAMemo Class Reference

Inheritance diagram for CustomIDAMemo:

Public Member Functions
	__init__ (self)
	init(self, _flags=0, _hkcb_flags=0x0001) -> View_Hooks
	view_activated (self, view)
	view_activated(self, view) A view is activated
	view_deactivated (self, view)
	view_deactivated(self, view) A view is deactivated
	view_keydown (self, view, key, state)
	view_keydown(self, view, key, state) Key down event
	view_click (self, view, ve)
	view_click(self, view, event) Click event
	view_dblclick (self, view, ve)
	view_dblclick(self, view, event) Double click event
	view_curpos (self, view, *args)
	view_curpos(self, view) Cursor position changed
	view_close (self, view, *args)
	view_close(self, view) View closed
	view_switched (self, view, rt)
	view_switched(self, view, rt) A view's renderer has changed.
	view_mouse_over (self, view, ve)
	view_mouse_over(self, view, event) The user moved the mouse over (or out of) a node or an edge.
	view_loc_changed (self, view, now, was)
	view_loc_changed(self, view, now, was) The location for the view has changed (can be either the place_t, the renderer_info_t, or both.)
	view_mouse_moved (self, view, ve)
	view_mouse_moved(self, view, event) The mouse moved on the view
	Refresh (self)
	Refreshes the view.
	GetCurrentRendererType (self)
	SetCurrentRendererType (self, rtype)
	Set the current view's renderer.
	SetNodeInfo (self, node_index, node_info, flags)
	Set the properties for the given node.
	SetNodesInfos (self, values)
	Set the properties for the given nodes.
	GetNodeInfo (self, *args)
	Get the properties for the given node.
	DelNodesInfos (self, *nodes)
	Delete the properties for the given node(s).
	CreateGroups (self, groups_infos)
	Send a request to modify the graph by creating a (set of) group(s), and perform an animation.
	DeleteGroups (self, groups, new_current=-1)
	Send a request to delete the specified groups in the graph, and perform an animation.
	SetGroupsVisibility (self, groups, expand, new_current=-1)
	Send a request to expand/collapse the specified groups in the graph, and perform an animation.
	GetWidget (self)
	Return the TWidget underlying this view.
	GetWidgetAsGraphViewer (self)
	Return the graph_viewer_t underlying this view.
Public Member Functions inherited from View_Hooks
"bool"	hook (self, *args)
	hook(self) -> bool
"bool"	unhook (self, *args)
	unhook(self) -> bool
"void"	view_created (self, *args)
	view_created(self, view) A view is being created.
	__disown__ (self)

Protected Member Functions
	_graph_item_tuple (self, ve)
	_get_cb (self, view, cb_name)
	_get_cb_arity (self, cb)
	_OnBind (self, hook)

Static Protected Member Functions
	_dummy_cb (*args)

Additional Inherited Members
Properties inherited from View_Hooks
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

Parameters

_flags	uint32
_hkcb_flags	uint32

Reimplemented from View_Hooks.

Reimplemented in GraphViewer, and IDAViewWrapper.

Member Function Documentation

_dummy_cb()

_dummy_cb ( * args )

staticprotected

_get_cb()

_get_cb ( self, view, cb_name )

protected

_get_cb_arity()

_get_cb_arity ( self, cb )

protected

_graph_item_tuple()

_graph_item_tuple ( self, ve )

protected

_OnBind()

_OnBind ( self, hook )

protected

Reimplemented in GraphViewer.

CreateGroups()

CreateGroups	(		self,
			groups_infos )

Each object in the 'groups_infos' list must be of the format: { "nodes" : [<int>, <int>, <int>, ...] # The list of nodes to group "text" : <string> # The synthetic text for that group }

Parameters

groups_infos

A list of objects that describe those groups.

Returns

: A [<int>, <int>, ...] list of group nodes, or None (failure).

DeleteGroups()

DeleteGroups	(		self,
			groups,
			new_current = -1 )

Parameters

groups	A list of group node numbers.
new_current	A node to focus on after the groups have been deleted

Returns

: True on success, False otherwise.

DelNodesInfos()

DelNodesInfos	(		self,
		*	nodes )

Parameters

nodes

A list of node IDs

GetCurrentRendererType()

GetCurrentRendererType

(

self

)

GetNodeInfo()

GetNodeInfo	(		self,
		*	args )

Parameters

ni	A node_info_t instance
node	The index of the node.

Returns

: success

GetWidget()

GetWidget

(

self

)

Returns

: The TWidget underlying this view, or None.

GetWidgetAsGraphViewer()

GetWidgetAsGraphViewer

(

self

)

Returns

: The graph_viewer_t underlying this view, or None.

Refresh()

Refresh

(

self

)

This causes the OnRefresh() to be called

SetCurrentRendererType()

SetCurrentRendererType	(		self,
			rtype )

Parameters

rtype

The renderer type. Should be one of the idaapi.TCCRT_* values.

SetGroupsVisibility()

SetGroupsVisibility	(		self,
			groups,
			expand,
			new_current = -1 )

Parameters

groups	A list of group node numbers.
expand	True to expand the group, False otherwise.
new_current	A node to focus on after the groups have been expanded/collapsed.

Returns

: True on success, False otherwise.

SetNodeInfo()

SetNodeInfo	(		self,
			node_index,
			node_info,
			flags )

Example usage (set second nodes's bg color to red): inst = ... p = idaapi.node_info_t() p.bg_color = 0x00ff0000 inst.SetNodeInfo(1, p, idaapi.NIF_BG_COLOR)

Parameters

node_index	The node index.
node_info	An idaapi.node_info_t instance.
flags	An OR'ed value of NIF_* values.

SetNodesInfos()

SetNodesInfos	(		self,
			values )

Example usage (set first three nodes's bg color to purple): inst = ... p = idaapi.node_info_t() p.bg_color = 0x00ff00ff inst.SetNodesInfos({0 : p, 1 : p, 2 : p})

Parameters

values

A dictionary of 'int -> node_info_t' objects.

view_activated()

view_activated	(		self,
			args )

Parameters

view	(TWidget *)

Reimplemented from View_Hooks.

view_click()

view_click	(		self,
			args,
			ve )

Parameters

view	(TWidget *)
event	(const view_mouse_event_t *)

Reimplemented from View_Hooks.

view_close()

view_close	(		self,
			args,
		*	args )

Parameters

view	(TWidget *)

Reimplemented from View_Hooks.

view_curpos()

view_curpos	(		self,
			args,
		*	args )

Parameters

view	(TWidget *)

Reimplemented from View_Hooks.

view_dblclick()

view_dblclick	(		self,
			args,
			ve )

Parameters

view	(TWidget *)
event	(const view_mouse_event_t *)

Reimplemented from View_Hooks.

view_deactivated()

view_deactivated	(		self,
			args )

Parameters

view	(TWidget *)

Reimplemented from View_Hooks.

view_keydown()

view_keydown	(		self,
			args,
			key,
			state )

Parameters

view	(TWidget *)
key	(int)
state	(::view_event_state_t)

Reimplemented from View_Hooks.

view_loc_changed()

view_loc_changed	(		self,
			args,
			now,
			was )

Parameters

view	(TWidget *)
now	(const lochist_entry_t *)
was	(const lochist_entry_t *)

Reimplemented from View_Hooks.

view_mouse_moved()

view_mouse_moved	(		self,
			args,
			ve )

Parameters

view	(TWidget *)
event	(const view_mouse_event_t *)

Reimplemented from View_Hooks.

view_mouse_over()

view_mouse_over	(		self,
			args,
			ve )

This is only relevant in a graph view.

Parameters

view	(TWidget *)
event	(const view_mouse_event_t *)

Reimplemented from View_Hooks.

view_switched()

view_switched	(		self,
			args,
			rt )

Parameters

view	(TWidget *)
rt	(tcc_renderer_type_t)

Reimplemented from View_Hooks.

---

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

• ida_kernwin.py