Module ida_kernwin

Defines the interface between the kernel and the UI.

It contains: * the UI dispatcher notification codes (ui_notification_t) * convenience functions for UI services * structures which hold information about the lines (disassembly, structures, enums) generated by the kernel * functions to interact with the user (dialog boxes) * some string and conversion functions.

Global variables

var AA_CHECKABLE

see update_action_checkable()

var AA_CHECKED

see update_action_checked()

var AA_ICON

see update_action_icon()

var AA_LABEL

see update_action_label()

var AA_NONE

no effect

var AA_SHORTCUT

see update_action_shortcut()

var AA_STATE

see update_action_state()

var AA_TOOLTIP

see update_action_tooltip()

var AA_VISIBILITY

see update_action_visibility()

var ACF_HAS_FIELD_DIRTREE_SELECTION

'dirtree_selection' field is present

var ACF_HAS_SELECTION

there is currently a valid selection

var ACF_HAS_SOURCE

'source' field is present

var ACF_HAS_TYPE_REF

'type_ref' field is present

var ACF_XTRN_EA

cur_ea is in 'externs' segment

var ADF_CHECKABLE

action is checkable

var ADF_CHECKED

starts in a checked state (requires ADF_CHECKABLE)

var ADF_GLOBAL

Register the action globally, so that it's available even if no IDB is present

var ADF_NO_HIGHLIGHT

After activating, do not update the highlight according to what's under the cursor (listings only.)

var ADF_NO_UNDO

the action does not create an undo point. useful for actions that do not modify the database.

var ADF_OT_MASK

Owner type mask.

var ADF_OT_PLUGIN

Owner is a plugin_t.

var ADF_OT_PLUGMOD

Owner is a plugmod_t.

var ADF_OT_PROCMOD

Owner is a procmod_t.

var ADF_OWN_HANDLER

handler is owned by the action; it'll be destroyed when the action is unregistered. Use DYNACTION_DESC_LITERAL to set this bit.

var AHF_VERSION

action handler version (used by action_handler_t::flags)

var AHF_VERSION_MASK

mask for action_handler_t::flags

var ASKBTN_BTN1

First (Yes) button.

var ASKBTN_BTN2

Second (No) button.

var ASKBTN_BTN3

Third (Cancel) button.

var ASKBTN_CANCEL

Cancel button.

var ASKBTN_NO

No button.

var ASKBTN_YES

Yes button.

var AST_DISABLE

analog of AST_ENABLE

var AST_DISABLE_ALWAYS

disable action and do not call action_handler_t::action() anymore

var AST_DISABLE_FOR_IDB

analog of AST_ENABLE_FOR_IDB

var AST_DISABLE_FOR_WIDGET

analog of AST_ENABLE_FOR_WIDGET

var AST_ENABLE

enable action - call action_handler_t::update() when anything changes

var AST_ENABLE_ALWAYS

enable action and do not call action_handler_t::update() anymore

var AST_ENABLE_FOR_IDB

enable action for the current idb. call action_handler_t::update() when a database is opened/closed

var AST_ENABLE_FOR_WIDGET

enable action for the current widget. call action_handler_t::update() when a widget gets/loses focus

var BWN_ADDRWATCH

the 'Watch List' window

var BWN_BOOKMARKS

a persistent 'Bookmarks' widget

var BWN_BPTS

breakpoints

var BWN_CALLS

function calls

var BWN_CALLS_CALLEES

function calls, callees

var BWN_CALLS_CALLERS

function calls, callers

var BWN_CALL_STACK

call stack

var BWN_CHOOSER

a non-builtin chooser

var BWN_CLI

the command-line, in the output window

var BWN_CMDPALCSR

the command palette chooser (Qt version only)

var BWN_CMDPALWIN

the command palette window (Qt version only)

var BWN_CPUREGS

one of the 'General registers', 'FPU register', … debugger windows

var BWN_CUSTVIEW

custom viewers

var BWN_CV_LINE_INFOS

custom viewers' lineinfo widget

var BWN_DISASM

disassembly views

var BWN_DISASM_ARROWS

disassembly arrows widget

var BWN_EXPORTS

exports

var BWN_FRAME

function frame

var BWN_FUNCS

functions

var BWN_HEXVIEW

hex view

var BWN_IMPORTS

imports

var BWN_LOCALS

the 'locals' debugger window

var BWN_MDVIEWCSR

lumina metadata view chooser

var BWN_MODULES

modules

var BWN_NAMES

names

var BWN_NAVBAND

navigation band

var BWN_NOTEPAD

notepad

var BWN_OUTPUT

the text area, in the output window

var BWN_PROBS

problems

var BWN_PSEUDOCODE

hexrays decompiler views

var BWN_SCRIPTS_CSR

the "Recent scripts" chooser

var BWN_SEARCH

search results

var BWN_SEGREGS

segment registers

var BWN_SEGS

segments

var BWN_SELS

selectors

var BWN_SHORTCUTCSR

the shortcuts chooser (Qt version only)

var BWN_SHORTCUTWIN

the shortcuts window (Qt version only)

var BWN_SIGNS

signatures

var BWN_SNIPPETS

the 'Execute script' window

var BWN_SNIPPETS_CSR

the list of snippets in the 'Execute script' window

var BWN_SO_OFFSETS

the 'Structure offsets' dialog's offset panel

var BWN_SO_STRUCTS

the 'Structure offsets' dialog's 'Structures and Unions' panel

var BWN_SRCPTHMAP_CSR

"Source paths…"'s path mappings chooser

var BWN_SRCPTHUND_CSR

"Source paths…"'s undesired paths chooser

var BWN_STKVIEW

the 'Stack view' debugger window

var BWN_STRINGS

strings

var BWN_THREADS

threads

var BWN_TILIST

a type listing widget

var BWN_TILS

type libraries

var BWN_TILVIEW

local types

var BWN_TRACE

tracing view

var BWN_UNDOHIST

Undo history.

var BWN_UNKNOWN

unknown window

var BWN_WATCH

the 'watches' debugger window

var BWN_XREFS

xrefs

var CDVF_LINEICONS

icons can be drawn over the line control

var CDVF_NOLINES

don't show line numbers

var CDVF_STATUSBAR

keep the status bar in the custom viewer

var CDVH_LINES_ALIGNMENT

see set_code_viewer_lines_alignment()

var CDVH_LINES_CLICK

see code_viewer_lines_click_t

var CDVH_LINES_DBLCLICK

see code_viewer_lines_click_t

var CDVH_LINES_DRAWICON

see code_viewer_lines_icon_t

var CDVH_LINES_ICONMARGIN

see set_code_viewer_lines_icon_margin()

var CDVH_LINES_LINENUM

see code_viewer_lines_linenum_t

var CDVH_LINES_POPUP

see code_viewer_lines_click_t

var CDVH_LINES_RADIX

see set_code_viewer_lines_radix()

var CDVH_SRCVIEW

see set_code_viewer_is_source()

var CDVH_USERDATA

see set_code_viewer_user_data()

var CH2_LAZY_LOADED

The chooser is lazy-loaded; it receives the callback do_lazy_load_dir() (only meaningful when CH_HAS_DIRTREE is set)

var CHCOL_DEC

decimal number

var CHCOL_DEFHIDDEN

column should be hidden by default

var CHCOL_DRAGHINT

the column number that will be used to build hints for the dragging undo label. This should be provided for at most one column for any given chooser.

var CHCOL_EA

address

var CHCOL_FNAME

function name. If a chooser column has this flag set and implements chooser_base_t::get_ea(), rows background colors will be automatically set to match the navigator's "Library function", "Lumina function" and "External symbol" colors

var CHCOL_FORMAT

column format mask

var CHCOL_HEX

hexadecimal number

var CHCOL_INODENAME

if CH_HAS_DIRTREE has been specified, this instructs the chooser that this column shows the inode name. This should be provided for at most one column for any given chooser.

var CHCOL_PATH

file path. TUI IDA will truncate excessive cell lengths starting at their beginning, and prepending the resulting text with "…" order to leave the filename visible

var CHCOL_PLAIN

plain string

var CHITEM_BOLD

display the item in bold

var CHITEM_GRAY

gray out the item

var CHITEM_ITALIC

display the item in italic

var CHITEM_STRIKE

strikeout the item

var CHITEM_UNDER

underline the item

var CHOOSER_NOMAINMENU

do not display main menu

var CHOOSER_NOSTATUSBAR

do not display status bar (obsolete. Use CH_NO_STATUS_BAR instead)

var CH_ATTRS

generate ui_get_chooser_item_attrs (gui only)

var CH_BUILTIN_MASK

Mask for builtin chooser numbers. Plugins should not use them.

var CH_CAN_DEL

allow to delete existing item(s)

var CH_CAN_EDIT

allow to edit existing item(s)

var CH_CAN_INS

allow to insert new items

var CH_CAN_REFRESH

allow to refresh chooser

var CH_FORCE_DEFAULT

if a non-modal chooser was already open, change selection to the default one

var CH_HAS_DIFF

The chooser can be used in a diffing/merging workflow.

var CH_HAS_DIRTREE

The chooser can provide a dirtree_t, meaning a tree-like structure can be provided to the user (instead of a flat table)

var CH_KEEP

The chooser instance's lifecycle is not tied to the lifecycle of the widget showing its contents. Closing the widget will not destroy the chooser structure. This allows for, e.g., static global chooser instances that don't need to be allocated on the heap. Also stack-allocated chooser instances must set this bit.

var CH_MODAL

Modal chooser.

var CH_MULTI

The chooser will allow multi-selection (only for GUI choosers). This bit is set when using the chooser_multi_t structure.

var CH_MULTI_EDIT

Obsolete.

var CH_NOBTNS

do not display ok/cancel/help/search buttons. Meaningful only for gui modal windows because non-modal windows do not have any buttons anyway. Text mode does not have them neither.

var CH_NON_PERSISTED_TREE

the chooser tree is not persisted (it is not loaded on startup and is not saved on exit)

var CH_NO_FILTER

The chooser will not have filtering abilities.

var CH_NO_SORT

The chooser will not have sorting abilities.

var CH_NO_STATUS_BAR

don't show a status bar

var CH_QFLT

open with quick filter enabled and focused

var CH_QFTYP_DEFAULT

set quick filtering type to the possible existing default for this chooser

var CH_QFTYP_FUZZY

fuzzy search quick filter type

var CH_QFTYP_NORMAL

normal (i.e., lexicographical) quick filter type

var CH_QFTYP_REGEX

regex quick filter type

var CH_QFTYP_WHOLE_WORDS

whole words quick filter type

var CH_RENAME_IS_EDIT

triggering a 'edit/rename' (i.e., F2 shortcut) on a cell, should call the edit() callback for the corresponding row.

var CH_RESTORE

restore floating position if present (equivalent of WOPN_RESTORE) (GUI version only)

var CH_TM_FOLDERS_ONLY

chooser will show in folders-only mode

var CH_TM_FULL_TREE

chooser will show in full-tree mode

var CH_TM_NO_TREE

chooser will show in no-tree mode

var CK_EXTRA1

extra background overlay #1

var CK_EXTRA10

extra background overlay #10

var CK_EXTRA11

extra background overlay #11

var CK_EXTRA12

extra background overlay #12

var CK_EXTRA13

extra background overlay #13

var CK_EXTRA14

extra background overlay #14

var CK_EXTRA15

extra background overlay #15

var CK_EXTRA16

extra background overlay #16

var CK_EXTRA2

extra background overlay #2

var CK_EXTRA3

extra background overlay #3

var CK_EXTRA4

extra background overlay #4

var CK_EXTRA5

extra background overlay #5

var CK_EXTRA6

extra background overlay #6

var CK_EXTRA7

extra background overlay #7

var CK_EXTRA8

extra background overlay #8

var CK_EXTRA9

extra background overlay #9

var CK_TRACE

traced address

var CK_TRACE_OVL

overlay trace address

var CLNL_FINDCMT

Search for the comment symbol everywhere in the line, not only at the beginning.

var CLNL_LTRIM

Remove leading space characters.

var CLNL_RTRIM

Remove trailing space characters.

var CREATETB_ADV

toolbar is for 'advanced mode' only

var CVH_CLICK

see custom_viewer_click_t

var CVH_CLOSE

see custom_viewer_close_t

var CVH_CURPOS

see custom_viewer_curpos_t

var CVH_DBLCLICK

see custom_viewer_dblclick_t

var CVH_HELP

see custom_viewer_help_t

var CVH_KEYDOWN

see custom_viewer_keydown_t

var CVH_MOUSEMOVE

see custom_viewer_mouse_moved_t

var CVH_POPUP

see custom_viewer_popup_t

var CVH_QT_AWARE

see set_custom_viewer_qt_aware()

var CVLF_USE_MOUSE

Fetch the location from the mouse, instead of caret in the listing.

var CVNF_ACT

activate (i.e., switch to) the viewer. Activation is performed before the new lochist_entry_t instance is actually copied to the viewer's lochist_t (otherwise, if the viewer was invisible its on_location_changed() handler wouldn't be called.)

var CVNF_JUMP

push the current position in this viewer's lochist_t before going to the new location

var CVNF_LAZY

try and move the cursor to a line displaying the place_t if possible. This might disregard the Y position in case of success

var DP_BEFORE

Place src_form before dst_form in the tab bar instead of after; used with DP_INSIDE or DP_TAB.

var DP_BOTTOM

Dock src_form below dest_form.

var DP_FLOATING

Make src_form floating.

var DP_INSIDE

Create a new tab bar with both src_form and dest_form.

var DP_LEFT

Dock src_form to the left of dest_form.

var DP_RIGHT

Dock src_form to the right of dest_form.

var DP_SZHINT

When floating or in a splitter (i.e., not tabbed), use the widget's size hint to determine the best geometry (Qt only)

var DP_TAB

Place src_form into a tab next to dest_form, if dest_form is in a tab bar (otherwise the same as DP_INSIDE)

var DP_TOP

Dock src_form above dest_form.

var GCRF_ALL

Return all rows.

var GCRF_CURRENT

Return the current row.

var GCRF_HEADER

Return header texts.

var GCRF_SELECTION

Return selected rows.

var HIF_IDENTIFIER

text is an identifier (i.e., when searching for the current highlight, SEARCH_IDENT will be used)

var HIF_LOCKED

locked; clicking/moving the cursor around doesn't change the highlight

var HIF_NOCASE

case insensitive

var HIF_REGISTER

text represents a register (aliases/subregisters will be highlit as well)

var HIF_SLOT_0

operate on slot 0

var HIF_SLOT_1

operate on slot 1

var HIF_SLOT_2

operate on slot 2

var HIF_SLOT_3

operate on slot 3

var HIF_SLOT_4

operate on slot 4

var HIF_SLOT_5

operate on slot 5

var HIF_SLOT_6

operate on slot 6

var HIF_SLOT_7

operate on slot 7

var HIF_SLOT_SHIFT

position of the 3 top bits specifying which highlight to use

var HIF_USE_SLOT

use the given number, or just use the "floating" highlight

var HIST_CMD

commands

var HIST_CMT

comments

var HIST_DIR

directory names (text version only)

var HIST_FILE

file names

var HIST_IDENT

identifiers. usually CPU register names are forbidden

var HIST_IDENT2

identifiers, including CPU register names

var HIST_SEG

segment names

var HIST_SRCH

search substrings

var HIST_TYPE

type declarations

var IDA_DEBUG_ACCESSIBILITY

accessibility

var IDA_DEBUG_ALREADY

already data or code

var IDA_DEBUG_ALWAYS

everything

var IDA_DEBUG_APPCALL

appcall

var IDA_DEBUG_CHECKMEM

check heap consistency

var IDA_DEBUG_CONFIG

config file

var IDA_DEBUG_DBGINFO

handling of debug info (e.g. pdb, dwarf)

var IDA_DEBUG_DEBUGGER

debugger

var IDA_DEBUG_DEMANGLE

demangler

var IDA_DEBUG_DREFS

drefs

var IDA_DEBUG_FLIRT

flirt

var IDA_DEBUG_IDP

idp module

var IDA_DEBUG_IDS

ids files

var IDA_DEBUG_INTERNET

internet connection (for API backward compatibility)

var IDA_DEBUG_LDR

ldr module

var IDA_DEBUG_LICENSE

licensing

var IDA_DEBUG_LUMINA

lumina related

var IDA_DEBUG_NETWORK

network

var IDA_DEBUG_NOTIFY

show all notifications

var IDA_DEBUG_OFFSET

offsets

var IDA_DEBUG_PLUGIN

plugin module

var IDA_DEBUG_QUEUE

queue

var IDA_DEBUG_RANGECB

range-based entities like segments, functions and so on

var IDA_DEBUG_REGEX

regular expression

var IDA_DEBUG_ROLLBACK

rollback

var IDA_DEBUG_SIMPLEX

full stack analysis

var IDA_DEBUG_SRCDBG

source debugging

var IDA_DEBUG_SUBPROC

sub process

var IDA_DEBUG_THEMES

themes

var IDA_DEBUG_TIL

type system

var IDCHK_ARG

bad argument(s)

var IDCHK_KEY

bad hotkey name

var IDCHK_MAX

too many IDC hotkeys

var IDCHK_OK

ok

var IWID_ADDRWATCH

address watches

var IWID_ALL

mask

var IWID_ANY_LISTING

anything that uses a listing widget

var IWID_BOOKMARKS

bookmarks list

var IWID_BPTS

breakpoints

var IWID_CALLS

function calls

var IWID_CALLS_CALLEES

funcalls, callees

var IWID_CALLS_CALLERS

funcalls, callers

var IWID_CALL_STACK

call stack

var IWID_CHOOSER

chooser

var IWID_CLI

input line

var IWID_CMDPALCSR

command palette

var IWID_CMDPALWIN

command palette

var IWID_CPUREGS

registers

var IWID_CUSTVIEW

custom viewers

var IWID_CV_LINE_INFOS

lineinfo widget

var IWID_DISASM

disassembly views

var IWID_DISASM_ARROWS

arrows widget

var IWID_EA_LISTING

anything that can be used to represent data/code at an address

var IWID_EXPORTS

exports

var IWID_FRAME

function frame

var IWID_FUNCS

functions

var IWID_HEXVIEW

hex views

var IWID_IMPORTS

imports

var IWID_LOCALS

locals

var IWID_MDVIEWCSR

lumina md view

var IWID_MODULES

modules

var IWID_NAMES

names

var IWID_NAVBAND

navigation band

var IWID_NOTEPAD

notepad

var IWID_OUTPUT

output

var IWID_PROBS

problems

var IWID_PSEUDOCODE

decompiler

var IWID_SCRIPTS_CSR

recent scripts

var IWID_SEARCH

search results

var IWID_SEGREGS

segment registers

var IWID_SEGS

segments

var IWID_SELS

selectors

var IWID_SHORTCUTCSR

shortcuts chooser

var IWID_SHORTCUTWIN

shortcuts window

var IWID_SIGNS

signatures

var IWID_SNIPPETS

snippets

var IWID_SNIPPETS_CSR

snippets chooser

var IWID_SO_OFFSETS

stroff

var IWID_SO_STRUCTS

stroff

var IWID_SRCPTHMAP_CSR

mappings chooser

var IWID_SRCPTHUND_CSR

undesired chooser

var IWID_STKVIEW

stack view

var IWID_STRINGS

strings

var IWID_THREADS

threads

var IWID_TILIST

type listing

var IWID_TILS

type libraries

var IWID_TILVIEW

local types

var IWID_TRACE

tracing view

var IWID_UNDOHIST

Undo history.

var IWID_WATCH

watches

var IWID_XREFS

xrefs

var LROEF_CPS_RANGE

background for range of chars

var LROEF_FULL_LINE

full line background

var MFF_FAST

execute code as soon as possible this mode is ok call ui related functions that do not query the database.

var MFF_NOWAIT

Do not wait for the request to be executed. he caller should ensure that the request is not destroyed until the execution completes. if not, the request will be ignored. the return code of execute_sync() is meaningless in this case. This flag can be used to delay the code execution until the next UI loop run even from the main thread

var MFF_READ

execute code only when ida is idle and it is safe to query the database. this mode is recommended only for code that does not modify the database. (nb: ida may be in the middle of executing another user request, for example it may be waiting for him to enter values into a modal dialog box)

var MFF_WRITE

execute code only when ida is idle and it is safe to modify the database. in particular, this flag will suspend execution if there is a modal dialog box on the screen this mode can be used to call any ida api function. MFF_WRITE implies MFF_READ

var PCF_EA_CAPABLE

toea() implementation returns meaningful data

var PCF_MAKEPLACE_ALLOCATES

makeplace() returns a freshly allocated (i.e., non-static) instance. All new code should pass that flag to register_place_class(), and the corresponding makeplace() class implementation should return new instances.

var RENADDR_HR

dialog for "Pseudocode"; additional flags: * 0x01 Library function * 0x02 Mark as decompiled

var RENADDR_IDA

dialog for "IDA View"

var S2EAOPT_NOCALC

don't try to interpret string as IDC (or current extlang) expression

var SETMENU_APP

add menu item after the specified path

var SETMENU_ENSURE_SEP

make sure there is a separator before the action

var SETMENU_FIRST

add item to the beginning of menu

var SETMENU_INS

add menu item before the specified path (default)

var SVF_COPY_LINES

keep a local copy of '*lines'

var SVF_LINES_BYPTR

remember the 'lines' ptr. do not make a copy of '*lines'

var TCCPT_IDAPLACE

idaplace_t

var TCCPT_INVALID

invalid

var TCCPT_PLACE

place_t

var TCCPT_SIMPLELINE_PLACE

simpleline_place_t

var TCCPT_TIPLACE

tiplace_t

var TCCRT_FLAT

flat view

var TCCRT_GRAPH

graph view

var TCCRT_INVALID

invalid

var TCCRT_PROXIMITY

proximity view

var UIJMP_ACTIVATE

activate the new window

var UIJMP_ANYVIEW

jump in any ea_t-capable view

var UIJMP_DONTPUSH

do not remember the current address in the navigation history

var UIJMP_IDAVIEW

jump in idaview

var UIJMP_IDAVIEW_NEW

jump in new idaview

var VES_SHIFT

state & 1 => Shift is pressed state & 2 => Alt is pressed state & 4 => Ctrl is pressed state & 8 => Mouse left button is pressed state & 16 => Mouse right button is pressed state & 32 => Mouse middle button is pressed state & 128 => Meta is pressed (OSX only)

var VME_LEFT_BUTTON

left mouse button

var VME_MID_BUTTON

middle mouse button

var VME_RIGHT_BUTTON

right mouse button

var VME_UNKNOWN

unknown mouse button

var WCLS_DELETE_LATER

assign the deletion of the widget to the UI loop ///<

var WCLS_DONT_SAVE_SIZE

don't save size of the window

var WCLS_NO_CONTEXT

don't change the current context (useful for toolbars)

var WCLS_SAVE

save state in desktop config

var WOPN_CLOSED_BY_ESC

override idagui.cfg:CLOSED_BY_ESC: esc will close

var WOPN_DP_BEFORE

Place widget before dst_form in the tab bar instead of after; used with WOPN_DP_INSIDE and WOPN_DP_TAB

var WOPN_DP_BOTTOM

Dock widget below dest_ctrl.

var WOPN_DP_FLOATING

Make widget floating.

var WOPN_DP_INSIDE

Create a new tab bar with both widget and dest_ctrl.

var WOPN_DP_LEFT

Dock widget to the left of dest_ctrl.

var WOPN_DP_RIGHT

Dock widget to the right of dest_ctrl.

var WOPN_DP_SZHINT

when floating or in a splitter (i.e., not tabbed), use the widget's size hint to determine the best geometry (Qt only)

var WOPN_DP_TAB

Place widget into a tab next to dest_ctrl, if dest_ctrl is in a tab bar (otherwise the same as WOPN_DP_INSIDE)

var WOPN_DP_TOP

Dock widget above dest_ctrl.

var WOPN_NOT_CLOSED_BY_ESC

override idagui.cfg:CLOSED_BY_ESC: esc will not close

var WOPN_PERSIST

widget will remain available when starting or stopping debugger sessions

var WOPN_RESTORE

if the widget was the only widget in a floating area the last time it was closed, it will be restored as floating, with the same position+size as before

var chtype_entry

see choose_entry()

var chtype_enum

see choose_enum()

var chtype_enum_by_value_and_size

see choose_enum_by_value()

var chtype_func

see choose_func()

var chtype_generic

the generic choose() function

var chtype_idasgn

see choose_idasgn()

var chtype_idatil

see choose_til()

var chtype_name

see choose_name()

var chtype_segm

see choose_segm()

var chtype_srcp

see choose_srcp()

var chtype_stkvar_xref

see choose_stkvar_xref()

var chtype_strpath

see choose_struc_path()

var chtype_struct

see choose_struct()

var chtype_xref

see choose_xref()

var mbox_internal

internal error

var msg_activated

The message window is activated.

var msg_click

Click event. @param x: (int) x-coordinate @param y: (int) y-coordinate @param state: (::view_event_state_t) @retval 1: handled @retval 0: not handled (invoke default handler)

var msg_closed

View closed.

var msg_dblclick

Double click event. @param x: (int) x-coordinate @param y: (int) y-coordinate @param state: (::view_event_state_t) @retval 1: handled @retval 0: not handled (invoke default handler)

var msg_deactivated

The message window is deactivated.

var msg_keydown

Key down event. @param key: (int) @param state: (::view_event_state_t) @retval 1: handled @retval 0: not handled (invoke default handler)

var view_activated

A view is activated @param view: (TWidget *)

var view_click

Click event @param view: (TWidget ) @param event: (const view_mouse_event_t )

var view_close

View closed @param view: (TWidget *)

var view_created

A view is being created. @param view: (TWidget *)

var view_curpos

Cursor position changed @param view: (TWidget *)

var view_dblclick

Double click event @param view: (TWidget ) @param event: (const view_mouse_event_t )

var view_deactivated

A view is deactivated @param view: (TWidget *)

var view_keydown

Key down event @param view: (TWidget *) @param key: (int) @param state: (::view_event_state_t)

var view_loc_changed

The location for the view has changed (can be either the place_t, the renderer_info_t, or both.) @param view: (TWidget ) @param now: (const lochist_entry_t ) @param was: (const lochist_entry_t *)

var view_mouse_moved

The mouse moved on the view @param view: (TWidget ) @param event: (const view_mouse_event_t )

var view_mouse_over

The user moved the mouse over (or out of) a node or an edge. This is only relevant in a graph view. @param view: (TWidget ) @param event: (const view_mouse_event_t )

var view_switched

A view's renderer has changed. @param view: (TWidget *) @param rt: (tcc_renderer_type_t)

Functions

def TWidget__from_ptrval__(ptrval: size_t)

TWidget__from_ptrval__(ptrval) -> TWidget *

@param ptrval: size_t

def activate_widget(widget: TWidget *, take_focus: bool)

activate_widget(widget, take_focus) Activate widget (only gui version) (ui_activate_widget).

@param widget: (C++: TWidget *) existing widget to display @param take_focus: (C++: bool) give focus to given widget

def add_hotkey(hotkey: char const *, pyfunc: PyObject *)

add_hotkey(hotkey, pyfunc) -> PyCapsule Associates a function call with a hotkey. Callable pyfunc will be called each time the hotkey is pressed

@param hotkey: The hotkey @param pyfunc: Callable

@return: Context object on success or None on failure.

def add_idc_hotkey(hotkey: char const *, idcfunc: char const *)

add_idc_hotkey(hotkey, idcfunc) -> int Add hotkey for IDC function (ui_add_idckey).

@param hotkey: (C++: const char ) hotkey name @param idcfunc: (C++: const char ) IDC function name @return: IDC hotkey error codes

def add_spaces(s: char const *, len: size_t)

add_spaces(s, len) -> str Add space characters to the colored string so that its length will be at least 'len' characters. Don't trim the string if it is longer than 'len'.

@param str: (C++: char *) pointer to colored string to modify (may not be nullptr) @param len: (C++: ssize_t) the desired length of the string @return: pointer to the end of input string

def addon_count() ‑> int

addon_count() -> int Get number of installed addons.

def analyzer_options()

analyzer_options() Allow the user to set analyzer options. (show a dialog box) (ui_analyzer_options)

def ask_addr(defval, format)

Output a formatted string to the output window (msg) preprended with "**DATABASE IS CORRUPTED: " Display a dialog box and wait for the user to input an address (ui_ask_addr).

@retval 0: the user pressed Esc. @retval 1: ok, the user entered an address

def ask_buttons(*args) ‑> int

ask_buttons(Yes, No, Cancel, deflt, format) -> int Display a dialog box and get choice from maximum three possibilities (ui_ask_buttons). @note: for all buttons: * use "" or nullptr to take the default name for the button. * prepend "HIDECANCEL\n" in 'format' to hide the Cancel button

@param Yes: (C++: const char ) text for the first button @param No: (C++: const char ) text for the second button @param Cancel: (C++: const char ) text for the third button @param deflt: (C++: int) default choice: one of Button IDs @param format: (C++: const char ) printf-style format string for question. It may have some prefixes, see below. @return: one of Button IDs specifying the selected button (Esc key returns Cancel/3rd button value)

def ask_file(*args)

ask_file(for_saving, defval, format) -> char *

@param for_saving: bool @param defval: char const * @param format: char const *

def ask_for_feedback(*args)

ask_for_feedback(format) Show a message box asking to send the input file to \link{mailto:support@hex- rays.com,support@hex-rays.com}.

@param format: (C++: const char *) the reason why the input file is bad

def ask_form(*args)

Display a dialog box and wait for the user. If the form contains the "BUTTON NO