Trees       Indices       Help   
IDAPython Reference
Module idaapi :: 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 x.__class__.__doc__ 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__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Static Methods
 
FormToPyQtWidget(form, ctx=sys.modules ['__main__'])
Use this method to convert a TForm* to a QWidget to be used by PyQt
 
FormToPySideWidget(form, ctx=sys.modules ['__main__'])
Use this method to convert a TForm* to a QWidget to be used by PySide
Class Variables
  FORM_MDI = 0x01
start by default as MDI
  FORM_TAB = 0x02
attached by default to a tab
  FORM_RESTORE = 0x04
restore state from desktop config
  FORM_ONTOP = 0x08
form should be "ontop
  FORM_MENU = 0x10
form must be listed in the windows menu (automatically set for all plugins)
  FORM_CENTERED = 0x20
form will be centered on the screen
  FORM_PERSIST = 0x40
form will persist until explicitly closed with Close()
  FORM_SAVE = 0x1
save state in desktop config
  FORM_NO_CONTEXT = 0x2
don't change the current context (useful for toolbars)
  FORM_DONT_SAVE_SIZE = 0x4
don't save size of the window
Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ 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.FORM_ constants

FormToPyQtWidget(form, ctx=sys.modules ['__main__'])
Static Method

 

Use this method to convert a TForm* 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=sys.modules ['__main__'])
Static Method

 

Use this method to convert a TForm* 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 (FORM_SAVE, FORM_NO_CONTEXT, ...)
Returns:
None

   Trees       Indices       Help   
IDAPython Reference
Generated by Epydoc 3.0.1 on Thu Apr 21 16:32:00 2011 http://epydoc.sourceforge.net