Commands.Command Class Reference

No documentation available. More...

Inheritance diagram for Commands.Command:

Methods defined here:
def	Invoke
def	__call__
def	__init__
def	__reduce__

Data descriptors defined here:
def	altText
	This is a user displayable text string.
def	commandText
	This is a user displayable text string.
def	icon

Data and other attributes defined here:
int	__instance_size__ = 40

Methods inherited from GroupNode:
def	getUniqueID
def	is_available

Data descriptors inherited from GroupNode:
def	parent

Data descriptors inherited from Boost.Python.instance:
def	__dict__
def	__weakref__

Data and other attributes inherited from Boost.Python.instance:
def	__new__

Additional Inherited Members
Public Member Functions inherited from Commands.GroupNode
def	__init__

Detailed Description

No documentation available.

Method resolution order

Command
GroupNode
Boost.Python.instance
builtin.object

Constructor & Destructor Documentation

def Commands.Command.__init__	(		arg1,
			operations,
			listings,
			icons,
			long_description,
			command_text,
			alt_text,
			documentation,
			clone,
			stations,
			type,
			class_instance_id = ''
	)

Returns

Instance of type None

     C++ signature :
         void __init__(_object*,Alloy::Commands::OperationClass,Alloy::Commands::Listing,Alloy::Pointer::Pointer<Alloy::Commands::IconSet>,char const*,char const*,char const*,char const*,bool,Alloy::Commands::Station,Alloy::Commands::CommandType [,std::string=''])

Member Function Documentation

def Commands.Command.__call__

(

arg1

)

Returns

Instance of type None

     C++ signature :
         void __call__(Alloy::Commands::Command {lvalue})
 
     Run this command by calling this object.
 
     C++ signature :
         void __call__(Alloy::Commands::Command {lvalue},Alloy::Pointer::Pointer<Alloy::Commands::CmdArgs>)

Note

Additional signature: call( (Command)arg1, (CmdArgs)arg2) -> None

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.__dict__

(

args

)

Reimplemented from Commands.GroupNode.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.__new__

(

args

)

T.__new__(S, ...) -> a new object with type S, a subtype of T

 __new__ = <built-in method __new__ of Boost.Python.class object>

Reimplemented from Commands.GroupNode.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.__reduce__

(

args

)

 __reduce__ = <unnamed Boost.Python function>(args)

Reimplemented from Commands.GroupNode.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.__weakref__

(

args

)

Reimplemented from Commands.GroupNode.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.altText

(

args

)

This is a user displayable text string.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.commandText

(

args

)

This is a user displayable text string.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.getUniqueID

(

arg1

)

Returns

Instance of type str

     C++ signature :
         std::string getUniqueID(Alloy::Commands::GroupNode {lvalue})
 
 
     C++ signature :
         void getUniqueID(Alloy::Pointer::HeldPointer<GroupNodeWrap> {lvalue})

Note

Additional signature: getUniqueID( (GroupNode)arg1) -> None

Reimplemented from Commands.GroupNode.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.icon

(

args

)

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.Invoke	(		arg1,
			arg2
	)

Returns

Instance of type None

     Override this function in your classes, this will be called when the command is invoked/run
 
     C++ signature :
         void Invoke(Alloy::Commands::Command {lvalue},Alloy::Pointer::Pointer<Alloy::Commands::CmdArgs>)

def Commands.Command.is_available	(		arg1,
			arg2
	)

Returns

Instance of type bool

     C++ signature :
         bool is_available(Alloy::Commands::GroupNode {lvalue},Alloy::Commands::Listing)
 
 
     C++ signature :
         bool is_available(GroupNodeWrap {lvalue},Alloy::Commands::Listing)
 
     Returns true if this GroupNode is available for the given Station or Listing type.
 
     C++ signature :
         bool is_available(Alloy::Commands::GroupNode {lvalue},Alloy::Commands::Station)
 
 
     C++ signature :
         bool is_available(GroupNodeWrap {lvalue},Alloy::Commands::Station)

Note

Additional signature: is_available( (GroupNode)arg1, (Listing)arg2) -> bool

Additional signature: is_available( (GroupNode)arg1, (Station)arg2) -> bool

Additional signature: is_available( (GroupNode)arg1, (Station)arg2) -> bool

Reimplemented from Commands.GroupNode.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

def Commands.Command.parent

(

args

)

Reimplemented from Commands.GroupNode.

Reimplemented in PluginSetupTools.PluginSetupCommand, and component_tools.ComponentAddCommand.

Member Data Documentation

int Commands.Command.__instance_size__ = 40

staticprivate