NanoByte Structure Editor
Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
NanoByte.StructureEditor.Node Class Referenceabstract

Describes a specific node in the structure. More...

Inheritance diagram for NanoByte.StructureEditor.Node:
NanoByte.StructureEditor.ListElementNode< TContainer, TList, TElement, TEditor > NanoByte.StructureEditor.PropertyNode< TContainer, TProperty, TEditor >

Public Member Functions

override string ToString ()
 
abstract string GetSerialized ()
 Returns a serialized representation of the Target. More...
 
abstract IValueCommand GetUpdateCommand (string serializedValue)
 Gets a command for updating the node's target with a new value. More...
 
abstract IUndoCommand GetRemoveCommand ()
 Gets a command for removing the node's target from the structure. More...
 
abstract INodeEditor GetEditorControl (ICommandExecutor executor)
 Gets a GUI control for editing the node's target. More...
 

Static Public Member Functions

static string GetDescription< T > ()
 Gets the DescriptionAttribute.Description of T , if any. More...
 

Protected Member Functions

 Node (string nodeType, string description, object target)
 Creates a new node. More...
 

Properties

string NodeType [get]
 The name of the node type. More...
 
string Description [get]
 A description of the node type. More...
 
object Target [get]
 The object the node represents. More...
 

Detailed Description

Describes a specific node in the structure.

Constructor & Destructor Documentation

◆ Node()

NanoByte.StructureEditor.Node.Node ( string  nodeType,
string  description,
object  target 
)
inlineprotected

Creates a new node.

Parameters
nodeTypeThe name of the node type.
descriptionA description of the node type.
targetThe object the node represents.

Member Function Documentation

◆ GetDescription< T >()

static string NanoByte.StructureEditor.Node.GetDescription< T > ( )
static

Gets the DescriptionAttribute.Description of T , if any.

◆ GetEditorControl()

abstract INodeEditor NanoByte.StructureEditor.Node.GetEditorControl ( ICommandExecutor  executor)
pure virtual

Gets a GUI control for editing the node's target.

Parameters
executorUsed to perform undo/redo operations.

Implemented in NanoByte.StructureEditor.ListElementNode< TContainer, TList, TElement, TEditor >, and NanoByte.StructureEditor.PropertyNode< TContainer, TProperty, TEditor >.

◆ GetRemoveCommand()

abstract IUndoCommand NanoByte.StructureEditor.Node.GetRemoveCommand ( )
pure virtual

◆ GetSerialized()

abstract string NanoByte.StructureEditor.Node.GetSerialized ( )
pure virtual

◆ GetUpdateCommand()

abstract IValueCommand NanoByte.StructureEditor.Node.GetUpdateCommand ( string  serializedValue)
pure virtual

Gets a command for updating the node's target with a new value.

Parameters
serializedValueA serialized representation of the new value.

Implemented in NanoByte.StructureEditor.ListElementNode< TContainer, TList, TElement, TEditor >, and NanoByte.StructureEditor.PropertyNode< TContainer, TProperty, TEditor >.

Property Documentation

◆ Description

string NanoByte.StructureEditor.Node.Description
get

A description of the node type.

◆ NodeType

string NanoByte.StructureEditor.Node.NodeType
get

The name of the node type.

◆ Target

object NanoByte.StructureEditor.Node.Target
get

The object the node represents.


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