Uranium
Application Framework
UM.Settings.SettingRelation.SettingRelation Class Reference

Public Member Functions

def __init__
 
def __hash__ (self)
 
def owner (self)
 
def target (self)
 
def type (self)
 
def role (self)
 
def __repr__ (self)
 

Detailed Description

A representation of a relationship between two settings.

This is a simple class representing a relationship between two settings.
One of the settings is the "owner", which means it contains the setting, the other
setting is the "target", the setting the relation is pointing at. Relations
have a type and a role. The type determines in what direction this relation is,
the role what property it is used for.

:note SettingRelation objects are usually created by DefinitionContainer after
constructing SettingDefinition objects.

Member Function Documentation

def UM.Settings.SettingRelation.SettingRelation.__hash__ (   self)
Ensure that the SettingRelation is hashable, so it can be used in a set.
def UM.Settings.SettingRelation.SettingRelation.owner (   self,
  SettingDefinition 
)
The owner of this relation.
def UM.Settings.SettingRelation.SettingRelation.role (   self,
  str 
)
The role of this relation.
def UM.Settings.SettingRelation.SettingRelation.target (   self,
  SettingDefinition 
)
The setting that this relation is relating with.
def UM.Settings.SettingRelation.SettingRelation.type (   self,
  RelationType 
)
The type of this relation.

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