Model Railroad System  2.2.1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CTCPanel::SchLabel Class Reference

Schematic Label object type. More...

Public Member Functions

 SchLabel (name, _ctcpanel, _canvas,...)
 Construct a Label object. More...
 
 ~SchLabel ()
 Clean up all data objects and free up all resources. More...
 
 getv ()
 Method to get our value (none). More...
 
 setv (state)
 Method to set out value (level position). More...
 
 geti (ind)
 Method to get the state of one of our indicators (none). More...
 
 seti (ind, value)
 Method to set an indicator's state (none). More...
 
 invoke ()
 Method to invoke the label. More...
 

Private Member Functions

 _configureColor (option, value)
 Method to update the color of the label. More...
 
 _configureLabel (option, value)
 Method to update the label option. More...
 

Private Attributes

 ctcpanel
 The CTC Panel component (parent widget). More...
 
 canvas
 The canvas component (parent widget component). More...
 

Detailed Description

Schematic Label object type.

These are on the schematic and represent a label on the Schematic.

Parameters
_ctcpanelThe CTCPanel megawidget.
_canvasThe schematic canvas to draw the label on.
...Options:
  • -x The x coordinate of the object (readonly, default 0).
  • -y The y coordinate of the object (readonly, default 0).
  • -controlpoint The name of the control point this label is part of (readonly, default CP1).
  • -color The color of the label (default white).
  • -label The label of the label (default "").
Defined coords terminals: none. Defined values (states): none. Defined indicators: none.
Author
Robert Heller <heller@deepsoft.com>

Constructor & Destructor Documentation

◆ SchLabel()

CTCPanel::SchLabel::SchLabel ( name  ,
_ctcpanel  ,
_canvas  ,
  ... 
)

Construct a Label object.

Parameters
_ctcpanelThe CTCPanel megawidget.
_canvasThe schematic canvas to draw the SchLabel on.
...Option list.

◆ ~SchLabel()

CTCPanel::SchLabel::~SchLabel ( )

Clean up all data objects and free up all resources.

Member Function Documentation

◆ _configureColor()

CTCPanel::SchLabel::_configureColor ( option  ,
value   
)
private

Method to update the color of the label.

◆ _configureLabel()

CTCPanel::SchLabel::_configureLabel ( option  ,
value   
)
private

Method to update the label option.

◆ geti()

CTCPanel::SchLabel::geti ( ind  )

Method to get the state of one of our indicators (none).

◆ getv()

CTCPanel::SchLabel::getv ( )

Method to get our value (none).

◆ invoke()

CTCPanel::SchLabel::invoke ( )

Method to invoke the label.

◆ seti()

CTCPanel::SchLabel::seti ( ind  ,
value   
)

Method to set an indicator's state (none).

◆ setv()

CTCPanel::SchLabel::setv ( state  )

Method to set out value (level position).

Member Data Documentation

◆ canvas

CTCPanel::SchLabel::canvas
private

The canvas component (parent widget component).

◆ ctcpanel

CTCPanel::SchLabel::ctcpanel
private

The CTC Panel component (parent widget).