UserCustomization.UserCustomization Class Reference

#include <class_user_customization_1_1_user_customization.h>

List of all members.

Public Member Functions

  __init__ ()
  setInterface ()
  loadStatus ()
  getInfo ()
  Return the plug-in info, if it exists, default otherwise.
  getInstance ()
  Return an instance of the plug-in, calling instantiate() method.
  addAllCustomizations ()
  getPluginNames ()
  <?xml version="1.0" encoding="utf-8"?> <plugins> <plugin filename="C:/Location/SidedCustom.py" enabled="1"> <plugin filename="D:/Other/EmptyCustom.py" enabled="1"> </plugins>
  forceGetInfo ()
  Get the information for the module of the given filename, forcing the load if it isn't already.
  loadExplicit ()
  addCustomization ()
  Call loadCustomization, followed by addExtraCustomization.
  loadCustomization ()
  This method takes a name of the module to import.
  addExtraCustomization ()
  This method takes an already imported module.
  getCustomUi ()
  addInterpreter ()
  addExtraInterpreter ()
  Add an extra interpreter.
  appendManipulators ()
  appendMenu ()
  appendMenuItems ()
  appendMenuItemsNode ()
  appendSelectItems ()
  appendPopupMenuItems ()
  enableMenuStates ()
  resetMenuStates ()
  getDefaultImage ()
  getDefaultIcon ()
  uiWindowHookup ()
  inputDevices ()
  preload ()
  See if the specified script has a preload() method, and if it does, run it.

Public Attributes

string  kPlugins = "plugins.xml"
int  kStatusNotLoaded = 0
int  kStatusLoaded = 1
int  kStatusFailed = 2
int  kStatusNotFound = 3
int  kStatusPreloaded = 4
  myModulesPreloaded
  myModulesLoaded
  myModulesUserPrefsLoaded
  myModulesNotFound
  mySomeModuleFailed

Member Function Documentation

UserCustomization.UserCustomization.__init__ ( )
UserCustomization.UserCustomization.setInterface ( )
UserCustomization.UserCustomization.loadStatus ( )
UserCustomization.UserCustomization.getInfo ( )

Return the plug-in info, if it exists, default otherwise.

UserCustomization.UserCustomization.getInstance ( )

Return an instance of the plug-in, calling instantiate() method.

UserCustomization.UserCustomization.addAllCustomizations ( )
UserCustomization.UserCustomization.getPluginNames ( )

<?xml version="1.0" encoding="utf-8"?> <plugins> <plugin filename="C:/Location/SidedCustom.py" enabled="1"> <plugin filename="D:/Other/EmptyCustom.py" enabled="1"> </plugins>

UserCustomization.UserCustomization.forceGetInfo ( )

Get the information for the module of the given filename, forcing the load if it isn't already.

Return the module name, loaded status and the short description.

UserCustomization.UserCustomization.loadExplicit ( )
UserCustomization.UserCustomization.addCustomization ( )

Call loadCustomization, followed by addExtraCustomization.

UserCustomization.UserCustomization.loadCustomization ( )

This method takes a name of the module to import.

The location of it should be in the system path. The instantiate method is not called, the module is returned.

UserCustomization.UserCustomization.addExtraCustomization ( )

This method takes an already imported module.

An instantiate method will be called, and if successful, we will append it to the list of custom plug-ins.

UserCustomization.UserCustomization.getCustomUi ( )
UserCustomization.UserCustomization.addInterpreter ( )
UserCustomization.UserCustomization.addExtraInterpreter ( )

Add an extra interpreter.

UserCustomization.UserCustomization.appendManipulators ( )
UserCustomization.UserCustomization.appendMenu ( )
UserCustomization.UserCustomization.appendMenuItems ( )
UserCustomization.UserCustomization.appendMenuItemsNode ( )
UserCustomization.UserCustomization.appendSelectItems ( )
UserCustomization.UserCustomization.appendPopupMenuItems ( )
UserCustomization.UserCustomization.enableMenuStates ( )
UserCustomization.UserCustomization.resetMenuStates ( )
UserCustomization.UserCustomization.getDefaultImage ( )
UserCustomization.UserCustomization.getDefaultIcon ( )
UserCustomization.UserCustomization.uiWindowHookup ( )
UserCustomization.UserCustomization.inputDevices ( )
UserCustomization.UserCustomization.preload ( )

See if the specified script has a preload() method, and if it does, run it.

This gets called very early on, so you can add the custom modules before they get visited with all the UI, etc.


Member Data Documentation


UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization
UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization UserCustomization.UserCustomization