INIXApp Namespace Reference

Defines the ResourceInstance class that implements most of the main functionality of INIXApp, as well as a few helper functions for use by scripts in INIXApp resources. More...

Classes
class	ResourceInstance
	Represents a resource and manages its state. More...

Functions
def	GetResourceInstance
	Get the ResourceInstance object for a given index path. More...
def	AddKeyboardEquivalent
	Add a keyboard equivalent to the command menu item aCommandIndexPath, owned by resource aResourceIndexPath. More...
def	ShowOutwinAndExecProg
	Run an external command, displaying its output in the status bar. More...
def	StatusPost
	Post a status message on the INIXApp status bar. More...
def	StatusUpdate
	Update a status message on the INIXApp status bar. More...
def	StatusClear
	Mark a status message on the INIXApp status bar as invalid. More...
def	ResourceStart
	Trampoline code for resources' commands.py. More...

Detailed Description

Defines the ResourceInstance class that implements most of the main functionality of INIXApp, as well as a few helper functions for use by scripts in INIXApp resources.

Function Documentation

def INIXApp.AddKeyboardEquivalent	(		aKeyEquiv,
			aCommandIndexPath,
			aResourceIndexPath
	)

Add a keyboard equivalent to the command menu item aCommandIndexPath, owned by resource aResourceIndexPath.

aKeyEquiv has the form ["global "]["ctrl-"]["alt-"]<key> (case-insensitive), where <key> is a key name recognized by the HotKey service plugin.

def INIXApp.GetResourceInstance

(

aIndexPath

)

Get the ResourceInstance object for a given index path.

Exceptions

KeyError

if there is no resource with the given index path

def INIXApp.ResourceStart	(		aArgs,
			aFuncs
	)

Trampoline code for resources' commands.py.

Deprecated:

Should not be necessary anymore since commands.py is gone. Please report if you think it's still useful.

def INIXApp.ShowOutwinAndExecProg	(		aCmd,
			aParams
	)

Run an external command, displaying its output in the status bar.

aCmd is the program, aParams is either a string in shell notation (spaces etc. in arguments properly escaped) or a list of raw arguments. (The misleading function name is of historical origin.)

def INIXApp.StatusClear

(

aChannel

)

Mark a status message on the INIXApp status bar as invalid.

See StatusPost() and Services.StatusClear.

def INIXApp.StatusPost	(		aMessage,
			aLevel = LEVEL_INFO,
			aChannel = 0,
			aAcknowledgementOptions = ""
	)

Post a status message on the INIXApp status bar.

See Services.StatusPost in the Statusbar plugin documentation for details. Symbolic names are provided for aLevel: LEVEL_FATAL, LEVEL_PROGRESS, LEVEL_ERROR, LEVEL_WARNING, LEVEL_INFO.

def INIXApp.StatusUpdate	(		aMessage,
			aLevel = LEVEL_INFO,
			aChannel = 0,
			aAcknowledgementOptions = ""
	)

Update a status message on the INIXApp status bar.

See StatusPost() and Services.StatusUpdate.