Module ida_kernwin :: Class PluginForm
[frames] | no frames]

Class PluginForm

object --+
         |
        PluginForm

PluginForm class.

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

Instance Methods
 
Close(self, options)
Closes the form.
 
GetWidget(self)
Return the TWidget underlying this view.
 
OnClose(self, form)
Called when the plugin form is closed
 
OnCreate(self, form)
This event is called when the plugin form is created.
 
Show(self, caption, options=0)
Creates the form if not was not created or brings to front if it was already created
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods
 
FormToPyQtWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Convert a TWidget* to a QWidget to be used by PyQt
 
FormToPySideWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Use this method to convert a TWidget* to a QWidget to be used by PySide
 
QtWidgetToTWidget(w, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Convert a QWidget to a TWidget* to be used by IDA
 
TWidgetToPyQtWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Convert a TWidget* to a QWidget to be used by PyQt
 
TWidgetToPySideWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Use this method to convert a TWidget* to a QWidget to be used by PySide
Class Variables
  VALID_CAPSULE_NAME = '$valid$'
  WCLS_CLOSE_LATER = 8
  WCLS_DONT_SAVE_SIZE = 4
  WCLS_NO_CONTEXT = 2
  WCLS_SAVE = 1
  WOPN_CENTERED = 32
  WOPN_CREATE_ONLY = {}
  WOPN_DP_BEFORE = 2097152
  WOPN_DP_BOTTOM = 524288
  WOPN_DP_FLOATING = 8388608
  WOPN_DP_INSIDE = 1048576
  WOPN_DP_INSIDE_BEFORE = 3145728
  WOPN_DP_LEFT = 65536
  WOPN_DP_RIGHT = 262144
  WOPN_DP_TAB = 4194304
  WOPN_DP_TAB_BEFORE = 6291456
  WOPN_DP_TOP = 131072
  WOPN_MDI = 1
  WOPN_MENU = 16
  WOPN_ONTOP = 8
  WOPN_PERSIST = 64
  WOPN_RESTORE = 4
  WOPN_TAB = 2
Properties

Inherited from object: __class__

Method Details

Close(self, options)

 

Closes the form.

Parameters:
  • options - Close options (WCLS_SAVE, WCLS_NO_CONTEXT, ...)
Returns:
None

FormToPyQtWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Static Method

 

Convert a TWidget* to a QWidget to be used by PyQt

Parameters:
  • ctx - Context. Reference to a module that already imported SIP and QtWidgets modules

FormToPySideWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Static Method

 

Use this method to convert a TWidget* to a QWidget to be used by PySide

Parameters:
  • ctx - Context. Reference to a module that already imported QtWidgets module

GetWidget(self)

 

Return the TWidget underlying this view.

Returns:
The TWidget underlying this view, or None.

OnClose(self, form)

 

Called when the plugin form is closed

Returns:
None

OnCreate(self, form)

 

This event is called when the plugin form is created. The programmer should populate the form when this event is triggered.

Returns:
None

QtWidgetToTWidget(w, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Static Method

 

Convert a QWidget to a TWidget* to be used by IDA

Parameters:
  • ctx - Context. Reference to a module that already imported SIP and QtWidgets modules

Show(self, caption, options=0)

 

Creates the form if not was not created or brings to front if it was already created

Parameters:
  • caption - The form caption
  • options - One of PluginForm.WOPN_ constants

TWidgetToPyQtWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Static Method

 

Convert a TWidget* to a QWidget to be used by PyQt

Parameters:
  • ctx - Context. Reference to a module that already imported SIP and QtWidgets modules

TWidgetToPySideWidget(tw, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Static Method

 

Use this method to convert a TWidget* to a QWidget to be used by PySide

Parameters:
  • ctx - Context. Reference to a module that already imported QtWidgets module

__init__(self)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__