LuciadCPillar C# 2023.1.04
Luciad.Layers.LayerListEvent Class Reference

An event object, describing a change in a LayerList instance. More...

Public Types

enum  Type { Added , Moved , Removed }
 The type of LayerListEvent. More...
 

Static Public Member Functions

static LayerListEvent Added (Layer layer, uint index)
 Returns a new event that indicates that a layer has been added to the LayerList. More...
 
static LayerListEvent Moved (Layer layer, uint oldIndex, uint newIndex)
 Returns a new event that indicates that a layer has been moved in the LayerList. More...
 
static LayerListEvent Removed (Layer layer, uint oldIndex)
 Returns a new event that indicates that a layer has been removed from the LayerList. More...
 

Properties

Type EventType [get]
 
Layer Layer [get]
 
uint? NewIndex [get]
 
uint? OldIndex [get]
 

Detailed Description

An event object, describing a change in a LayerList instance.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent.

Member Enumeration Documentation

◆ Type

The type of LayerListEvent.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent::Type.
Enumerator
Added 

When the layer list event is for a layer that is added.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent::Type::Added.
Moved 

When the layer list event is for a layer that is moved.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent::Type::Moved.
Removed 

When the layer list event is for a layer that is removed.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent::Type::Removed.

Member Function Documentation

◆ Added()

Luciad.Layers.LayerListEvent Luciad.Layers.LayerListEvent.Added ( Layer  layer,
uint  index 
)
inlinestatic

Returns a new event that indicates that a layer has been added to the LayerList.

layer

the layer that was added, must not be nullptr

index

the index if the layer in the LayerList

a new event that indicates that a layer has been added to the LayerList

luciad::NullArgumentException

when the layer is nullptr.

2021.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent::added.

◆ Moved()

Luciad.Layers.LayerListEvent Luciad.Layers.LayerListEvent.Moved ( Layer  layer,
uint  oldIndex,
uint  newIndex 
)
inlinestatic

Returns a new event that indicates that a layer has been moved in the LayerList.

layer

the layer that was moved, must not be nullptr

oldIndex

the previous index in the LayerList

newIndex

the new index in the LayerList

a new event that indicates that a layer has been moved in the LayerList

luciad::NullArgumentException

when the layer is nullptr.

2021.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent::moved.

◆ Removed()

Luciad.Layers.LayerListEvent Luciad.Layers.LayerListEvent.Removed ( Layer  layer,
uint  oldIndex 
)
inlinestatic

Returns a new event that indicates that a layer has been removed from the LayerList.

layer

the layer that was removed, must not be nullptr

oldIndex

the index of the layer in the LayerList before it was removed

a new event that indicates that a layer has been removed from the LayerList

luciad::NullArgumentException

when the layer is nullptr.

2021.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::LayerListEvent::removed.

Property Documentation

◆ EventType

Type Luciad.Layers.LayerListEvent.EventType
get

◆ Layer

Layer Luciad.Layers.LayerListEvent.Layer
get

◆ NewIndex

uint? Luciad.Layers.LayerListEvent.NewIndex
get

◆ OldIndex

uint? Luciad.Layers.LayerListEvent.OldIndex
get