Maria GDK 4.5.0.137
Documentation of managed code in release branch
Loading...
Searching...
No Matches
TPG.GeoFramework.GridLayer.GridLayerViewModel Class Reference
Inheritance diagram for TPG.GeoFramework.GridLayer.GridLayerViewModel:
TPG.GeoFramework.Core.GeoLayerViewModel TPG.GeoFramework.GridLayer.Contracts.IGridLayerViewModel TPG.GeoFramework.Core.ViewModelBase TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase

Public Member Functions

 GridLayerViewModel (IGeoContext geoContext, IGeoNavigator geoNavigator, IGridLayerViewFactory gridLayerViewFactory)
 
override void HandleInputEvent (GeoInputEventArgs inputEventArgs)
 Called to forward events to the layer.
 
override void Update ()
 Event called at regular intervals to update contents of the layer.
 
override void Generate ()
 Requests that the layer generates it's view.
 
void PreExport ()
 Called before actual export is performed. The layer must ensure that state that changes the appearance of the layer is not altered.
 
void Export (Canvas canvas, IGeoContext geoContext, double targetDpi)
 The actual export function. Implementing classes should draw their content using the provided canvas and geo context.
Parameters
canvasThe canvas to draw into.
geoContextThe geo context relevant for this export.
targetDpiThe wanted dpi for the export.

 
void PostExport ()
 Called after export is performed. After this no more export functions will be called and the layer should go back to normal operation.
 
- Public Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel
 GeoLayerViewModel (IGeoContext geoContext, IGeoNavigator geoNavigator)
 
abstract void HandleInputEvent (GeoInputEventArgs inputEventArgs)
 Called to forward events to the layer.
 
virtual void Generate ()
 Requests that the layer generates it's view.
 
abstract void Update ()
 Event called at regular intervals to update contents of the layer.
 
virtual void SetDirty (bool isDirty)
 Sets a boolean value indicating the need for an update of the contents of a layer.
 
void SetDirty (object sender)
 Sets dirty flag and stores sender, use to avoid cyclic dirtying.
 
virtual bool IsDirty ()
 
- Public Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase
void Dispose ()
 Invoked when this object is being removed from the application and will be subject to garbage collection.
 
void HandleInputEvent (GeoInputEventArgs inputEventArgs)
 Called to forward events to the layer.
 
void Generate ()
 Requests that the layer generates it's view.
 
void Update ()
 Event called at regular intervals to update contents of the layer.
 
void SetDirty (bool isDirty)
 Sets a boolean value indicating the need for an update of the contents of a layer.
 
void SetDirty (object dirtySource)
 Sets dirty flag and stores sender, use to avoid cyclic dirtying.
 
bool IsDirty ()
 
void PreExport ()
 Called before actual export is performed. The layer must ensure that state that changes the appearance of the layer is not altered.
 
void Export (Canvas canvas, IGeoContext geoContext, double targetDpi)
 The actual export function. Implementing classes should draw their content using the provided canvas and geo context.
 
void PostExport ()
 Called after export is performed. After this no more export functions will be called and the layer should go back to normal operation.
 

Protected Member Functions

override void SetVisible (bool value)
 
- Protected Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel
virtual void SetVisible (bool value)
 
override void OnDispose (bool disposing)
 Make sure that all layers disconnect their shared GeoContexts.
 
- Protected Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase
virtual void OnDispose (bool disposing)
 Child classes can override this method to perform clean-up logic, such as removing event handlers.
 
void NotifyPropertyChanged< TProperty > (Expression< Func< TProperty > > property, INotifyPropertyChanged sender)
 
void NotifyPropertyChanged (string propertyName)
 
virtual void OnPropertyChanged ([CallerMemberName] string propertyName=null)
 

Properties

GridLayout GL [get, set]
 
ObservableCollection< IGridRendererGrids [get, set]
 Get or set grids.
 
- Properties inherited from TPG.GeoFramework.Core.GeoLayerViewModel
IGeoControlViewModel GeoControlViewModel [get, set]
 Get or set geo control view model.
 
UIElement Tooltip [get, set]
 Get or set tooltip UI element.
 
string Name [get]
 A name representing the type of layer.
 
bool Visible [get, set]
 Gets or sets the visibility of the layer.
 
IGeoContext GeoContext [get, set]
 Gets or sets the GeoContext related to the layer.
 
IGeoNavigator GeoNavigator [get, set]
 Gets or sets the GeoNavigator related to the GeoControl.
 
IGeoLayerViewFactory GeoLayerViewFactory [get, set]
 Gets a factory responsible for creating a IGeoLayerViewFactory view.
 
IGeoLayerView GeoLayerView [get, set]
 Gets or sets the view associated with this view model.
 
ClipMargins ClipMargins [get, set]
 Enables or disables clipping of the contents of the view, based on the specifed clip margins.
 
HashSet< object > DirtySources [get]
 All contributors to current dirty.
 
- Properties inherited from TPG.GeoFramework.Core.ViewModelBase
virtual string DisplayName [get, protected set]
 Returns the user-friendly name of this object. Child classes can set this property to a new value, or override it to determine the value on-demand.
 
- Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase
string DisplayName [get]
 
- Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
string Name [get]
 A name representing the type of layer.
 
bool Visible [get, set]
 Gets or sets the visibility of the layer.
 
IGeoContext GeoContext [get, set]
 Gets or sets the GeoContext related to the layer.
 
IGeoLayerViewFactory GeoLayerViewFactory [get]
 Gets a factory responsible for creating a IGeoLayerViewFactory view.
 
IGeoLayerView GeoLayerView [get, set]
 Gets or sets the view associated with this view model.
 
IGeoNavigator GeoNavigator [get, set]
 Gets or sets the GeoNavigator related to the GeoControl.
 
IGeoControlViewModel GeoControlViewModel [get, set]
 Get or set geo control view model.
 
ClipMargins ClipMargins [get, set]
 Enables or disables clipping of the contents of the view, based on the specifed clip margins.
 
HashSet< object > DirtySources [get]
 All contributors to current dirty.
 
UIElement Tooltip [get, set]
 Get or set tooltip UI element.
 
- Properties inherited from TPG.GeoFramework.GridLayer.Contracts.IGridLayerViewModel
GridLayout GL [get, set]
 
ObservableCollection< IGridRendererGrids [get, set]
 Get or set grids.
 

Events

new LayerChangedEventHandler LayerChanged = delegate { }
 
- Events inherited from TPG.GeoFramework.Core.GeoLayerViewModel
VisibleChangedEventHandler VisibleChanged = delegate { }
 
LayerChangedEventHandler LayerChanged = delegate { }
 
- Events inherited from TPG.GeoFramework.Core.ViewModelBase
PropertyChangedEventHandler PropertyChanged = delegate { }
 Raised when a property on this object has a new value.
 
- Events inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
VisibleChangedEventHandler VisibleChanged
 Visibility changed.
 
LayerChangedEventHandler LayerChanged
 Layer changed.
 

Additional Inherited Members

- Protected Attributes inherited from TPG.GeoFramework.Core.GeoLayerViewModel
string _name = null
 

Member Function Documentation

◆ Export()

void TPG.GeoFramework.GridLayer.GridLayerViewModel.Export ( Canvas  canvas,
IGeoContext  geoContext,
double  targetDpi 
)
inline

The actual export function. Implementing classes should draw their content using the provided canvas and geo context.

Parameters
canvasThe canvas to draw into.
geoContextThe geo context relevant for this export.
targetDpiThe wanted dpi for the export.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.

◆ Generate()

override void TPG.GeoFramework.GridLayer.GridLayerViewModel.Generate ( )
inlinevirtual

Requests that the layer generates it's view.

Reimplemented from TPG.GeoFramework.Core.GeoLayerViewModel.

◆ HandleInputEvent()

override void TPG.GeoFramework.GridLayer.GridLayerViewModel.HandleInputEvent ( GeoInputEventArgs  inputEventArgs)
inlinevirtual

Called to forward events to the layer.

Parameters
inputEventArgs

If the layer handles the event, it must set the Handled property to true.

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

◆ PostExport()

void TPG.GeoFramework.GridLayer.GridLayerViewModel.PostExport ( )
inline

Called after export is performed. After this no more export functions will be called and the layer should go back to normal operation.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.

◆ PreExport()

void TPG.GeoFramework.GridLayer.GridLayerViewModel.PreExport ( )
inline

Called before actual export is performed. The layer must ensure that state that changes the appearance of the layer is not altered.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.

◆ SetVisible()

override void TPG.GeoFramework.GridLayer.GridLayerViewModel.SetVisible ( bool  value)
inlineprotectedvirtual

◆ Update()

override void TPG.GeoFramework.GridLayer.GridLayerViewModel.Update ( )
inlinevirtual

Event called at regular intervals to update contents of the layer.

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

Property Documentation

◆ GL

GridLayout TPG.GeoFramework.GridLayer.GridLayerViewModel.GL
getset

◆ Grids

ObservableCollection<IGridRenderer> TPG.GeoFramework.GridLayer.GridLayerViewModel.Grids
getset

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