IDA C++ SDK 9.2
Loading...
Searching...
No Matches
action_ctx_base_t Struct Reference

Maintain information about the current state of the UI. More...

#include <kernwin.hpp>

Public Member Functions

 action_ctx_base_t ()
 Constructor.
void reset ()
 Invalidate all context info.
bool has_flag (uint32 flag) const
 Check if the given flag is set.

Public Attributes

TWidgetwidget
twidget_type_t widget_type
 type of current widget
qstring widget_title
 title of current widget
chooser_base_tchooser
 the underlying chooser_base_t (if 'widget' is a chooser widget)
sizevec_t chooser_selection
 current chooser selection (0-based). For performance reasons, the selection might be limited.
const char * action
 action name
uint32 cur_flags
 Current address information. see Action context property bits.
ea_t cur_ea
 the current EA of the position in the view; use it to get current segment info, see #ACF_HAS_CURRENT_SEGMENT
uval_t cur_value
 the possible address, or value the cursor is positioned on
func_tcur_func
 the current function,
func_tcur_fchunk
 the current function chunk,
segment_tcur_seg
 the current segment,
action_ctx_base_cur_sel_t cur_sel
 the currently selected range. also see #ACF_HAS_SELECTION
const char * regname
 register name (if widget_type == BWN_CPUREGS and context menu opened on register)
TWidgetfocus
 The focused widget in case it is not the 'form' itself (e.g., the 'quick filter' input in choosers.)
interactive_graph_tgraph
 the current graph (if in a graph view)
screen_graph_selection_tgraph_selection
 the current graph selection (if in a graph view)
const selection_item_thovered
 the current item being hovered (if in a graph view)
dirtree_selection_tdirtree_selection
 the current dirtree_t selection (if applicable). For performance reasons, the selection might be limited.
til_type_ref_ttype_ref
 a reference to the current type (if 'widget' is a type listing widget; nullptr otherwise)
segment_info_t * cur_seg_info
 a reference to the current segment info, nullptr otherwise
func_entry_info_tcur_func_info
 a reference to the current function info, nullptr otherwise
fchunk_info_tcur_fchunk_info
 a reference to the the current function chunk info, nullptr otherwise

Detailed Description

Maintain information about the current state of the UI.

This allows actions to behave appropriately (see action_handler_t)

Constructor & Destructor Documentation

◆ action_ctx_base_t()

action_ctx_base_t::action_ctx_base_t ( )
inline

Constructor.

Member Function Documentation

◆ reset()

void action_ctx_base_t::reset ( )
inline

Invalidate all context info.

◆ has_flag()

bool action_ctx_base_t::has_flag ( uint32 flag) const
inline

Check if the given flag is set.

Member Data Documentation

◆ widget

TWidget* action_ctx_base_t::widget

◆ widget_type

twidget_type_t action_ctx_base_t::widget_type

type of current widget

◆ widget_title

qstring action_ctx_base_t::widget_title

title of current widget

◆ chooser

chooser_base_t* action_ctx_base_t::chooser

the underlying chooser_base_t (if 'widget' is a chooser widget)

◆ chooser_selection

sizevec_t action_ctx_base_t::chooser_selection

current chooser selection (0-based). For performance reasons, the selection might be limited.

◆ action

const char* action_ctx_base_t::action

action name

◆ cur_flags

uint32 action_ctx_base_t::cur_flags

Current address information. see Action context property bits.

◆ cur_ea

ea_t action_ctx_base_t::cur_ea

the current EA of the position in the view; use it to get current segment info, see #ACF_HAS_CURRENT_SEGMENT

◆ cur_value

uval_t action_ctx_base_t::cur_value

the possible address, or value the cursor is positioned on

◆ cur_func

func_t* action_ctx_base_t::cur_func

the current function,

Deprecated
Use cur_func_info for safer access

◆ cur_fchunk

func_t* action_ctx_base_t::cur_fchunk

the current function chunk,

Deprecated
Use cur_fchunk_info for safer access

◆ cur_seg

segment_t* action_ctx_base_t::cur_seg

the current segment,

Deprecated
Use cur_seg_info for safer access

◆ cur_sel

action_ctx_base_cur_sel_t action_ctx_base_t::cur_sel

the currently selected range. also see #ACF_HAS_SELECTION

◆ regname

const char* action_ctx_base_t::regname

register name (if widget_type == BWN_CPUREGS and context menu opened on register)

◆ focus

TWidget* action_ctx_base_t::focus

The focused widget in case it is not the 'form' itself (e.g., the 'quick filter' input in choosers.)

◆ graph

interactive_graph_t* action_ctx_base_t::graph

the current graph (if in a graph view)

◆ graph_selection

screen_graph_selection_t* action_ctx_base_t::graph_selection

the current graph selection (if in a graph view)

◆ hovered

const selection_item_t* action_ctx_base_t::hovered

the current item being hovered (if in a graph view)

◆ dirtree_selection

dirtree_selection_t* action_ctx_base_t::dirtree_selection

the current dirtree_t selection (if applicable). For performance reasons, the selection might be limited.

◆ type_ref

til_type_ref_t* action_ctx_base_t::type_ref

a reference to the current type (if 'widget' is a type listing widget; nullptr otherwise)

◆ cur_seg_info

segment_info_t* action_ctx_base_t::cur_seg_info

a reference to the current segment info, nullptr otherwise

◆ cur_func_info

func_entry_info_t* action_ctx_base_t::cur_func_info

a reference to the current function info, nullptr otherwise

◆ cur_fchunk_info

fchunk_info_t* action_ctx_base_t::cur_fchunk_info

a reference to the the current function chunk info, nullptr otherwise


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