mApplication.applicationInfoAbs.ApplicationInfo Class Reference

[ ABSTRACT CLASS ] - Class provides application information for applications. More...

Inheritance diagram for mApplication.applicationInfoAbs.ApplicationInfo:

Public Member Functions
def	__init__ (self)
	Constructor. More...
def	__str__ (self)
	String representation. More...
def	asStr (self)
	String representation. More...
def	asHTML (self)
	Get HTML string representation. More...
def	getParentApplicationsAsStr (self)
	Get parent applications as a string separated by comma. More...
def	getKeywordsAsStr (self)
	Get keywords as a string separated by comma. More...
def	getDeveloperUserNamesAsStr (self)
	Get developer user names as a string separated by comma. More...
def	getDeveloperEmailAddressesAsStr (self)
	Get developer email addresses as a string separated by comma. More...
def	getIconFileAbsolutePath (self)
	Get icon file absolute path used by this application. More...
def	getIcon (self)
	Get QIcon instance for the icon file used by this application. More...
def	getPixmap (self)
	Get QPixmap instance for the icon file used by this application. More...
PROPERTIES
def	package (self)
	Package class instance used by this class. More...
def	name (self)
	Name of the application. More...
def	versionMajor (self)
	Major version of the application. More...
def	versionMinor (self)
	Minor version of the application. More...
def	versionFix (self)
	Fix version of the application. More...
def	versionStr (self)
	Application version in "major.minor.fix" format. More...
def	windowTitle (self)
	Window title of the application. More...
def	isActive (self)
	Whether this application is active. More...
def	description (self)
	Description about the application. More...
def	iconFileName (self)
	Icon file name used by the application. More...
def	usePlatformIcon (self)
	Use platform icon instead of N/A icon if no icon is provided for this application. More...
def	parentApplications (self)
	Parent applications which this application can run in. More...
def	keywords (self)
	Keywords to find this application. More...
def	isGUI (self)
	Whether this is a GUI application. More...
def	runAsPanelInNuke (self)
	Whether to run this application as panel in Nuke if its a GUI application. More...
def	documents (self)
	Documents of the application. More...
def	pythonCommand (self)
	Python command to run the application. More...
def	command (self)
	Terminal command to run the application. More...
def	fullMenuPath (self)
	Full menu path of the application if it appears in menus in parent application. More...
def	menuPath (self)
	Menu path of the application if it appears in menus in parent application. More...
def	menuSeparatorBefore (self)
	Add separator before this menu item. More...
def	menuSeparatorAfter (self)
	Add separator after this menu item. More...
def	developers (self)
	Developers worked on this application. More...

Static Public Member Functions
def	list (parentApplication=None, packageName=None, keyword=None, ignoreInactive=True)
	List all application info classes (applications) available in the packages. More...

Static Public Attributes
string	INFO_MODULE_FILE_BASE_NAME = 'applicationInfoLib'
	[ str ] - Name of the application info module (file) that contains information about each application available in the packages.

Detailed Description

[ ABSTRACT CLASS ] - Class provides application information for applications.

Constructor & Destructor Documentation

__init__()

def mApplication.applicationInfoAbs.ApplicationInfo.__init__

(

self

)

Constructor.

Exceptions

N/A

Returns

None - None.

Reimplemented in mMayaCore.referenceLibApp.ReloadSelectedNodes, mMayaNode.utilitiesApp.DeleteOnChannelBox, mMayaCore.referenceLibApp.RemoveSelectedNodes, mMayaNode.utilitiesApp.DeleteUnknownNodes, mMayaCore.referenceLibApp.DuplicateSelectedNodes, mMayaNode.utilitiesApp.DisplayNodeType, and mNukeCore.exampleLibApp.DisplayPythonPath.

Member Function Documentation

__str__()

def mApplication.applicationInfoAbs.ApplicationInfo.__str__

(

self

)

String representation.

Exceptions

N/A

Returns

str - String representation.

package()

def mApplication.applicationInfoAbs.ApplicationInfo.package

(

self

)

Package class instance used by this class.

Exceptions

N/A

Returns

mMecoPackage.packageLib.Package - Class instance.

name()

def mApplication.applicationInfoAbs.ApplicationInfo.name

(

self

)

Name of the application.

Exceptions

N/A

Returns

str - Name.

versionMajor()

def mApplication.applicationInfoAbs.ApplicationInfo.versionMajor

(

self

)

Major version of the application.

Exceptions

N/A

Returns

int - Value.

versionMinor()

def mApplication.applicationInfoAbs.ApplicationInfo.versionMinor

(

self

)

Minor version of the application.

Exceptions

N/A

Returns

int - Value.

versionFix()

def mApplication.applicationInfoAbs.ApplicationInfo.versionFix

(

self

)

Fix version of the application.

Exceptions

N/A

Returns

int - Value.

versionStr()

def mApplication.applicationInfoAbs.ApplicationInfo.versionStr

(

self

)

Application version in "major.minor.fix" format.

Exceptions

N/A

Returns

str - Version.

windowTitle()

def mApplication.applicationInfoAbs.ApplicationInfo.windowTitle

(

self

)

Window title of the application.

Exceptions

N/A

Returns

str - Title.

isActive()

def mApplication.applicationInfoAbs.ApplicationInfo.isActive

(

self

)

Whether this application is active.

Exceptions

N/A

Returns

bool - Result.

description()

def mApplication.applicationInfoAbs.ApplicationInfo.description

(

self

)

Description about the application.

Exceptions

N/A

Returns

str - Description.

iconFileName()

def mApplication.applicationInfoAbs.ApplicationInfo.iconFileName

(

self

)

Icon file name used by the application.

Exceptions

N/A

Returns

str - Icon file name.

usePlatformIcon()

def mApplication.applicationInfoAbs.ApplicationInfo.usePlatformIcon

(

self

)

Use platform icon instead of N/A icon if no icon is provided for this application.

Exceptions

N/A

Returns

bool - Result.

parentApplications()

def mApplication.applicationInfoAbs.ApplicationInfo.parentApplications

(

self

)

Parent applications which this application can run in.

See also

mApplication.parentApplicationLib.Application

Exceptions

N/A

Returns

list of enum - Parent applications.

keywords()

def mApplication.applicationInfoAbs.ApplicationInfo.keywords

(

self

)

Keywords to find this application.

Exceptions

N/A

Returns

list of str - Keywords.

isGUI()

def mApplication.applicationInfoAbs.ApplicationInfo.isGUI

(

self

)

Whether this is a GUI application.

Exceptions

N/A

Returns

bool - Result.

runAsPanelInNuke()

def mApplication.applicationInfoAbs.ApplicationInfo.runAsPanelInNuke

(

self

)

Whether to run this application as panel in Nuke if its a GUI application.

Exceptions

N/A

Returns

bool - Result.

documents()

def mApplication.applicationInfoAbs.ApplicationInfo.documents

(

self

)

Documents of the application.

Exceptions

N/A

Returns

list of dict - Documentations, keys of dict instances are: title, url.

pythonCommand()

def mApplication.applicationInfoAbs.ApplicationInfo.pythonCommand

(

self

)

Python command to run the application.

Exceptions

N/A

Returns

str - Python command.

command()

def mApplication.applicationInfoAbs.ApplicationInfo.command

(

self

)

Terminal command to run the application.

Exceptions

N/A

Returns

str - Command.

fullMenuPath()

def mApplication.applicationInfoAbs.ApplicationInfo.fullMenuPath

(

self

)

Full menu path of the application if it appears in menus in parent application.

Exceptions

N/A

Returns

str - Full menu path.

menuPath()

def mApplication.applicationInfoAbs.ApplicationInfo.menuPath

(

self

)

Menu path of the application if it appears in menus in parent application.

Exceptions

N/A

Returns

str - Menu path.

menuSeparatorBefore()

def mApplication.applicationInfoAbs.ApplicationInfo.menuSeparatorBefore

(

self

)

Add separator before this menu item.

Exceptions

N/A

Returns

bool - Value.

menuSeparatorAfter()

def mApplication.applicationInfoAbs.ApplicationInfo.menuSeparatorAfter

(

self

)

Add separator after this menu item.

Exceptions

N/A

Returns

bool - Value.

developers()

def mApplication.applicationInfoAbs.ApplicationInfo.developers

(

self

)

Developers worked on this application.

Exceptions

N/A

Returns

list of dict - Developers, keys of dict instances are username, name, email, web.

asStr()

def mApplication.applicationInfoAbs.ApplicationInfo.asStr

(

self

)

String representation.

Exceptions

N/A

Returns

str - Information about the application in human readable form.

asHTML()

def mApplication.applicationInfoAbs.ApplicationInfo.asHTML

(

self

)

Get HTML string representation.

This method provides information so it can be used on a GUI such as about dialog.

Exceptions

N/A

Returns

str - Information about the application in human readable form in HTML format.

getParentApplicationsAsStr()

def mApplication.applicationInfoAbs.ApplicationInfo.getParentApplicationsAsStr

(

self

)

Get parent applications as a string separated by comma.

An empty string returns if no parent application is set.

Exceptions

N/A

Returns

str - Parent applications.

getKeywordsAsStr()

def mApplication.applicationInfoAbs.ApplicationInfo.getKeywordsAsStr

(

self

)

Get keywords as a string separated by comma.

An empty string returns if no keyword is set.

Exceptions

N/A

Returns

str - Keywords.

getDeveloperUserNamesAsStr()

def mApplication.applicationInfoAbs.ApplicationInfo.getDeveloperUserNamesAsStr

(

self

)

Get developer user names as a string separated by comma.

An empty string returns if no developers is set.

Exceptions

N/A

Returns

str - Developer user names.

getDeveloperEmailAddressesAsStr()

def mApplication.applicationInfoAbs.ApplicationInfo.getDeveloperEmailAddressesAsStr

(

self

)

Get developer email addresses as a string separated by comma.

An empty string returns if no developers is set.

Exceptions

N/A

Returns

str - Developer email addresses.

getIconFileAbsolutePath()

def mApplication.applicationInfoAbs.ApplicationInfo.getIconFileAbsolutePath

(

self

)

Get icon file absolute path used by this application.

Exceptions

N/A

Returns

str - Absolute path of the icon file.

getIcon()

def mApplication.applicationInfoAbs.ApplicationInfo.getIcon

(

self

)

Get QIcon instance for the icon file used by this application.

Exceptions

N/A

Returns

QIcon - QIcon instance.

getPixmap()

def mApplication.applicationInfoAbs.ApplicationInfo.getPixmap

(

self

)

Get QPixmap instance for the icon file used by this application.

Exceptions

N/A

Returns

QPixmap - QPixmap instance.

list()

def mApplication.applicationInfoAbs.ApplicationInfo.list (   parentApplication = None,   packageName = None,   keyword = None,   ignoreInactive = True  )

static

List all application info classes (applications) available in the packages.

Parameters

parentApplication	[ str | None | in ] - Parent application name, which listed applications can be run in.
packageName	[ str | None | in ] - Name of the package, the applications will be list for.
keyword	[ str | None | in ] - Keyword to be searched.
ignoreInactive	[ bool | True | in ] - Ignore, therefore do not list inactive applications.

Exceptions

N/A

Returns

list of mApplication.applicationInfoAbs.ApplicationInfo - List of application info class instances.

---

The documentation for this class was generated from the following file:

• mApplication/python/mApplication/applicationInfoAbs.py