Skip to content

Commit

Permalink
* Docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Fr0sT-Brutal committed Oct 1, 2021
1 parent 4cf8855 commit 996ebb6
Show file tree
Hide file tree
Showing 10 changed files with 153 additions and 27 deletions.
4 changes: 3 additions & 1 deletion docs/autolink-excl
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ options
mapmarks
zoom
proxy
url
url
data
layer
2 changes: 1 addition & 1 deletion docs/docs/AllClasses.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.TMapMarkList.html">TMapMarkList</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>List of mapmarks</p></td>
<td class="itemdesc"><p>List of mapmarks.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.TNetworkRequestQueue.html">TNetworkRequestQueue</a></td>
Expand Down
10 changes: 10 additions & 0 deletions docs/docs/AllConstants.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,16 @@ <h1 class="allitems">All Constants</h1>
<td class="itemdesc"><p>Size of margin for labels on map, in pixels</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#LayersAll">LayersAll</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Constant containing all numbers of layers</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#LayersNone">LayersNone</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Constant containing no layers</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#ReqTimeout">ReqTimeout</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
<td class="itemdesc"><p>Timeout for connect and request</p></td>
Expand Down
34 changes: 27 additions & 7 deletions docs/docs/AllIdentifiers.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,12 @@ <h1 class="allitems">All Identifiers</h1>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GeoCoordsToMap">GeoCoordsToMap</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts geo rect in degrees to map rect in pixels</p></td>
<td class="itemdesc"><p>Converts geo point in degrees to map point in pixels</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GeoCoordsToMap">GeoCoordsToMap</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts geo point in degrees to map point in pixels</p></td>
<td class="itemdesc"><p>Converts geo rect in degrees to map rect in pixels</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GetScaleBarParams">GetScaleBarParams</a></td>
Expand All @@ -120,12 +120,12 @@ <h1 class="allitems">All Identifiers</h1>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#InMap">InMap</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Checks if rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code></p></td>
<td class="itemdesc"><p>Checks if point <code>Pt</code> is inside a map at zoom level <code>Zoom</code></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#InMap">InMap</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Checks if point <code>Pt</code> is inside a map at zoom level <code>Zoom</code></p></td>
<td class="itemdesc"><p>Checks if rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code></p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#LabelMargin">LabelMargin</a></td>
Expand All @@ -138,6 +138,16 @@ <h1 class="allitems">All Identifiers</h1>
<td class="itemdesc"><p>Converts geo coord in degrees to map coord in pixels</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#LayersAll">LayersAll</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Constant containing all numbers of layers</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#LayersNone">LayersNone</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Constant containing no layers</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#LongitudeToMapCoord">LongitudeToMapCoord</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts geo coord in degrees to map coord in pixels</p></td>
Expand All @@ -160,12 +170,12 @@ <h1 class="allitems">All Identifiers</h1>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapToGeoCoords">MapToGeoCoords</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts map point in pixels to geo point in degrees</p></td>
<td class="itemdesc"><p>Converts map rect in pixels to geo rect in degrees</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapToGeoCoords">MapToGeoCoords</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts map rect in pixels to geo rect in degrees</p></td>
<td class="itemdesc"><p>Converts map point in pixels to geo point in degrees</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapURLPostfix">MapURLPostfix</a></td>
Expand Down Expand Up @@ -333,6 +343,16 @@ <h1 class="allitems">All Identifiers</h1>
<td class="itemdesc"><p>Control displaying a map or its visible part.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#TMapLayer">TMapLayer</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Number of a layer</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#TMapLayers">TMapLayers</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.TMapMark.html">TMapMark</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Class representing a single mapmark.</p></td>
Expand Down Expand Up @@ -365,7 +385,7 @@ <h1 class="allitems">All Identifiers</h1>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.TMapMarkList.html">TMapMarkList</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>List of mapmarks</p></td>
<td class="itemdesc"><p>List of mapmarks.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#TMapMouseMode">TMapMouseMode</a></td>
Expand Down
10 changes: 10 additions & 0 deletions docs/docs/AllTypes.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@ <h1 class="allitems">All Types</h1>
<td class="itemdesc"><p>Capabilities that a network engine has</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#TMapLayer">TMapLayer</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Number of a layer</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#TMapLayers">TMapLayers</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#TMapMarkCustomProp">TMapMarkCustomProp</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Flags to indicate which properties must be taken from MapMark object when drawing.</p></td>
Expand Down
22 changes: 18 additions & 4 deletions docs/docs/OSM.MapControl.TMapControl.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,22 +159,26 @@ <h2 class="description">Description</h2>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnDrawTile">OnDrawTile</a></strong>: <a href="OSM.MapControl.html#TOnDrawTile">TOnDrawTile</a> read FOnDrawTile write FOnDrawTile;</code></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#VisibleLayers">VisibleLayers</a></strong>: <a href="OSM.MapControl.html#TMapLayers">TMapLayers</a> read FVisibleLayers write SetVisibleLayers;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnDrawTileLoading">OnDrawTileLoading</a></strong>: <a href="OSM.MapControl.html#TOnDrawTile">TOnDrawTile</a> read FOnDrawTileLoading write FOnDrawTileLoading;</code></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnDrawTile">OnDrawTile</a></strong>: <a href="OSM.MapControl.html#TOnDrawTile">TOnDrawTile</a> read FOnDrawTile write FOnDrawTile;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnZoomChanged">OnZoomChanged</a></strong>: TNotifyEvent read FOnZoomChanged write FOnZoomChanged;</code></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnDrawTileLoading">OnDrawTileLoading</a></strong>: <a href="OSM.MapControl.html#TOnDrawTile">TOnDrawTile</a> read FOnDrawTileLoading write FOnDrawTileLoading;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnDrawMapMark">OnDrawMapMark</a></strong>: <a href="OSM.MapControl.html#TOnDrawMapMark">TOnDrawMapMark</a> read FOnDrawMapMark write FOnDrawMapMark;</code></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnZoomChanged">OnZoomChanged</a></strong>: TNotifyEvent read FOnZoomChanged write FOnZoomChanged;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnDrawMapMark">OnDrawMapMark</a></strong>: <a href="OSM.MapControl.html#TOnDrawMapMark">TOnDrawMapMark</a> read FOnDrawMapMark write FOnDrawMapMark;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="OSM.MapControl.TMapControl.html#OnSelectionBox">OnSelectionBox</a></strong>: <a href="OSM.MapControl.html#TOnSelectionBox">TOnSelectionBox</a> read FOnSelectionBox write FOnSelectionBox;</code></td>
</tr>
</table>
Expand Down Expand Up @@ -498,6 +502,16 @@ <h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="VisibleLayers"></span><code>property <strong>VisibleLayers</strong>: <a href="OSM.MapControl.html#TMapLayers">TMapLayers</a> read FVisibleLayers write SetVisibleLayers;</code></td>
</tr>
<tr><td colspan="2">
<p>
Set of visible layers. You can use <a class="normal" href="OSM.MapControl.html#LayersAll">LayersAll</a> and <a class="normal" href="OSM.MapControl.html#LayersNone">LayersNone</a> constants</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="OnDrawTile"></span><code>property <strong>OnDrawTile</strong>: <a href="OSM.MapControl.html#TOnDrawTile">TOnDrawTile</a> read FOnDrawTile write FOnDrawTile;</code></td>
</tr>
<tr><td colspan="2">
Expand Down
36 changes: 29 additions & 7 deletions docs/docs/OSM.MapControl.TMapMark.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,22 @@ <h2 class="description">Description</h2>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#CustomProps">CustomProps</a></strong>: <a href="OSM.MapControl.html#TMapMarkCustomProps">TMapMarkCustomProps</a>;</code></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#Layer">Layer</a></strong>: <a href="OSM.MapControl.html#TMapLayer">TMapLayer</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#GlyphStyle">GlyphStyle</a></strong>: <a href="OSM.MapControl.TMapMarkGlyphStyle.html">TMapMarkGlyphStyle</a>;</code></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#CustomProps">CustomProps</a></strong>: <a href="OSM.MapControl.html#TMapMarkCustomProps">TMapMarkCustomProps</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#CaptionStyle">CaptionStyle</a></strong>: <a href="OSM.MapControl.TMapMarkCaptionStyle.html">TMapMarkCaptionStyle</a>;</code></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#GlyphStyle">GlyphStyle</a></strong>: <a href="OSM.MapControl.TMapMarkGlyphStyle.html">TMapMarkGlyphStyle</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#CaptionStyle">CaptionStyle</a></strong>: <a href="OSM.MapControl.TMapMarkCaptionStyle.html">TMapMarkCaptionStyle</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><strong><a href="OSM.MapControl.TMapMark.html#CaptionFont">CaptionFont</a></strong>: TFont;</code></td>
</tr>
</table>
Expand All @@ -75,31 +79,49 @@ <h3 class="detail">Fields</h3>
<td class="itemcode"><span id="Coord"></span><code><strong>Coord</strong>: <a href="OSM.SlippyMapUtils.TGeoPoint.html">TGeoPoint</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
<p>
Coordinates</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Caption"></span><code><strong>Caption</strong>: string;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
<p>
Label</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Visible"></span><code><strong>Visible</strong>: Boolean;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
<p>
Visibility flag</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Data"></span><code><strong>Data</strong>: Pointer;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
<p>
User data</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Layer"></span><code><strong>Layer</strong>: <a href="OSM.MapControl.html#TMapLayer">TMapLayer</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Layer number</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
Expand Down
12 changes: 7 additions & 5 deletions docs/docs/OSM.MapControl.TMapMarkList.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h2 class="declaration">Declaration</h2>
<code>type TMapMarkList = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
List of mapmarks</p>
List of mapmarks. Items are sorted by layer number and painted in this order, ascending</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TMapMarkList</li></ul><h2 class="overview">Overview</h2>
Expand Down Expand Up @@ -61,7 +61,7 @@ <h2 class="description">Description</h2>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="OSM.MapControl.TMapMarkList.html#Add">Add</a></strong>(const GeoCoords: <a href="OSM.SlippyMapUtils.TGeoPoint.html">TGeoPoint</a>; const Caption: string): <a href="OSM.MapControl.TMapMark.html">TMapMark</a>; overload;</code></td>
<td class="itemcode"><code>function <strong><a href="OSM.MapControl.TMapMarkList.html#Add">Add</a></strong>(const GeoCoords: <a href="OSM.SlippyMapUtils.TGeoPoint.html">TGeoPoint</a>; const Caption: string; Layer: <a href="OSM.MapControl.html#TMapLayer">TMapLayer</a> = 0): <a href="OSM.MapControl.TMapMark.html">TMapMark</a>; overload;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
Expand Down Expand Up @@ -196,11 +196,11 @@ <h6 class="description_section">Returns</h6>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Add"></span><code>function <strong>Add</strong>(const GeoCoords: <a href="OSM.SlippyMapUtils.TGeoPoint.html">TGeoPoint</a>; const Caption: string): <a href="OSM.MapControl.TMapMark.html">TMapMark</a>; overload;</code></td>
<td class="itemcode"><span id="Add"></span><code>function <strong>Add</strong>(const GeoCoords: <a href="OSM.SlippyMapUtils.TGeoPoint.html">TGeoPoint</a>; const Caption: string; Layer: <a href="OSM.MapControl.html#TMapLayer">TMapLayer</a> = 0): <a href="OSM.MapControl.TMapMark.html">TMapMark</a>; overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Simple method to add a mapmark by coords and caption</p>
Simple method to add a mapmark by coords, caption and layer</p>
</td></tr>
</table>
<table class="detail wide_list">
Expand All @@ -219,7 +219,9 @@ <h6 class="description_section">Returns</h6>
<td class="itemcode"><span id="Delete"></span><code>procedure <strong>Delete</strong>(MapMark: <a href="OSM.MapControl.TMapMark.html">TMapMark</a>);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
<p>
Remove mapmark object</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
Expand Down
Loading

0 comments on commit 996ebb6

Please sign in to comment.