Substitutions

Usage¶

When you want to use an icon from QGIS in a rst document there is a big chance that there is allready a substitution defined in conf.py that can/should be used. When a new icon in QGIS is added it should be added first to conf.py before it is used in a rst document.

Below the icons and the Substitions defined in conf.py are given.

Common Substitutions¶

Can be used/found in many places in manuals

Platform Icons¶

Icon	Substitution
	`\|nix\|`
	`\|osx\|`
	`\|win\|`

Menu Items¶

Icon	Substitution	Icon	Substitution
	`\|checkbox\|`
	`\|checkbox_checked\|`		`\|checkbox_unchecked\|`
	`\|radiobuttonon\|`		`\|radiobuttonoff\|`
	`\|selectnumber\|`		`\|selectstring\|`
	`\|browsebutton\|`		`\|slider\|`
	`\|mIconDataDefine\|`

Words and symbols¶

Icon	Substitution
QGIS	`\|QG\|`
°	`\|degrees\|`

Icon	Substitution
	`\|selectcolor\|`
	`\|inputtext\|`
	`\|tab\|`

Toolbar Button Icons¶

Manage Layers and overview¶

Icon	Substitution	Icon	Substitution
	`\|mActionAddOgrLayer\|`		`\|mActionAddNonDbLayer\|`
	`\|mActionAddRasterLayer\|`		`\|mActionAddMssqlLayer\|`
	`\|mActionAddLayer\|`		`\|mActionAddSpatiaLiteLayer\|`
	`\|mActionNewVectorLayer\|`		`\|mActionRemoveLayer\|`
	`\|mActionAddWmsLayer\|`		`\|wfs\|`
	`\|icon_sqlanywhere\|`		`\|oracle_raster\|`
	`\|dbmanager\|`		`\|gdal\|`
	`\|mActionInOverview\|`		`\|mActionAddAllToOverview\|`
	`\|mActionRemoveAllFromOverview\|`		`\|RemoveAllOVerview\|`
	`\|mActionShowAllLayers\|`		`\|mActionHideAllLayers\|`
	`\|mActionShowPresets\|`		`\|mIconZip\|`

File¶

Icon	Substitution	Icon	Substitution
	`\|mActionFileNew\|`		`\|mActionFileOpen\|`
	`\|mActionFileSave\|`		`\|mActionFileSaveAs\|`
	`\|mActionFileExit\|`

Edit¶

Icon	Substitution	Icon	Substitution
	`\|mActionUndo\|`		`\|mActionRedo\|`
	`\|mActionSelect\|`		`\|mActionEditCut\|`
	`\|mActionEditCopy\|`		`\|mActionEditPaste\|`

Digitizing and Advanced Digitizing¶

Icon	Substitution	Icon	Substitution
	`\|mActionToggleEditing\|`		`\|mActionCapturePoint\|`
	`\|mActionCaptureLine\|`		`\|mActionCapturePolygon\|`
	`\|mActionNodeTool\|`		`\|mActionMoveFeature\|`
	`\|mActionDeleteSelected\|`		`\|mActionDeleteVertex\|`
	`\|mActionSimplify\|`		`\|mActionReshape\|`
	`\|mActionAddRing\|`		`\|mActionAddIsland\|`
	`\|mActionDeleteRing\|`		`\|mActionDeletePart\|`
	`\|mergeFeats\|`		`\|mActionMergeFeatures\|`
	`\|mActionSplitFeatures\|`		`\|mActionRotatePointSymbols\|`
	`\|mActionOffsetCurve\|`

Map Navigation and attributes¶

Icon	Substitution	Icon	Substitution
	`\|mActionPan\|`		`\|PanToSelected\|`
	`\|mActionZoomIn\|`		`\|mActionZoomOut\|`
	`\|mActionZoomFullExtent\|`		`\|mActionZoomToLayer\|`
	`\|mActionZoomLast\|`		`\|mActionZoomNext\|`
	`\|mActionDraw\|`		`\|mIconStopRendering\|`
	`\|mActionIdentify\|`		`\|mActionMapTips\|`
	`\|mActionShowBookmarks\|`		`\|mActionNewBookmark\|`
	`\|mActionMeasure\|`		`\|mActionMeasureArea\|`
	`\|mActionMeasureAngle\|`
	`\|mActionSelectRectangle\|`		`\|mActionSelectPolygon\|`
	`\|mActionSelectFreehand\|`		`\|mActionSelectRadius\|`
	`\|mActionDeselectAll\|`

labels¶

Icon	Substitution	Icon	Substitution
	`\|mActionLabeling\|`		`\|mActionTextAnnotation\|`
	`\|mActionAnnotation\|`		`\|mActionFormAnnotation\|`

help¶

Icon	Substitution	Icon	Substitution
	`\|mActionHelpContents\|`		`\|mActionQgisHomePage\|`
	`\|mActionCheckQgisVersion\|`		`\|mActionHelpAbout\|`
	`\|mActionHelpSponsors\|`		`\|mActionContextHelp\|`

Colors¶

Icon	Substitution	Icon	Substitution
	`\|mIconColorBox\|`		`\|mIconColorPicker\|`
	`\|mIconColorSwatches\|`		`\|mIconColorWheel\|`

Other basic icons¶

Icon	Substitution	Icon	Substitution
	`\|mActionProjectProperties\|`		`\|mActionOptions\|`
	`\|copyright_label\|`		`\|north_arrow\|`
	`\|scale_bar\|`		`\|locale\|`
	`\|gps_importer\|`		`\|gpstrack_barchart\|`
	`\|gpstrack_polarchart\|`		`\|tracking\|`
	`\|mActionFolder\|`

Attribute Table¶

Icon	Substitution	Icon	Substitution
	`\|mActionOpenTable\|`
	`\|mActionSelectedToTop\|`		`\|mActionInvertSelection\|`
	`\|mActionCopySelected\|`		`\|mActionZoomToSelected\|`
	`\|mActionNewAttribute\|`		`\|mActionDeleteAttribute\|`
	`\|mActionCalculateField\|`

Projections and Georeferencer¶

Icon	Substitution	Icon	Substitution
	`\|geographic\|`		`\|CRS\|`
	`\|mActionCustomProjection\|`		`\|mIconNew\|`
	`\|mIconProjectionDisabled\|`		`\|mIconProjectionEnabled\|`
	`\|georeferencer\|`		`\|pencil\|`
	`\|mActionLinkQGisToGeoref\|`		`\|mActionLinkGeorefToQGis\|`
	`\|coordinate_capture\|`		`\|mActionStartGeoref\|`

Composer Icons¶

Icons used in Composer:

Icon	Substitution	Icon	Substitution
	`\|mActionNewComposer\|`		`\|mActionComposerManager\|`
	`\|mActionSaveAsSVG\|`		`\|mActionSaveAsPDF\|`
	`\|mActionFilePrint\|`		`\|mActionSaveMapAsImage\|`
	`\|mActionAddArrow\|`		`\|mActionAddBasicShape\|`
	`\|mActionAddMap\|`		`\|mActionAddLegend\|`
	`\|mActionLabel\|`		`\|mActionScaleBar\|`
	`\|mActionSelectPan\|`		`\|mActionGroupItems\|`
	`\|mActionRaiseItems\|`		`\|mActionLowerItems\|`
	`\|mActionMoveItemContent\|`
	`\|mActionMoveItemsToTop\|`		`\|mActionMoveItemsToBottom\|`
	`\|mActionAlignLeft\|`		`\|mActionAlignRight\|`
	`\|mActionAlignHCenter\|`		`\|mActionAlignVCenter\|`
	`\|mActionAlignTop\|`		`\|mActionAlignBottom\|`
	`\|mIconLock\|`

Properties¶

Icons used in Layer Properties dialog:

Icon	Substitution	Icon	Substitution
	`\|symbology\|`		`\|labels\|`
	`\|attributes\|`		`\|general\|`
	`\|metadata\|`		`\|action\|`
	`\|join\|`		`\|diagram\|`

Plugin Icons¶

Core Plugin Icons¶

Standard provided with basic install, but not loaded with initial install

Icon	Substitution	Icon	Substitution
	`\|mActionShowPluginManager\|`		`\|plugin_installer\|`
	`\|offline_editing_copy\|`		`\|offline_editing_sync\|`
	`\|plugin\|`		`\|interpolation\|`
	`\|mapserver_export\|`		`\|mActionExportMapServer\|`
	`\|spiticon\|`		`\|delimited_text\|`
	`\|mActionGDALScript\|`		`\|dxf2shp_converter\|`
	`\|spatialquery\|`		`\|selectesubsetlayer\|`
	`\|selectcreatelayer\|`		`\|metasearch\|`

FTools Icons¶

Icon	Substitution	Icon	Substitution
	`\|ftools\|`
	`\|matrix\|`		`\|unique\|`
	`\|sum_lines\|`		`\|sum_points\|`
	`\|basic_statistics\|`		`\|neighbor\|`
	`\|mean\|`		`\|intersections\|`
	`\|random_selection\|`		`\|sub_selection\|`
	`\|random_points\|`
	`\|regular_points\|`		`\|vector_grid\|`
	`\|select_location\|`		`\|layer_extent\|`
	`\|convex_hull\|`		`\|buffer\|`
	`\|intersect\|`		`\|union\|`
	`\|sym_difference\|`		`\|clip\|`
	`\|difference\|`		`\|dissolve\|`
	`\|check_geometry\|`		`\|export_geometry\|`
	`\|delaunay\|`		`\|centroids\|`
	`\|simplify\|`		`\|join_location\|`
	`\|multi_to_single\|`		`\|single_to_multi\|`
	`\|to_lines\|`		`\|extract_nodes\|`
	`\|export_projection\|`		`\|define_projection\|`
	`\|split_layer\|`		`\|merge_shapes\|`

Grass integration¶

Icon	Substitution	Icon	Substitution
	`\|grass\|`
	`\|grass_new_mapset\|`		`\|grass_new_vector_layer\|`
	`\|grass_open_mapset\|`		`\|grass_close_mapset\|`
	`\|grass_add_vector\|`		`\|grass_add_raster\|`
	`\|grass_edit\|`		`\|grass_tools\|`
	`\|grass_region\|`		`\|grass_region_edit\|`
	`\|grass_new_point\|`		`\|grass_new_line\|`
	`\|grass_new_boundary\|`		`\|grass_new_centroid\|`
	`\|grass_move_vertex\|`		`\|grass_add_vertex\|`
	`\|grass_delete_vertex\|`		`\|grass_move_line\|`
	`\|grass_split_line\|`		`\|grass_delete_line\|`
	`\|grass_edit_attributes\|`		`\|grass_add_map\|`
	`\|grass_close_edit\|`		`\|grass_copy_map\|`
	`\|grass_rename_map\|`		`\|grass_delete_map\|`
	`\|grass_set_region\|`		`\|grass_refresh\|`

OpenStreetMap¶

Icon	Substitution	Icon	Substitution
	`\|osm_load\|`		`\|osm_download\|`
	`\|osm_featureManager\|`		`\|osm_identify\|`
	`\|osm_import\|`		`\|osm_save\|`
	`\|osm_createPoint\|`		`\|osm_createLine\|`
	`\|osm_createPolygon\|`
	`\|osm_move\|`		`\|osm_removeFeat\|`
	`\|osm_createRelation\|`		`\|osm_addRelation\|`
	`\|osm_editRelation\|`		`\|osm_generateTags\|`
	`\|osm_questionMark\|`

Raster related¶

Icon	Substitution	Icon	Substitution
	`\|fullCumulativeStretch\|`		`\|FullHistogramStretch\|`
	`\|ShowRasterCalculator\|`		`\|raster-stats\|`
	`\|raster-interpolate\|`		`\|raster-info\|`
	`\|raster_terrain\|`		`\|heatmap\|`

eVis plugin¶

Icon	Substitution	Icon	Substitution
	`\|event_browser\|`		`\|event_id\|`
	`\|evis_connect\|`		`\|evis_file\|`

Icon	Substitution
	`\|nix\|`
	`\|osx\|`
	`\|win\|`

Icon	Substitution	Icon	Substitution
	`\|checkbox\|`
	`\|checkbox_checked\|`		`\|checkbox_unchecked\|`
	`\|radiobuttonon\|`		`\|radiobuttonoff\|`
	`\|selectnumber\|`		`\|selectstring\|`
	`\|browsebutton\|`		`\|slider\|`
	`\|mIconDataDefine\|`

Icon	Substitution
	`\|selectcolor\|`
	`\|inputtext\|`
	`\|tab\|`

Icon	Substitution	Icon	Substitution
	`\|mActionAddOgrLayer\|`		`\|mActionAddNonDbLayer\|`
	`\|mActionAddRasterLayer\|`		`\|mActionAddMssqlLayer\|`
	`\|mActionAddLayer\|`		`\|mActionAddSpatiaLiteLayer\|`
	`\|mActionNewVectorLayer\|`		`\|mActionRemoveLayer\|`
	`\|mActionAddWmsLayer\|`		`\|wfs\|`
	`\|icon_sqlanywhere\|`		`\|oracle_raster\|`
	`\|dbmanager\|`		`\|gdal\|`
	`\|mActionInOverview\|`		`\|mActionAddAllToOverview\|`
	`\|mActionRemoveAllFromOverview\|`		`\|RemoveAllOVerview\|`
	`\|mActionShowAllLayers\|`		`\|mActionHideAllLayers\|`
	`\|mActionShowPresets\|`		`\|mIconZip\|`

Icon	Substitution	Icon	Substitution
	`\|mActionFileNew\|`		`\|mActionFileOpen\|`
	`\|mActionFileSave\|`		`\|mActionFileSaveAs\|`
	`\|mActionFileExit\|`

Table Of Contents

Substitutions¶