linearray_t Class Reference

Inheritance diagram for linearray_t:

Public Member Functions
	__init__ (self, 'void *' _ud)
int	set_place (self, 'place_t' new_at)
'place_t *'	get_place (self)
'bgcolor_t'	get_bg_color (self)
'bgcolor_t'	get_pfx_color (self)
int	get_dlnnum (self)
int	get_linecnt (self)
'void *'	userdata (self)
None	set_userdata (self, 'void *' userd)
bool	beginning (self)
bool	ending (self)
str	down (self)
str	up (self)

Properties
	thisown

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		'void *'	_ud )

Member Function Documentation

beginning()

bool beginning

(

self

)

Are we at the beginning?

down()

str down

(

self

)

Get a line from down direction. place is ok BEFORE 

ending()

bool ending

(

self

)

get_bg_color()

'bgcolor_t' get_bg_color

(

self

)

Get current background color. (the same behavior as with get_place(): good before down() and after up()) 

get_dlnnum()

int get_dlnnum

(

self

)

Get default line number. (the same behavior as with get_place(): good before down() and after up()) 

get_linecnt()

int get_linecnt

(

self

)

Get number of lines for the current place. (the same behavior as with get_place(): good before down() and after up()) 

get_pfx_color()

'bgcolor_t' get_pfx_color

(

self

)

Get current prefix color. (the same behavior as with get_place(): good before down() and after up()) 

get_place()

'place_t *' get_place

(

self

)

Get the current place. 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,
		'place_t'	new_at )

Position the array. 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.

@param new_at: 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()

None set_userdata	(		self,
		'void *'	userd )

Change the user data.

up()

str up

(

self

)

Get a line from up direction. place is ok AFTER 

userdata()

'void *' userdata

(

self

)

Get pointer to user data.

Property Documentation

thisown

thisown

static

Initial value:

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

---

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

• ida_kernwin.py