linearray_t Class Reference

Proxy of C++ linearray_t class.

Inheritance diagram for linearray_t:

Public Member Functions
	__init__ (self, *args)
	init(self, _ud) -> linearray_t
"int"	set_place (self, *args)
	set_place(self, new_at) -> int Position the array.
"place_t *"	get_place (self, *args)
	get_place(self) -> place_t Get the current place.
"bgcolor_t"	get_bg_color (self, *args)
	get_bg_color(self) -> bgcolor_t Get current background color.
"bgcolor_t"	get_pfx_color (self, *args)
	get_pfx_color(self) -> bgcolor_t Get current prefix color.
"int"	get_dlnnum (self, *args)
	get_dlnnum(self) -> int Get default line number.
"int"	get_linecnt (self, *args)
	get_linecnt(self) -> int Get number of lines for the current place.
"void *"	userdata (self, *args)
	userdata(self) -> void * Get pointer to user data.
"void"	set_userdata (self, *args)
	set_userdata(self, userd) Change the user data.
"bool"	beginning (self, *args)
	beginning(self) -> bool Are we at the beginning?
"bool"	ending (self, *args)
	ending(self) -> bool
"qstring const *"	down (self, *args)
	down(self) -> qstring const * Get a line from down direction.
"qstring const *"	up (self, *args)
	up(self) -> qstring const * Get a line from up direction.

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

Parameters

_ud

void *

Member Function Documentation

beginning()

"bool" beginning	(		self,
		*	args )

down()

"qstring const *" down	(		self,
		*	args )

place is ok BEFORE

ending()

"bool" ending	(		self,
		*	args )

get_bg_color()

"bgcolor_t" get_bg_color	(		self,
		*	args )

(the same behavior as with get_place(): good before down() and after up())

get_dlnnum()

"int" get_dlnnum	(		self,
		*	args )

(the same behavior as with get_place(): good before down() and after up())

get_linecnt()

"int" get_linecnt	(		self,
		*	args )

(the same behavior as with get_place(): good before down() and after up())

get_pfx_color()

"bgcolor_t" get_pfx_color	(		self,
		*	args )

(the same behavior as with get_place(): good before down() and after up())

get_place()

"place_t *" get_place	(		self,
		*	args )

If called before down(), then returns place of line which will be returned by down(). If called after up(), then returns place if line returned by up().

set_place()

"int" set_place	(		self,
		*	args )

This function must be called before calling any other member functions.

linearray_t doesn't own place_t structures. The caller must take care of place_t objects.

Parameters

new_at

(C++: const place_t *) new position of the array

Returns

: the delta of lines that the linearray_t had to adjust the place by. For example, if the place_t has a lnnum of 5, but it turns out, upon generating lines, that the number of lines for that particular place is only 2, then 3 will be returned.

set_userdata()

"void" set_userdata	(		self,
		*	args )

Parameters

userd

(C++: void *)

up()

"qstring const *" up	(		self,
		*	args )

place is ok AFTER

userdata()

"void *" userdata	(		self,
		*	args )

Property Documentation

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

---

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

• ida_kernwin.py