TGIS_ControlLegend class

Visual Legend component.

Available also on: Delphi FMX | .NET WinForms | Java | ActiveX | Python.

Syntax

// Delphi
type
  [ComponentPlatformsAttribute(pfidWindows)]
  TGIS_ControlLegend = class( TCustomControl, IGIS_LegendParent, IGIS_PrintableControl )
  end;

// C++ Builder
class PASCALIMPLEMENTATION TGIS_ControlLegend : public TCustomControl
{
};

Inheritance

→ TCustomControl

Implements

IGIS_LegendParent IGIS_PrintableControl

Constructors

Inherited Overrides Protected

	Name	Visibility	Description
	Create	public	Constructor, creates an instance.
	Destroy	public	Destructor, destroys the instance.

Methods

Inherited Overrides Protected

Name	Visibility	Description
Collapse(IGIS_HierarchyGroup)	public	Collapses a legend item corresponding to a hierarchy group.
Collapse(IGIS_HierarchyGroup; Boolean; Boolean)	public	Collapses a legend item corresponding to a hierarchy group.
Collapse(TGIS_Layer)	public	Collapses a legend item corresponding to a layer.
ControlClientHeight	protected	Gets client height. _{(Implements IGIS_LegendParent.ControlClientHeight)}
ControlClientWidth	protected	Gets client width. _{(Implements IGIS_LegendParent.ControlClientWidth)}
ControlDragCreateTemporaryContext	protected	Creates temporary context to avoid flickering. _{(Implements IGIS_LegendParent.ControlDragCreateTemporaryContext)}
ControlDragDrawBar	protected	Draws drag bar. _{(Implements IGIS_LegendParent.ControlDragDrawBar)}
ControlDragDrawNode	protected	Draws drag bitmap. _{(Implements IGIS_LegendParent.ControlDragDrawNode)}
ControlDragFreeNode	protected	Frees a node for dragging. _{(Implements IGIS_LegendParent.ControlDragFreeNode)}
ControlDragPrepareNode	protected	Draws a node for dragging. _{(Implements IGIS_LegendParent.ControlDragPrepareNode)}
ControlDragRenderTemporaryContext	protected	Renders temporary context and destroy it. _{(Implements IGIS_LegendParent.ControlDragRenderTemporaryContext)}
ControlDrawFromCache	protected	Draws cache. _{(Implements IGIS_LegendParent.ControlDrawFromCache)}
ControlDrawNode	protected	Draws a node. _{(Implements IGIS_LegendParent.ControlDrawNode)}
ControlFullUpdate	protected	Causes repaint of the entire control. _{(Implements IGIS_LegendParent.ControlFullUpdate)}
ControlGetHScrollPosition	protected	Gets horizontal scrollbar position. _{(Implements IGIS_LegendParent.ControlGetHScrollPosition)}
ControlGetVScrollPosition	protected	Gets vertical scrollbar position. _{(Implements IGIS_LegendParent.ControlGetVScrollPosition)}
ControlHeight	protected	Gets control height. _{(Implements IGIS_LegendParent.ControlHeight)}
ControlIsDesignMode	protected	Checks if the control is in design mode. _{(Implements IGIS_LegendParent.ControlIsDesignMode)}
ControlRenderer	protected	Gets renderer instance. _{(Implements IGIS_LegendParent.ControlRenderer)}
ControlRepaint	protected	Repaints the control. _{(Implements IGIS_LegendParent.ControlRepaint)}
ControlRightToLeft	protected	Checks if the control is in 'right to left' mode. _{(Implements IGIS_LegendParent.ControlRightToLeft)}
ControlSetHScroll	protected	Sets horizontal scrollbar range & position. _{(Implements IGIS_LegendParent.ControlSetHScroll)}
ControlSetHScrollPosition	protected	Sets horizontal scrollbar position. _{(Implements IGIS_LegendParent.ControlSetHScrollPosition)}
ControlSetVScroll	protected	Sets vertical scrollbar range & position. _{(Implements IGIS_LegendParent.ControlSetVScroll)}
ControlSetVScrollPosition	protected	Sets vertical scrollbar position. _{(Implements IGIS_LegendParent.ControlSetVScrollPosition)}
ControlStyleCreateTemporaryContext	protected	Creates temporary context. _{(Implements IGIS_LegendParent.ControlStyleCreateTemporaryContext)}
ControlStyleDrawCheckBox	protected	Draws a check box. _{(Implements IGIS_LegendParent.ControlStyleDrawCheckBox)}
ControlStyleDrawExpandCollapseMarker	protected	Draws an expand/collapse marker. _{(Implements IGIS_LegendParent.ControlStyleDrawExpandCollapseMarker)}
ControlStyleDrawImage	protected	Draws image on temporary context. _{(Implements IGIS_LegendParent.ControlStyleDrawImage)}
ControlStyleDrawRectangle(Integer; Integer; Integer; Integer; TGIS_Color; TGIS_Color)	protected	Draws a rectangle. _{(Implements IGIS_LegendParent.ControlStyleDrawRectangle)}
ControlStyleDrawRectangle(TRect)	protected	Draws a rectangle. _{(Implements IGIS_LegendParent.ControlStyleDrawRectangle)}
ControlStyleDrawText	protected	Draws text. _{(Implements IGIS_LegendParent.ControlStyleDrawText)}
ControlStyleGetColor	protected	Gets background color. _{(Implements IGIS_LegendParent.ControlStyleGetColor)}
ControlStyleGetTextExtent	protected	Gets text extent. _{(Implements IGIS_LegendParent.ControlStyleGetTextExtent)}
ControlStyleRenderTemporaryContext	protected	Renders temporary context and destroy it. _{(Implements IGIS_LegendParent.ControlStyleRenderTemporaryContext)}
ControlStyleSetColor	protected	Sets background color. _{(Implements IGIS_LegendParent.ControlStyleSetColor)}
ControlSubscribedUpdate	protected	Does subscribed update. _{(Implements IGIS_LegendParent.ControlSubscribedUpdate)}
ControlTouch	protected	Passes the touch event context. _{(Implements IGIS_LegendParent.ControlTouch)}
ControlUpdate	protected	Does update. _{(Implements IGIS_LegendParent.ControlUpdate)}
ControlWidth	protected	Gets control width. _{(Implements IGIS_LegendParent.ControlWidth)}
CreateCopy	public	Prepare a copy of the control for printing. _{(Implements IGIS_PrintableControl.CreateCopy)}
CreateParams	protected	Startup parameter overriding.
Delete	protected	Overrides the default Delete method.
DrawBmp	public	Draw control on a provided bitmap.
Expand(IGIS_HierarchyGroup)	public	Expands of a legend item associated with the specific hierarchy group.
Expand(IGIS_HierarchyGroup; Boolean; Boolean)	public	Expands a legend item corresponding to a hierarchy group.
Expand(TGIS_Layer)	public	Expands a legend item associated with the specific layer.
FreeCopy	public	Release the copy of the control. _{(Implements IGIS_PrintableControl.FreeCopy)}
GetNodeAt	public	Retrieves the node at a given position.
InvalidateItems	public	Forces invalidation of all the legend items.
IsExpanded(IGIS_HierarchyGroup)	public	Checks if the legend item is associated with the specific hierarchy group is expanded.
IsExpanded(TGIS_Layer)	public	Checks if the legend item is associated with the specific layer is expanded.
KeyDown	protected	Overrides the default KeyDown event behavior.
MouseDown	protected	Overrides the default MouseDown event behavior.
MouseMove	protected	Overrides the default MouseMove event behaviour.
MouseUp	protected	Overrides the default MouseUp event behaviour.
Paint	protected
PrintBmp	public	Print the control on the given bitmap. _{(Implements IGIS_PrintableControl.PrintBmp)}
PrintClipboard	public	Prints the current state of the legend to the clipboard as a bitmap.
Repaint	public
Resize	protected
SetBiDiMode	protected
TapDouble	protected	Event handler of the double tap action.
TapLong	protected	Event handler of the long tap action.
TapSingle	protected	Event handler of the single tap action.

Properties

Inherited Protected

Name	Visibility	Description
Align	published	See documentation for TCustomControl in Delphi help.
Anchors	published	See documentation for TCustomControl in Delphi help.
BiDiMode	published	See documentation for TCustomControl in Delphi help.
BiDiModeFromTranslation	published	Defines which BiDi we are using: the one from property or the one from translation
BorderStyle	published	Border style for component windows.
Color	published	See documentation for TCustomControl in Delphi help.
CompactView	published	If True then the legend view is compacted - icons are smaller.
Ctl3D	published	See documentation for TCustomControl in Delphi help.
DialogOptions	published	Options defining dialogs behavior.
DrawIconStyle	published	Draw style of legend icons.
Enabled	published	See documentation for TCustomControl in Delphi help.
Font	published	See documentation for TCustomControl in Delphi help.
GIS_Group	public	Selected group.
GIS_Layer	public	Selected layer.
GIS_Layers	public	Selected layers.
GIS_Viewer	published	Attached IGIS_Viewer object.
HelpContext	published	See documentation for TCustomControl in Delphi help.
Hint	published	See documentation for TCustomControl in Delphi help.
InternalName	public	Used for internal use of TatukGIS. _{(Implements IGIS_PrintableControl.InternalName)}
Mode	published	Mode of the legend - list of layers or grouped tree view.
Options	published	Options of the legend.
ParentBiDiMode	published	See documentation for TCustomControl in Delphi help.
ParentColor	published	See documentation for TCustomControl in Delphi help.
ParentCtl3D	published	See documentation for TCustomControl in Delphi help.
ParentFont	published	See documentation for TCustomControl in Delphi help.
ParentShowHint	published	See documentation for TCustomControl in Delphi help.
PopupMenu	published	See documentation for TCustomControl in Delphi help.
ReverseOrder	published	True if the order of legend entries in the Layer mode should be reverse, i.e.
SelectedNode	public	Selected node.
SelectionColor	published	Selected item color backround.
SelectionFontColor	published	Selected item font color.
StyleElements	published	See documentation for TCustomControl in Delphi help.
TabOrder	published	See documentation for TCustomControl in Delphi help.
TabStop	published	See documentation for TCustomControl in Delphi help.
Touch	published	See documentation for TCustomControl in Delphi help.
Visible	published	See documentation for TCustomControl in Delphi help.

Events

Inherited Protected

Name	Visibility	Description
GroupActiveChangeEvent	published	Event fired when a group is activated/deactivated.
GroupSelectEvent	published	Event fired upon group selection.
LayerActiveChangeEvent	published	Event fired when a layer is activated/deactivated.
LayerParamsChangeEvent	published	Event fired when a layer parameters get changed.
LayerSelectEvent	published	Event fired upon layer selection.
OnClick	published	See documentation for TCustomControl in Delphi help.
OnDblClick	published	See documentation for TCustomControl in Delphi help.
OnDragDrop	published	See documentation for TCustomControl in Delphi help.
OnDragOver	published	See documentation for TCustomControl in Delphi help.
OnEndDrag	published	See documentation for TCustomControl in Delphi help.
OnEnter	published	See documentation for TCustomControl in Delphi help.
OnExit	published	See documentation for TCustomControl in Delphi help.
OnGesture	published	See documentation for TCustomControl in Delphi help.
OnKeyDown	published	See documentation for TCustomControl in Delphi help.
OnKeyPress	published	See documentation for TCustomControl in Delphi help.
OnKeyUp	published	See documentation for TCustomControl in Delphi help.
OnMouseDown	published	See documentation for TCustomControl in Delphi help.
OnMouseMove	published	See documentation for TCustomControl in Delphi help.
OnMouseUp	published	See documentation for TCustomControl in Delphi help.
OnMouseWheel	published	See documentation for TCustomControl in Delphi help.
OnMouseWheelDown	published	See documentation for TCustomControl in Delphi help.
OnMouseWheelUp	published	See documentation for TCustomControl in Delphi help.
OnResize	published	Standard VCL event.
OnStartDrag	published	See documentation for TCustomControl in Delphi help.
OpenDialogEvent	published	Event fired upon opening of the layer properties dialog box.
OrderChangeEvent	published	Event fired upon a change of the order of layers.
TapDoubleEvent	published	TapDouble event.
TapLongEvent	published	TapLong event.
TapSimpleEvent	published	TapSimple event.

Remarks

Place this component on a form and connect GIS_Viewer to IGIS_Viewer object. Selected layer is available via GIS_Layer property.

Available metadata keys :

Metadata	Values	Default	Description
TGIS_Legend.DefHeight	size in pixels at 96 dpi	16	Default item height. Recalculated based on Font Size
TGIS_Legend.DefHeight16	size in pixels at 96 dpi	16	Default item height.
TGIS_Legend.DefLayerIconSize	size in pixels at 96 dpi	24	Default layer icon size.
TGIS_Legend.DefBmpSize	size in pixels at 96 dpi	28	Default size of bitmap[ used to present layer styles.

TatukGIS Developer Kernel

Table of Contents

TGIS_ControlLegend class

Syntax

Inheritance

Implements

Constructors

Methods

Properties

Events

Remarks

TatukGIS Developer Kernel

User Tools

Site Tools

Table of Contents

TGIS_ControlLegend class

Syntax

Inheritance

Implements

Constructors

Methods

Properties

Events

Remarks

Page Tools