form_actions_t Struct Reference

Functions available from formchgcb_t. More...

#include <kernwin.hpp>

Public Types
enum	dlgbtn_t { dbt_yes , dbt_cancel , dbt_no }
enum	tab_attr_t { ta_unknown = 0 , ta_visible , ta_enabled }

Public Member Functions
virtual bool idaapi	_get_field_value (int field_id, void *buf)=0
	Get value of an input field.
virtual bool idaapi	_set_field_value (int field_id, const void *buf)=0
	Set value of an input field.
virtual bool idaapi	enable_field (int field_id, bool enable)=0
	Enable or disable an input field.
virtual bool idaapi	show_field (int field_id, bool display)=0
	Show or hide an input field.
virtual bool idaapi	move_field (int field_id, int x, int y, int w, int h)=0
	Move/Resize an input field.
virtual int idaapi	get_focused_field ()=0
	Get currently focused input field.
virtual bool idaapi	set_focused_field (int field_id)=0
	Set currently focused input field.
virtual void idaapi	refresh_field (int field_id)=0
	Refresh a field.
virtual void idaapi	close (int close_normally)=0
	Close the form.
virtual void *idaapi	get_ud ()=0
	Retrieve the user data specified through %*.
virtual bool idaapi	_get_str_field_value (int field_id, char *buf, const size_t bufsize)=0
	Get value of an UTF-8 string input field.
	DEF_FIELD_METHOD (radiobutton, ushort) DEF_FIELD_METHOD(rbgroup
ushort	DEF_FIELD_METHOD (checkbox, ushort) DEF_FIELD_METHOD(cbgroup
ushort ushort	DEF_FIELD_METHOD (color, bgcolor_t) DEF_FIELD_METHOD(chooser
ushort ushort sizevec_t	DEF_FIELD_METHOD (combobox, qstring) DEF_FIELD_METHOD(combobox
ushort ushort sizevec_t int	DEF_FIELD_METHOD (text, textctrl_info_t) DEF_FIELD_METHOD(button
ushort ushort sizevec_t int qstring	DEF_STR_FIELD_METHOD (label) DEF_STR_FIELD_METHOD(string) DEF_STR_FIELD_METHOD(path) DEF_FIELD_METHOD(string
ushort ushort sizevec_t int qstring qstring	DEF_FIELD_METHOD (ident, qstring) DEF_FIELD_METHOD(segment
ushort ushort sizevec_t int qstring qstring sel_t	DEF_FIELD_METHOD (signed, sval_t) DEF_FIELD_METHOD(unsigned
ushort ushort sizevec_t int qstring qstring sel_t uval_t	DEF_FIELD_METHOD (int64, int64) DEF_FIELD_METHOD(uint64
ushort ushort sizevec_t int qstring qstring sel_t uval_t uint64	DEF_FIELD_METHOD (ea, ea_t) DEF_FIELD_METHOD(current_tab
virtual bool	enable_dialog_button (dlgbtn_t btn, bool enabled)=0
virtual bool	is_dialog_button_enabled (dlgbtn_t btn)=0
virtual void	swap_combobox_choices (int fid, qstrvec_t &items)=0
virtual bool idaapi	set_field_label (int fid, const qstring &text)=0
	Set the label text of an input field.
virtual bool idaapi	set_tab_attribute (int fid, int tab, tab_attr_t attr, const void *in)=0
virtual bool idaapi	get_tab_attribute (void *out, int fid, int tab, tab_attr_t attr)=0
bool	set_tab_visible (int fid, int tab, bool visible)
bool	is_tab_visible (bool *out, int fid, int tab)
bool	set_tab_enabled (int fid, int tab, bool enabled)
bool	is_tab_enabled (bool *out, int fid, int tab)

Detailed Description

Functions available from formchgcb_t.

For getters/setters for specific field values, see #DEF_SET_METHOD.

Member Enumeration Documentation

dlgbtn_t

enum form_actions_t::dlgbtn_t

Enumerator
dbt_yes
dbt_cancel
dbt_no

tab_attr_t

enum form_actions_t::tab_attr_t

Enumerator
ta_unknown
ta_visible
ta_enabled

Member Function Documentation

_get_field_value()

virtual bool idaapi form_actions_t::_get_field_value ( int field_id, void * buf )

pure virtual

Get value of an input field.

Returns

false if no such field id or invalid field type (B)

_set_field_value()

virtual bool idaapi form_actions_t::_set_field_value ( int field_id, const void * buf )

pure virtual

Set value of an input field.

Returns

false if no such field id or invalid field type (B)

enable_field()

virtual bool idaapi form_actions_t::enable_field ( int field_id, bool enable )

pure virtual

Enable or disable an input field.

Returns

false if no such field id

show_field()

virtual bool idaapi form_actions_t::show_field ( int field_id, bool display )

pure virtual

Show or hide an input field.

Returns

false if no such field id

move_field()

virtual bool idaapi form_actions_t::move_field ( int field_id, int x, int y, int w, int h )

pure virtual

Move/Resize an input field.

Parameters specified as -1 are not modified.

Returns

false no such field id

get_focused_field()

virtual int idaapi form_actions_t::get_focused_field ( )

pure virtual

Get currently focused input field.

Returns

-1 if no such field

set_focused_field()

virtual bool idaapi form_actions_t::set_focused_field ( int field_id )

pure virtual

Set currently focused input field.

Returns

false if no such field id

refresh_field()

virtual void idaapi form_actions_t::refresh_field ( int field_id )

pure virtual

Refresh a field.

close()

virtual void idaapi form_actions_t::close ( int close_normally )

pure virtual

Close the form.

get_ud()

virtual void *idaapi form_actions_t::get_ud ( )

pure virtual

Retrieve the user data specified through %*.

_get_str_field_value()

virtual bool idaapi form_actions_t::_get_str_field_value ( int field_id, char * buf, const size_t bufsize )

pure virtual

Get value of an UTF-8 string input field.

Returns

false if no such field id or invalid field type (B)

DEF_FIELD_METHOD() [1/9]

form_actions_t::DEF_FIELD_METHOD	(	radiobutton	,
		ushort	)

DEF_FIELD_METHOD() [2/9]

ushort form_actions_t::DEF_FIELD_METHOD	(	checkbox	,
		ushort	)

DEF_FIELD_METHOD() [3/9]

ushort ushort form_actions_t::DEF_FIELD_METHOD	(	color	,
		bgcolor_t	)

DEF_FIELD_METHOD() [4/9]

ushort ushort sizevec_t form_actions_t::DEF_FIELD_METHOD	(	combobox	,
		qstring	)

DEF_FIELD_METHOD() [5/9]

ushort ushort sizevec_t int form_actions_t::DEF_FIELD_METHOD	(	text	,
		textctrl_info_t	)

DEF_STR_FIELD_METHOD()

ushort ushort sizevec_t int qstring form_actions_t::DEF_STR_FIELD_METHOD

(

label

)

DEF_FIELD_METHOD() [6/9]

ushort ushort sizevec_t int qstring qstring form_actions_t::DEF_FIELD_METHOD	(	ident	,
		qstring	)

DEF_FIELD_METHOD() [7/9]

ushort ushort sizevec_t int qstring qstring sel_t form_actions_t::DEF_FIELD_METHOD	(	signed	,
		sval_t	)

DEF_FIELD_METHOD() [8/9]

ushort ushort sizevec_t int qstring qstring sel_t uval_t form_actions_t::DEF_FIELD_METHOD	(	int64	,
		int64	)

DEF_FIELD_METHOD() [9/9]

ushort ushort sizevec_t int qstring qstring sel_t uval_t uint64 form_actions_t::DEF_FIELD_METHOD	(	ea	,
		ea_t	)

enable_dialog_button()

virtual bool form_actions_t::enable_dialog_button ( dlgbtn_t btn, bool enabled )

pure virtual

is_dialog_button_enabled()

virtual bool form_actions_t::is_dialog_button_enabled ( dlgbtn_t btn )

pure virtual

swap_combobox_choices()

virtual void form_actions_t::swap_combobox_choices ( int fid, qstrvec_t & items )

pure virtual

set_field_label()

virtual bool idaapi form_actions_t::set_field_label ( int fid, const qstring & text )

pure virtual

Set the label text of an input field.

If the text is empty, the label will be deleted. Currently supports 'multi line text control' and 'chooser' field types. GUI version only.

Returns

success

set_tab_attribute()

virtual bool idaapi form_actions_t::set_tab_attribute ( int fid, int tab, tab_attr_t attr, const void * in )

pure virtual

get_tab_attribute()

virtual bool idaapi form_actions_t::get_tab_attribute ( void * out, int fid, int tab, tab_attr_t attr )

pure virtual

set_tab_visible()

bool form_actions_t::set_tab_visible ( int fid, int tab, bool visible )

inline

is_tab_visible()

bool form_actions_t::is_tab_visible ( bool * out, int fid, int tab )

inline

set_tab_enabled()

bool form_actions_t::set_tab_enabled ( int fid, int tab, bool enabled )

inline

is_tab_enabled()

bool form_actions_t::is_tab_enabled ( bool * out, int fid, int tab )

inline

---

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

• ida-sdk/src/include/kernwin.hpp