PluginForm Class Reference

PluginForm class. More...

Inheritance diagram for PluginForm:

Public Member Functions
	__init__ (self)
	Show (self, caption, options=0)
	Creates the form if not was not created or brings to front if it was already created.
	OnCreate (self, form)
	This event is called when the plugin form is created.
	OnClose (self, form)
	Called when the plugin form is closed.
	Close (self, options)
	Closes the form.
	GetWidget (self)
	Return the TWidget underlying this view.

Static Public Member Functions
	TWidgetToPyQtWidget (tw, ctx=sys.modules['__main__'])
	Convert a TWidget* to a QWidget to be used by PyQt.
	QtWidgetToTWidget (w, ctx=sys.modules['__main__'])
	Convert a QWidget to a TWidget* to be used by IDA.
	TWidgetToPySideWidget (tw, ctx=sys.modules['__main__'])
	Use this method to convert a TWidget* to a QWidget to be used by PySide.

Static Public Attributes
int	WOPN_MDI = 0x01
int	WOPN_TAB = 0x02
	WOPN_RESTORE = _ida_kernwin.WOPN_RESTORE
int	WOPN_ONTOP = 0x08
int	WOPN_MENU = 0x10
int	WOPN_CENTERED = 0x20
	WOPN_PERSIST = _ida_kernwin.WOPN_PERSIST
	WOPN_DP_LEFT = _ida_kernwin.WOPN_DP_LEFT
	WOPN_DP_TOP = _ida_kernwin.WOPN_DP_TOP
	WOPN_DP_RIGHT = _ida_kernwin.WOPN_DP_RIGHT
	WOPN_DP_BOTTOM = _ida_kernwin.WOPN_DP_BOTTOM
	WOPN_DP_INSIDE = _ida_kernwin.WOPN_DP_INSIDE
	WOPN_DP_TAB = _ida_kernwin.WOPN_DP_TAB
	WOPN_DP_BEFORE = _ida_kernwin.WOPN_DP_BEFORE
	WOPN_DP_FLOATING = _ida_kernwin.WOPN_DP_FLOATING
	WOPN_DP_SZHINT = _ida_kernwin.WOPN_DP_SZHINT
	WOPN_DP_INSIDE_BEFORE = _ida_kernwin.WOPN_DP_INSIDE_BEFORE
	WOPN_DP_TAB_BEFORE = _ida_kernwin.WOPN_DP_TAB_BEFORE
dict	WOPN_CREATE_ONLY = {}
str	VALID_CAPSULE_NAME = b"$valid$"
	FormToPyQtWidget = TWidgetToPyQtWidget
	FormToPySideWidget = TWidgetToPySideWidget
	WCLS_SAVE = _ida_kernwin.WCLS_SAVE
	WCLS_NO_CONTEXT = _ida_kernwin.WCLS_NO_CONTEXT
	WCLS_DONT_SAVE_SIZE = _ida_kernwin.WCLS_DONT_SAVE_SIZE
	WCLS_DELETE_LATER = _ida_kernwin.WCLS_DELETE_LATER
	WCLS_CLOSE_LATER = WCLS_DELETE_LATER

Static Protected Member Functions
	_ensure_widget_deps (ctx)

Detailed Description

This form can be used to host additional controls. Please check the PyQt example.

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

Member Function Documentation

_ensure_widget_deps()

_ensure_widget_deps ( ctx )

staticprotected

Close()

Close	(		self,
			options )

Parameters

options

Close options (WCLS_SAVE, WCLS_NO_CONTEXT, ...)

Returns

: None

GetWidget()

GetWidget

(

self

)

Returns

: The TWidget underlying this view, or None.

OnClose()

OnClose	(		self,
			form )

Returns

: None

OnCreate()

OnCreate	(		self,
			form )

The programmer should populate the form when this event is triggered.

Returns

: None

QtWidgetToTWidget()

QtWidgetToTWidget ( w, ctx = sys.modules['__main__'] )

static

Parameters

ctx	Context. Reference to a module that already imported SIP and QtWidgets modules

Show()

Show	(		self,
			caption,
			options = 0 )

Parameters

caption	The form caption
options	One of PluginForm.WOPN_ constants

TWidgetToPyQtWidget()

TWidgetToPyQtWidget ( tw, ctx = sys.modules['__main__'] )

static

Parameters

ctx	Context. Reference to a module that already imported SIP and QtWidgets modules

TWidgetToPySideWidget()

TWidgetToPySideWidget ( tw, ctx = sys.modules['__main__'] )

static

Parameters

ctx	Context. Reference to a module that already imported QtWidgets module

Member Data Documentation

FormToPyQtWidget

FormToPyQtWidget = TWidgetToPyQtWidget

static

FormToPySideWidget

FormToPySideWidget = TWidgetToPySideWidget

static

VALID_CAPSULE_NAME

str VALID_CAPSULE_NAME = b"$valid$"

static

WCLS_CLOSE_LATER

WCLS_CLOSE_LATER = WCLS_DELETE_LATER

static

WCLS_DELETE_LATER

WCLS_DELETE_LATER = _ida_kernwin.WCLS_DELETE_LATER

static

WCLS_DONT_SAVE_SIZE

WCLS_DONT_SAVE_SIZE = _ida_kernwin.WCLS_DONT_SAVE_SIZE

static

WCLS_NO_CONTEXT

WCLS_NO_CONTEXT = _ida_kernwin.WCLS_NO_CONTEXT

static

WCLS_SAVE

WCLS_SAVE = _ida_kernwin.WCLS_SAVE

static

WOPN_CENTERED

int WOPN_CENTERED = 0x20

static

WOPN_CREATE_ONLY

dict WOPN_CREATE_ONLY = {}

static

WOPN_DP_BEFORE

WOPN_DP_BEFORE = _ida_kernwin.WOPN_DP_BEFORE

static

WOPN_DP_BOTTOM

WOPN_DP_BOTTOM = _ida_kernwin.WOPN_DP_BOTTOM

static

WOPN_DP_FLOATING

WOPN_DP_FLOATING = _ida_kernwin.WOPN_DP_FLOATING

static

WOPN_DP_INSIDE

WOPN_DP_INSIDE = _ida_kernwin.WOPN_DP_INSIDE

static

WOPN_DP_INSIDE_BEFORE

WOPN_DP_INSIDE_BEFORE = _ida_kernwin.WOPN_DP_INSIDE_BEFORE

static

WOPN_DP_LEFT

WOPN_DP_LEFT = _ida_kernwin.WOPN_DP_LEFT

static

WOPN_DP_RIGHT

WOPN_DP_RIGHT = _ida_kernwin.WOPN_DP_RIGHT

static

WOPN_DP_SZHINT

WOPN_DP_SZHINT = _ida_kernwin.WOPN_DP_SZHINT

static

WOPN_DP_TAB

WOPN_DP_TAB = _ida_kernwin.WOPN_DP_TAB

static

WOPN_DP_TAB_BEFORE

WOPN_DP_TAB_BEFORE = _ida_kernwin.WOPN_DP_TAB_BEFORE

static

WOPN_DP_TOP

WOPN_DP_TOP = _ida_kernwin.WOPN_DP_TOP

static

WOPN_MDI

int WOPN_MDI = 0x01

static

WOPN_MENU

int WOPN_MENU = 0x10

static

WOPN_ONTOP

int WOPN_ONTOP = 0x08

static

WOPN_PERSIST

WOPN_PERSIST = _ida_kernwin.WOPN_PERSIST

static

WOPN_RESTORE

WOPN_RESTORE = _ida_kernwin.WOPN_RESTORE

static

WOPN_TAB

int WOPN_TAB = 0x02

static

---

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

• ida_kernwin.py