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
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
 
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.

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

Static Methods
 
FormToPyQtWidget(form, ctx=<module '__main__' from 'tools/docs/hrdoc.py'>)
Use this method to convert a TWidget* to a QWidget to be used by PyQt
 
FormToPySideWidget(form, 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
  WOPN_MDI = 1
start by default as MDI (obsolete)
  WOPN_TAB = 2
attached by default to a tab
  WOPN_RESTORE = 4
restore state from desktop config
  WOPN_ONTOP = 8
form should be "ontop
  WOPN_MENU = 16
form must be listed in the windows menu (automatically set for all plugins)
  WOPN_CENTERED = 32
form will be centered on the screen
  WOPN_PERSIST = 64
form will persist until explicitly closed with Close()
  WCLS_SAVE = 1
Save state in desktop config
  WCLS_NO_CONTEXT = 2
Don't change the current context (useful for toolbars)
  WCLS_DONT_SAVE_SIZE = 4
Don't save size of the window
  WCLS_CLOSE_LATER = 8
This flag should be used when Close() is called from an event handler
Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

 

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

Overrides: object.__init__

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

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

 

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

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

FormToPySideWidget(form, 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 QtGui module

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

OnClose(self, form)

 

Called when the plugin form is closed

Returns:
None

Close(self, options)

 

Closes the form.

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