Stash Software API  2.0.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
sApplication.parentApplicationLib.Application Class Reference

[ ENUM CLASS ] - Application list. More...

Inheritance diagram for sApplication.parentApplicationLib.Application:
sCore.enumAbs.Enum

Public Member Functions

def listAttributes (cls, stringOnly=True, getValues=True, removeK=True, startAttrNamesLower=False)
 List static public attributes of the class. More...
 
- Public Member Functions inherited from sCore.enumAbs.Enum
def listAttributes (cls, stringOnly=True, getValues=True, removeK=True, startAttrNamesLower=False)
 List static public attributes of the class. More...
 
def listAttributeElements (cls, attribute)
 List elements of a static public attribute. More...
 
def getAttributeNameFromValue (cls, value, removeK=True, defaultAttributeName=None, startLower=False)
 Get the name of the attribute for given value. More...
 
def getValueFromAttributeName (cls, attribute, removeK=False, defaultValue=None)
 Get value from attribute name. More...
 
def asDict (cls, removeK=True)
 Get all the attributes and their values in a dict instance. More...
 

Static Public Member Functions

def getCurrent ()
 Get current parent application if any. More...
 

Static Public Attributes

string kAll = 'all'
 [ str ] - All applications. More...
 
string kHoudini = 'houdini'
 [ str ] - Houdini. More...
 
string kKatana = 'katana'
 [ str ] - Katana. More...
 
string kMari = 'mari'
 [ str ] - Mari. More...
 
string kMaya = 'maya'
 [ str ] - Maya. More...
 
string kNuke = 'nuke'
 [ str ] - Nuke. More...
 
string kPhotoshop = 'photoshop'
 [ str ] - Photoshop. More...
 
string kStandalone = 'standalone'
 [ str ] - Standalone. More...
 
string kZBrush = 'zbrush'
 [ str ] - ZBrush. More...
 

Detailed Description

[ ENUM CLASS ] - Application list.

Member Function Documentation

◆ listAttributes()

def sApplication.parentApplicationLib.Application.listAttributes (   cls,
  stringOnly = True,
  getValues = True,
  removeK = True,
  startAttrNamesLower = False 
)

List static public attributes of the class.

Parameters
cls[ object | None | in ] - Class object.
stringOnly[ bool | True | in ] - List attributes only with string values.
getValues[ bool | True | in ] - Get values of the attributes instead of their names.
removeK[ bool | True | in ] - Remove k character from the attribute names if getValues is provided False.
startAttrNamesLower[ bool | False | in ] - Start attribute names with lower case.
Exceptions
N/A
Returns
list of str - Names or values of the attributes.

◆ getCurrent()

def sApplication.parentApplicationLib.Application.getCurrent ( )
static

Get current parent application if any.

Exceptions
N/A
Returns
str - Name of the parent application from sApplication.parentApplication.Application enum class.

Member Data Documentation

◆ kAll

string sApplication.parentApplicationLib.Application.kAll = 'all'
static

[ str ] - All applications.

◆ kHoudini

string sApplication.parentApplicationLib.Application.kHoudini = 'houdini'
static

[ str ] - Houdini.

◆ kKatana

string sApplication.parentApplicationLib.Application.kKatana = 'katana'
static

[ str ] - Katana.

◆ kMari

string sApplication.parentApplicationLib.Application.kMari = 'mari'
static

[ str ] - Mari.

◆ kMaya

string sApplication.parentApplicationLib.Application.kMaya = 'maya'
static

[ str ] - Maya.

◆ kNuke

string sApplication.parentApplicationLib.Application.kNuke = 'nuke'
static

[ str ] - Nuke.

◆ kPhotoshop

string sApplication.parentApplicationLib.Application.kPhotoshop = 'photoshop'
static

[ str ] - Photoshop.

◆ kStandalone

string sApplication.parentApplicationLib.Application.kStandalone = 'standalone'
static

[ str ] - Standalone.

◆ kZBrush

string sApplication.parentApplicationLib.Application.kZBrush = 'zbrush'
static

[ str ] - ZBrush.


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