[mapguide-commits] r7156 - in trunk/Tools/Maestro: Doc Doc/Topics Maestro.Base Maestro.Base/Commands Maestro.Base/Commands/Conditions Maestro.Base/Commands/Test Maestro.Base/Editor Maestro.Base/Events Maestro.Base/Services Maestro.Base/Services/DragDropHandlers Maestro.Base/Templates Maestro.Base/UI Maestro.Base/UI/Packaging Maestro.Base/UI/Preferences Maestro.Base/Util Maestro.Editors/Common Maestro.Editors/FeatureSource/Extensions Maestro.Editors/FeatureSource/Providers/Odbc/SubEditors Maestro.Editors/Generic Maestro.Editors/MapDefinition Maestro.Editors/MapDefinition/Live Maestro.MapViewer Maestro.Shared.UI OSGeo.MapGuide.MaestroAPI OSGeo.MapGuide.MaestroAPI/Mapping OSGeo.MapGuide.MaestroAPI/ObjectModels OSGeo.MapGuide.MaestroAPI/Resource/Comparison OSGeo.MapGuide.MaestroAPI/Tile OSGeo.MapGuide.MaestroAPI.Local SDK/Samples/HelloAddIn Thirdparty/SharpDevelop/ICSharpCode.Core
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Thu Oct 25 08:08:20 PDT 2012
Author: jng
Date: 2012-10-25 08:08:19 -0700 (Thu, 25 Oct 2012)
New Revision: 7156
Added:
trunk/Tools/Maestro/Doc/Topics/Component_MapViewer.aml
Modified:
trunk/Tools/Maestro/Doc/Layout.content
trunk/Tools/Maestro/Doc/MaestroAPI.shfbproj
trunk/Tools/Maestro/Doc/Topics/Welcome.aml
trunk/Tools/Maestro/Maestro.Base/Commands/CacheViewerCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/Conditions/SupportedCommandConditionEvaluator.cs
trunk/Tools/Maestro/Maestro.Base/Commands/EditAsXmlCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/LiveMapEditorCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/RtMapInspectorCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenCoordinateSystemPickerCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenResourceCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenSymbolBrowserCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenUnmanagedResourceCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/Test/SelectFdoProviderCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/Test/TriggerDbXmlCommand.cs
trunk/Tools/Maestro/Maestro.Base/Commands/TranslateLayoutCommand.cs
trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs
trunk/Tools/Maestro/Maestro.Base/Editor/IEditorFactory.cs
trunk/Tools/Maestro/Maestro.Base/Editor/IEditorViewContent.cs
trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs
trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs
trunk/Tools/Maestro/Maestro.Base/MaestroPaths.cs
trunk/Tools/Maestro/Maestro.Base/Services/ClipboardService.cs
trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlerService.cs
trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/DwfFileHandler.cs
trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/PackageFileHandler.cs
trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SdfFileHandler.cs
trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/ShpFileHandler.cs
trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SltFileHandler.cs
trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/XmlResFileHandler.cs
trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs
trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs
trunk/Tools/Maestro/Maestro.Base/Services/ResourcePreviewerFactory.cs
trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs
trunk/Tools/Maestro/Maestro.Base/Services/ServiceRegistry.cs
trunk/Tools/Maestro/Maestro.Base/Services/UrlLauncherService.cs
trunk/Tools/Maestro/Maestro.Base/Services/ViewContentManager.cs
trunk/Tools/Maestro/Maestro.Base/Templates/ApplicationDefinitionItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/DrawingLayerDefinitionItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/DrawingSourceItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/DwfLoadProcedureItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/FeatureSourceItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/ItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/MapDefinitionItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/PrintLayoutItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/RasterLayerDefinitionItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/SdfLoadProcedureItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/ShpLoadProcedureItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/SymbolDefinitionItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/UserItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/VectorLayerDefinitionItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/Templates/WebLayoutItemTemplate.cs
trunk/Tools/Maestro/Maestro.Base/UI/AboutDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/BoundsPicker.cs
trunk/Tools/Maestro/Maestro.Base/UI/BroadcastTextWriter.cs
trunk/Tools/Maestro/Maestro.Base/UI/DirtyStateConfirmationDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/ISiteExplorer.cs
trunk/Tools/Maestro/Maestro.Base/UI/IncompatibleResourcesDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/LabelLocalizationDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/MessageViewer.cs
trunk/Tools/Maestro/Maestro.Base/UI/NewFolderDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/NewResourceDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/OpenResourceIdDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/OutboundRequestViewer.cs
trunk/Tools/Maestro/Maestro.Base/UI/Packaging/CreatePackageDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs
trunk/Tools/Maestro/Maestro.Base/UI/Preferences/EditorPreferencesCtrl.cs
trunk/Tools/Maestro/Maestro.Base/UI/Preferences/GeneralPreferencesCtrl.cs
trunk/Tools/Maestro/Maestro.Base/UI/RenameItemDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/RepointerDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs
trunk/Tools/Maestro/Maestro.Base/UI/ResourceHeaderXmlDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/ResourceIconCache.cs
trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs
trunk/Tools/Maestro/Maestro.Base/UI/SiteExplorer.cs
trunk/Tools/Maestro/Maestro.Base/UI/TestResourceCompatibilityDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/TipOfTheDayDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/ValidationResultsDialog.cs
trunk/Tools/Maestro/Maestro.Base/Util/XmlCompareUtil.cs
trunk/Tools/Maestro/Maestro.Base/Workbench.cs
trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs
trunk/Tools/Maestro/Maestro.Editors/Common/XmlContentErrorDialog.cs
trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs
trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/SubEditors/ConnectionStringCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/MapDefinition/Live/DragMessages.cs
trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapEditorLegend.cs
trunk/Tools/Maestro/Maestro.MapViewer/CoreTypes.cs
trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs
trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs
trunk/Tools/Maestro/Maestro.MapViewer/Maestro.MapViewer.csproj
trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs
trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs
trunk/Tools/Maestro/Maestro.Shared.UI/IWorkbenchInitializer.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/LocalConnection.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/Collections.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/MgServerConnectionBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LongTransaction.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Comparison/DiffEngine.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/BatchSettings.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/RenderThread.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs
trunk/Tools/Maestro/SDK/Samples/HelloAddIn/
trunk/Tools/Maestro/Thirdparty/SharpDevelop/ICSharpCode.Core/ICSharpCode.Core.csproj
Log:
#2138: Now that Maestro.Base is now a public API, this submission contains the following changes:
- Clean up 100s of warnings due to lots of classes in Maestro.Base that have no business being public.
- Small updates to the Maestro API documentation
- More API documentation for previously un-documented public members
Modified: trunk/Tools/Maestro/Doc/Layout.content
===================================================================
--- trunk/Tools/Maestro/Doc/Layout.content 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Doc/Layout.content 2012-10-25 15:08:19 UTC (rev 7156)
@@ -18,6 +18,7 @@
<Topic id="dba29570-f9bb-4f02-9eb0-0a5221f4c330" visible="True" title="Packaging Library" tocTitle="Packaging Library" linkText="Packaging Library" />
<Topic id="f47821f2-31ba-4cb7-868b-5896e5a3268e" visible="True" title="Shared UI Library" tocTitle="Shared UI Library" linkText="Shared UI Library" />
<Topic id="2f9e519e-8f39-463d-98db-b687f8567670" visible="True" title="Login Library" tocTitle="Login Library" linkText="Login Library" />
+ <Topic id="ABC5520D-44DB-43F0-96EB-40DFC46F2506" visible="True" title="Map Viewer Library" tocTitle="Map Viewer Library" linkText="Map Viewer Library" />
</Topic>
<Topic id="3bb213ee-9083-4673-9463-9399bbd1b91c" visible="True" title="Class Diagram" tocTitle="Class Diagram" linkText="Class Diagram" />
</Topic>
Modified: trunk/Tools/Maestro/Doc/MaestroAPI.shfbproj
===================================================================
--- trunk/Tools/Maestro/Doc/MaestroAPI.shfbproj 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Doc/MaestroAPI.shfbproj 2012-10-25 15:08:19 UTC (rev 7156)
@@ -17,28 +17,32 @@
<!-- SHFB properties -->
<OutputPath>.\Help\</OutputPath>
<HtmlHelpName>MaestroAPI</HtmlHelpName>
- <FrameworkVersion>.NET 2.0.50727</FrameworkVersion>
+ <FrameworkVersion>.NET 4.0.30319</FrameworkVersion>
<HelpTitle>MapGuide Maestro API Documentation</HelpTitle>
<IndentHtml>True</IndentHtml>
<PresentationStyle>vs2005</PresentationStyle>
<SandcastlePath>
</SandcastlePath>
<DocumentationSources>
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Editors.dll" />
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Editors.xml" />
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Login.dll" />
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Login.xml" />
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Packaging.dll" />
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Packaging.xml" />
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Shared.UI.dll" />
- <DocumentationSource sourceFile="..\SDK\bin\Maestro.Shared.UI.xml" />
- <DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.ExtendedObjectModels.dll" />
- <DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.ExtendedObjectModels.xml" />
- <DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.MaestroAPI.dll" />
- <DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.MaestroAPI.xml" />
- </DocumentationSources>
+ <DocumentationSource sourceFile="..\SDK\addin-bin\Maestro.Base.dll" />
+<DocumentationSource sourceFile="..\SDK\addin-bin\Maestro.Base.xml" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Editors.dll" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Editors.xml" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Login.dll" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Login.xml" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Packaging.dll" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Packaging.xml" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Shared.UI.dll" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.Shared.UI.xml" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.MapViewer.dll" />
+<DocumentationSource sourceFile="..\SDK\bin\Maestro.MapViewer.xml" />
+<DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.ExtendedObjectModels.dll" />
+<DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.ExtendedObjectModels.xml" />
+<DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.MaestroAPI.dll" />
+<DocumentationSource sourceFile="..\SDK\bin\OSGeo.MapGuide.MaestroAPI.xml" /></DocumentationSources>
<VisibleItems>Attributes, InheritedMembers, Protected, SealedProtected</VisibleItems>
<ApiFilter>
+ <Filter entryType="Namespace" fullName="Aga.Controls" isExposed="False" />
<Filter entryType="Namespace" fullName="Maestro.Editors.FeatureSource.Preview" isExposed="False" />
<Filter entryType="Namespace" fullName="Maestro.Editors.FeatureSource.Providers.Odbc" isExposed="False" />
<Filter entryType="Namespace" fullName="Maestro.Editors.FeatureSource.Providers.Odbc.Drivers" isExposed="False" />
@@ -61,7 +65,7 @@
<HtmlSdkLinkType>None</HtmlSdkLinkType>
<MSHelp2SdkLinkType>None</MSHelp2SdkLinkType>
<MSHelpViewerSdkLinkType>None</MSHelpViewerSdkLinkType>
- <CopyrightText>%28c%29 2011, Jackie Ng</CopyrightText>
+ <CopyrightText>%28c%29 2012, Jackie Ng</CopyrightText>
<SyntaxFilters>CSharp, VisualBasic, CPlusPlus, FSharp, AspNet</SyntaxFilters>
<RootNamespaceContainer>True</RootNamespaceContainer>
<Preliminary>False</Preliminary>
@@ -102,6 +106,7 @@
<None Include="Topics\Component_SharedUI.aml" />
<None Include="Topics\Component_Packaging.aml" />
<None Include="Topics\Component_Editors.aml" />
+ <None Include="Topics\Component_MapViewer.aml" />
<None Include="Topics\Deployment_AspNet.aml" />
<None Include="Topics\Deployment_Desktop.aml" />
<None Include="Topics\Deployment.aml" />
@@ -133,6 +138,11 @@
<AlternateText>Connection Overview</AlternateText>
</Image>
</ItemGroup>
+ <ItemGroup>
+ <Reference Include="Aga.Controls">
+ <HintPath>..\SDK\bin\Aga.Controls.dll</HintPath>
+ </Reference>
+ </ItemGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
</Project>
\ No newline at end of file
Added: trunk/Tools/Maestro/Doc/Topics/Component_MapViewer.aml
===================================================================
--- trunk/Tools/Maestro/Doc/Topics/Component_MapViewer.aml (rev 0)
+++ trunk/Tools/Maestro/Doc/Topics/Component_MapViewer.aml 2012-10-25 15:08:19 UTC (rev 7156)
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="utf-8"?>
+<topic id="ABC5520D-44DB-43F0-96EB-40DFC46F2506" revisionNumber="1">
+ <developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <!--
+ <summary>
+ <para>Optional summary abstract</para>
+ </summary>
+ -->
+ <introduction>
+ <!-- Uncomment this to generate an outline of the section and sub-section
+ titles. Specify a numeric value as the inner text to limit it to
+ a specific number of sub-topics when creating the outline. Specify
+ zero (0) to limit it to top-level sections only. -->
+ <!-- <autoOutline /> -->
+ <para>About the Map Viewer Library</para>
+ </introduction>
+ <!-- Add one or more top-level section elements. These are collapsible.
+ If using <autoOutline />, add an address attribute to identify it
+ and specify a title so that it can be jumped to with a hyperlink. -->
+ <section address="Section1">
+ <title>Overview</title>
+ <content>
+ <!-- Uncomment this to create a sub-section outline
+ <autoOutline /> -->
+ <para>
+ The Maestro Map Viewer Library is a Windows Forms control library that contains an embeddable Map Viewer
+ </para>
+ <para>
+ The Maestro Map Viewer can work with any <codeEntityReference qualifyHint="false">T:OSGeo.MapGuide.MaestroAPI.IServerConnection</codeEntityReference> implementation provided it
+ meets the following requirements:
+ </para>
+ <list class="bullet">
+ <listItem><para>It supports the <codeEntityReference qualifyHint="false">T:OSGeo.MapGuide.MaestroAPI.Services.IMappingService</codeEntityReference> interface</para></listItem>
+ <listItem><para>It supports creation/manipulation of <codeEntityReference qualifyHint="false">T:OSGeo.MapGuide.MaestroAPI.Mapping.RuntimeMap</codeEntityReference> instances</para></listItem>
+ </list>
+ <para>
+ This library is recommended if your MaestroAPI application requires map viewing functionality
+ </para>
+ </content>
+ <!-- If a section contains a sections element, its content creates
+ sub-sections. These are not collapsible.
+ <sections>
+ <section address="SubSection1">
+ <title>Sub-section 1</title>
+ <content>
+ <para>Sub-section content.</para>
+ </content>
+ </section>
+ <section address="SubSection2">
+ <title>Sub-section 2</title>
+ <content>
+ <para>Sub-section content.</para>
+ </content>
+ </section>
+ </sections> -->
+ </section>
+ <relatedTopics>
+ <!-- One or more of the following:
+ - A local link
+ - An external link
+ - A code entity reference
+
+ <link xlink:href="Other Topic's ID"/>
+ <link xlink:href="Other Topic's ID">Link inner text</link>
+
+ <externalLink>
+ <linkText>Link text</linkText>
+ <linkAlternateText>Optional alternate link text</linkAlternateText>
+ <linkUri>URI</linkUri>
+ </externalLink>
+
+ <codeEntityReference>API member ID</codeEntityReference>
+
+ Examples:
+
+ <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
+ <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
+
+ <externalLink>
+ <linkText>SHFB on CodePlex</linkText>
+ <linkAlternateText>Go to CodePlex</linkAlternateText>
+ <linkUri>http://shfb.codeplex.com</linkUri>
+ </externalLink>
+
+ <codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
+ <codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
+ <codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
+ <codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
+ <codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
+ <codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
+ <codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
+ -->
+ </relatedTopics>
+ </developerConceptualDocument>
+</topic>
\ No newline at end of file
Modified: trunk/Tools/Maestro/Doc/Topics/Welcome.aml
===================================================================
--- trunk/Tools/Maestro/Doc/Topics/Welcome.aml 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Doc/Topics/Welcome.aml 2012-10-25 15:08:19 UTC (rev 7156)
@@ -7,20 +7,34 @@
</summary>
-->
<introduction>
- <para>
- This is the reference documentation for the MapGuide Maestro API. The API consists of:
- </para>
- <list class="bullet">
- <listItem><para>The Maestro API core (OSGeo.MapGuide.MaestroAPI.dll)</para></listItem>
- <listItem><para>The Maestro Extended Object Model Helper (OSGeo.MapGuide.ExtendedObjectModels.dll)</para></listItem>
- <listItem><para>The Maestro Editor UI library (Maestro.Editors.dll)</para></listItem>
- <listItem><para>The Maestro Packaging library (Maestro.Packaging.dll)</para></listItem>
- <listItem><para>The Maestro Login UI library (Maestro.Login.dll)</para></listItem>
- <listItem><para>The Maestro Shared UI library (Maestro.Shared.UI.dll)</para></listItem>
- </list>
- <para>
- Also included in this documentation is the Developer's Guide to help you <link xlink:href="0395ae33-fb9f-46cf-bf1e-528a4ec3d948">Get Started</link>
- </para>
+ <para>
+ This is the reference documentation for the MapGuide Maestro API. The API consists of:
+ </para>
+ <list class="bullet">
+ <listItem><para>The Maestro API core (OSGeo.MapGuide.MaestroAPI.dll)</para></listItem>
+ <listItem><para>The Maestro Extended Object Model Helper (OSGeo.MapGuide.ExtendedObjectModels.dll)</para></listItem>
+ </list>
+ <para>
+ For building GUI applications, you can tap into the Maestro UI components, which consist of:
+ </para>
+ <list class="bullet">
+ <listItem><para>The Maestro Editor UI library (Maestro.Editors.dll)</para></listItem>
+ <listItem><para>The Maestro Packaging library (Maestro.Packaging.dll)</para></listItem>
+ <listItem><para>The Maestro Login UI library (Maestro.Login.dll)</para></listItem>
+ <listItem><para>The Maestro Shared UI library (Maestro.Shared.UI.dll)</para></listItem>
+ <listItem><para>The Maestro Map Viewer library (Maestro.MapViewer.dll)</para></listItem>
+ </list>
+ <para>
+ For extending the MapGuide Maestro application, you can use the AddIn API, which consists of:
+ </para>
+ <list class="bullet">
+ <listItem><para>SharpDevelop Core (ICSharpCode.Core.dll)</para></listItem>
+ <listItem><para>SharpDevelop WinForms (ICSharpCode.Core.WinForms.dll)</para></listItem>
+ <listItem><para>The Maestro Base AddIn (Maestro.Base.dll)</para></listItem>
+ </list>
+ <para>
+ Also included in this documentation is the Developer's Guide to help you <link xlink:href="0395ae33-fb9f-46cf-bf1e-528a4ec3d948">Get Started</link>
+ </para>
</introduction>
<!-- <inThisSection>Optional description of content in this section</inThisSection> -->
<!-- <reference>Optional reference section</reference> -->
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/CacheViewerCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/CacheViewerCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/CacheViewerCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Commands
{
- public class CacheViewerCommand : AbstractMenuCommand
+ internal class CacheViewerCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/Conditions/SupportedCommandConditionEvaluator.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/Conditions/SupportedCommandConditionEvaluator.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/Conditions/SupportedCommandConditionEvaluator.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace Maestro.Base.Commands.Conditions
{
- public class SupportedCommandConditionEvaluator : IConditionEvaluator
+ internal class SupportedCommandConditionEvaluator : IConditionEvaluator
{
public bool IsValid(object caller, Condition condition)
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/EditAsXmlCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/EditAsXmlCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/EditAsXmlCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace Maestro.Base.Commands
{
- public class EditAsXmlCommand : AbstractMenuCommand
+ internal class EditAsXmlCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/LiveMapEditorCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/LiveMapEditorCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/LiveMapEditorCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Commands
{
- public class LiveMapEditorCommand : AbstractMenuCommand
+ internal class LiveMapEditorCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/RtMapInspectorCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/RtMapInspectorCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/RtMapInspectorCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Commands
{
- public class RtMapInspectorCommand : AbstractMenuCommand
+ internal class RtMapInspectorCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenCoordinateSystemPickerCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenCoordinateSystemPickerCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenCoordinateSystemPickerCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace Maestro.Base.Commands.Test
{
- public class OpenCoordinateSystemPickerCommand : AbstractMenuCommand
+ internal class OpenCoordinateSystemPickerCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenResourceCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenResourceCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenResourceCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace Maestro.Base.Commands.Test
{
- public class OpenResourceCommand : AbstractMenuCommand
+ internal class OpenResourceCommand : AbstractMenuCommand
{
public override void Run()
{
@@ -47,7 +47,7 @@
}
}
- public class OpenResourceFromStartingPointCommand : AbstractMenuCommand
+ internal class OpenResourceFromStartingPointCommand : AbstractMenuCommand
{
public override void Run()
{
@@ -69,7 +69,7 @@
}
}
- public class OpenFolderCommand : AbstractMenuCommand
+ internal class OpenFolderCommand : AbstractMenuCommand
{
public override void Run()
{
@@ -91,7 +91,7 @@
}
- public class OpenResourceWithFilterCommand : AbstractMenuCommand
+ internal class OpenResourceWithFilterCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenSymbolBrowserCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenSymbolBrowserCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenSymbolBrowserCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Commands.Test
{
- public class OpenSymbolBrowserCommand : AbstractMenuCommand
+ internal class OpenSymbolBrowserCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenUnmanagedResourceCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenUnmanagedResourceCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/Test/OpenUnmanagedResourceCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace Maestro.Base.Commands.Test
{
- public class OpenUnmanagedResourceCommand : AbstractMenuCommand
+ internal class OpenUnmanagedResourceCommand : AbstractMenuCommand
{
public override void Run()
{
@@ -47,7 +47,7 @@
}
}
- public class OpenUnmanagedResourceMultipleCommand : AbstractMenuCommand
+ internal class OpenUnmanagedResourceMultipleCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/Test/SelectFdoProviderCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/Test/SelectFdoProviderCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/Test/SelectFdoProviderCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace Maestro.Base.Commands.Test
{
- public class SelectFdoProviderCommand : AbstractMenuCommand
+ internal class SelectFdoProviderCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/Test/TriggerDbXmlCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/Test/TriggerDbXmlCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/Test/TriggerDbXmlCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Commands.Test
{
- public class TriggerDbXmlCommand : AbstractMenuCommand
+ internal class TriggerDbXmlCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/TranslateLayoutCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/TranslateLayoutCommand.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/TranslateLayoutCommand.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Commands
{
- public class TranslateLayoutCommand : AbstractMenuCommand
+ internal class TranslateLayoutCommand : AbstractMenuCommand
{
public override void Run()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -38,6 +38,9 @@
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// The base class of all editor views
+ /// </summary>
public partial class EditorContentBase : ViewContentBase, IEditorViewContent
{
public EditorContentBase()
@@ -45,12 +48,18 @@
InitializeComponent();
}
+ /// <summary>
+ /// Gets whether the edited resource can be upgraded
+ /// </summary>
public bool CanUpgrade
{
get { return upgradePanel.Visible; }
private set { upgradePanel.Visible = value; }
}
+ /// <summary>
+ /// Gets whether the editor requires to be reloaded. Usually triggered if the session of the underlying connection has expired
+ /// </summary>
[DefaultValue(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public bool RequiresReload
@@ -61,6 +70,9 @@
private IEditorService _svc;
+ /// <summary>
+ /// Gets or sets the editor service instance
+ /// </summary>
public IEditorService EditorService
{
get
@@ -121,6 +133,9 @@
}
}
+ /// <summary>
+ /// Gets the edited resource
+ /// </summary>
public IResource Resource { get { return this.EditorService.GetEditedResource(); } }
/// <summary>
@@ -178,6 +193,9 @@
}
}
+ /// <summary>
+ /// Gets whether this view can only be housed within the document region
+ /// </summary>
public override bool IsExclusiveToDocumentRegion
{
get
@@ -244,12 +262,15 @@
/// and XML edit of this resource). Thus subclasses must take this scenario into
/// account when implementing
/// </summary>
- /// <param name="value"></param>
+ /// <param name="service"></param>
protected virtual void Bind(IEditorService service)
{
throw new NotImplementedException();
}
+ /// <summary>
+ /// Gets whether this resource can be previewed
+ /// </summary>
public virtual bool CanBePreviewed
{
get
@@ -268,10 +289,16 @@
}
}
+ /// <summary>
+ /// Raised when the resource's dirty state has changed
+ /// </summary>
public event EventHandler DirtyStateChanged;
private bool _dirty;
+ /// <summary>
+ /// Gets whether this resource is dirty (ie. has unsaved changes)
+ /// </summary>
public bool IsDirty
{
get { return _dirty; }
@@ -284,26 +311,41 @@
}
}
+ /// <summary>
+ /// Gets whether this resource is a new un-saved resource
+ /// </summary>
public bool IsNew
{
get { return _svc != null ? _svc.IsNew : true; } //Mono
}
+ /// <summary>
+ /// Gets whether this resource can be previewed
+ /// </summary>
public virtual bool CanProfile
{
get { return false; }
}
+ /// <summary>
+ /// Gets whether this resource can be validated
+ /// </summary>
public virtual bool CanBeValidated
{
get { return true; }
}
+ /// <summary>
+ /// Gets whether this resource can be edited in its raw XML form
+ /// </summary>
public virtual bool CanEditAsXml
{
get { return true; }
}
+ /// <summary>
+ /// Previews this resource
+ /// </summary>
public virtual void Preview()
{
var conn = this.Resource.CurrentConnection;
@@ -313,17 +355,27 @@
previewer.Preview(this.Resource, this.EditorService);
}
+ /// <summary>
+ /// Synchronizes the in-memory resource object back to its session-based resource id
+ /// </summary>
public virtual void SyncSessionCopy()
{
this.EditorService.SyncSessionCopy();
}
+ /// <summary>
+ /// Gets whether to discard unsaved changes when closed
+ /// </summary>
public bool DiscardChangesOnClose
{
get;
private set;
}
+ /// <summary>
+ /// Closes this view
+ /// </summary>
+ /// <param name="discardChanges"></param>
public virtual void Close(bool discardChanges)
{
this.DiscardChangesOnClose = discardChanges;
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/IEditorFactory.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/IEditorFactory.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/IEditorFactory.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -24,6 +24,9 @@
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// Defines an interface for creating editor views for a given resource
+ /// </summary>
public interface IEditorFactory
{
/// <summary>
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/IEditorViewContent.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/IEditorViewContent.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/IEditorViewContent.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -27,6 +27,9 @@
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// Defines an interface for editor view content
+ /// </summary>
public interface IEditorViewContent : IViewContent
{
/// <summary>
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -85,6 +85,9 @@
_ed.InitResourceData(_edSvc);
}
+ /// <summary>
+ /// Gets the type of the edited resource
+ /// </summary>
public ResourceTypes ResourceType
{
get;
Modified: trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -31,7 +31,7 @@
namespace Maestro.Base.Events
{
- public static class EventWatcher
+ internal static class EventWatcher
{
private static Timer _keepAliveTimer;
Modified: trunk/Tools/Maestro/Maestro.Base/MaestroPaths.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/MaestroPaths.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/MaestroPaths.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,8 +26,14 @@
namespace Maestro.Base
{
+ /// <summary>
+ /// Contains path information
+ /// </summary>
public class MaestroPaths
{
+ /// <summary>
+ /// The name of the application
+ /// </summary>
public static string AppName
{
get
Modified: trunk/Tools/Maestro/Maestro.Base/Services/ClipboardService.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/ClipboardService.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/ClipboardService.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -34,6 +34,9 @@
/// </summary>
public class ClipboardService : ServiceBase
{
+ /// <summary>
+ /// Initializes this service
+ /// </summary>
public override void Initialize()
{
base.Initialize();
@@ -41,6 +44,10 @@
private object _item;
+ /// <summary>
+ /// Gets whether the clipboard currently has any content
+ /// </summary>
+ /// <returns></returns>
public bool HasContent()
{
lock (_clipLock)
@@ -49,6 +56,10 @@
}
}
+ /// <summary>
+ /// Puts the given item into the clipboard
+ /// </summary>
+ /// <param name="item"></param>
public void Put(object item)
{
Check.NotNull(item, "item");
@@ -58,6 +69,10 @@
}
}
+ /// <summary>
+ /// Gets the current item from the clipboard
+ /// </summary>
+ /// <returns></returns>
public object Get()
{
if (!HasContent())
Modified: trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlerService.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlerService.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlerService.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace Maestro.Base.Services
{
- public class DragDropHandlerService : ServiceBase
+ internal class DragDropHandlerService : ServiceBase
{
public override void Initialize()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/DwfFileHandler.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/DwfFileHandler.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/DwfFileHandler.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Services.DragDropHandlers
{
- public class DwfFileHandler : IDragDropHandler
+ internal class DwfFileHandler : IDragDropHandler
{
public string HandlerAction
{
Modified: trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/PackageFileHandler.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/PackageFileHandler.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/PackageFileHandler.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Services.DragDropHandlers
{
- public class PackageFileHandler : IDragDropHandler
+ internal class PackageFileHandler : IDragDropHandler
{
public string HandlerAction
{
Modified: trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SdfFileHandler.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SdfFileHandler.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SdfFileHandler.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Services.DragDropHandlers
{
- public class SdfFileHandler : IDragDropHandler
+ internal class SdfFileHandler : IDragDropHandler
{
public string HandlerAction
{
Modified: trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/ShpFileHandler.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/ShpFileHandler.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/ShpFileHandler.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Services.DragDropHandlers
{
- public class ShpFileHandler : IDragDropHandler
+ internal class ShpFileHandler : IDragDropHandler
{
public string HandlerAction
{
Modified: trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SltFileHandler.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SltFileHandler.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/SltFileHandler.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Services.DragDropHandlers
{
- public class SltFileHandler : IDragDropHandler
+ internal class SltFileHandler : IDragDropHandler
{
public string HandlerAction
{
Modified: trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/XmlResFileHandler.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/XmlResFileHandler.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/DragDropHandlers/XmlResFileHandler.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Services.DragDropHandlers
{
- public class XmlResFileHandler : IDragDropHandler
+ internal class XmlResFileHandler : IDragDropHandler
{
public string HandlerAction
{
Modified: trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -32,7 +32,10 @@
using System.IO;
using Maestro.Shared.UI;
- public class NewItemTemplateService : ServiceBase
+ /// <summary>
+ /// An application-level service for creating new resources from a set of pre-defined templates
+ /// </summary>
+ internal class NewItemTemplateService : ServiceBase
{
private Dictionary<string, List<ItemTemplate>> _templates;
@@ -91,12 +94,19 @@
return tpls.ToArray();
}
+ /// <summary>
+ /// Gets an array of all template categories
+ /// </summary>
+ /// <returns></returns>
public string[] GetCategories()
{
List<string> values = new List<string>(_templates.Keys);
return values.ToArray();
}
+ /// <summary>
+ /// Represents a set of templates
+ /// </summary>
public class TemplateSet
{
private Dictionary<string, List<ItemTemplate>> _templates;
@@ -117,14 +127,29 @@
}
}
+ /// <summary>
+ /// Gets the categories for the template set
+ /// </summary>
+ /// <returns></returns>
public IEnumerable<string> GetCategories() { return _templates.Keys; }
+ /// <summary>
+ /// Gets the templates for the specified category
+ /// </summary>
+ /// <param name="category"></param>
+ /// <returns></returns>
public IEnumerable<ItemTemplate> GetTemplatesForCategory(string category)
{
return _templates[category];
}
}
+ /// <summary>
+ /// Gets the set of templates that matches the given categories and site version
+ /// </summary>
+ /// <param name="categories">An array of template categories</param>
+ /// <param name="siteVersion"></param>
+ /// <returns></returns>
public TemplateSet GetItemTemplates(string[] categories, Version siteVersion)
{
List<ItemTemplate> templates = new List<ItemTemplate>();
Modified: trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,17 +29,34 @@
namespace Maestro.Base.Services
{
+ /// <summary>
+ /// Manages resoure editor views. This is recommeded over using the <see cref="T:Maestro.Base.Services.ViewContentManager"/> as this has built-in
+ /// logic for handling cases such as:
+ /// <list type="bullet">
+ /// <item><description>Creating or activating an editor instance based on whether one has already been open or not</description></item>
+ /// <item><description>Handling unsupported resource types and/or versions</description></item>
+ /// </list>
+ /// </summary>
public class OpenResourceManager : ServiceBase
{
private Dictionary<string, IEditorViewContent> _openItems;
private Dictionary<ResourceTypeDescriptor, IEditorFactory> _factories;
+ /// <summary>
+ /// Gets the open editor instances
+ /// </summary>
public IEditorViewContent[] OpenEditors
{
get { return new List<IEditorViewContent>(_openItems.Values).ToArray(); }
}
+ /// <summary>
+ /// Closes the editor instances for the given resource id
+ /// </summary>
+ /// <param name="conn"></param>
+ /// <param name="resourceId"></param>
+ /// <param name="discardChanges"></param>
public void CloseEditors(IServerConnection conn, string resourceId, bool discardChanges)
{
string key = ComputeResourceKey(resourceId, conn);
@@ -50,6 +67,12 @@
}
}
+ /// <summary>
+ /// Closes the editor instances for resources not of the specified id
+ /// </summary>
+ /// <param name="conn"></param>
+ /// <param name="resourceId"></param>
+ /// <param name="discardChanges"></param>
public void CloseEditorsExceptFor(IServerConnection conn, string resourceId, bool discardChanges)
{
string key = ComputeResourceKey(resourceId, conn);
@@ -63,6 +86,9 @@
}
}
+ /// <summary>
+ /// Initializes this instance
+ /// </summary>
public override void Initialize()
{
base.Initialize();
@@ -125,12 +151,12 @@
}
}
- public static string ComputeResourceKey(string resId, IServerConnection conn)
+ internal static string ComputeResourceKey(string resId, IServerConnection conn)
{
return conn.DisplayName + "|" + resId; //NOXLATE
}
- public static string ComputeResourceKey(IResource res, IServerConnection conn)
+ internal static string ComputeResourceKey(IResource res, IServerConnection conn)
{
return conn.DisplayName + "|" + res.ResourceID; //NOXLATE
}
@@ -138,12 +164,13 @@
/// <summary>
/// Opens the specified resource using its assigned editor. If the resource is already
/// open, the the existing editor view is activated instead. If the resource has no assigned
- /// editor or <see cref="useXmlEditor"/> is true, the resource will be opened in the default
+ /// editor or <param name="useXmlEditor"/> is true, the resource will be opened in the default
/// XML editor.
/// </summary>
/// <param name="res"></param>
/// <param name="conn"></param>
/// <param name="useXmlEditor"></param>
+ /// <param name="siteExp"></param>
public IEditorViewContent Open(IResource res, IServerConnection conn, bool useXmlEditor, ISiteExplorer siteExp)
{
string key = ComputeResourceKey(res, conn);
@@ -217,7 +244,7 @@
/// <summary>
/// Opens the specified resource using its assigned editor. If the resource is already
/// open, the the existing editor view is activated instead. If the resource has no assigned
- /// editor or <see cref="useXmlEditor"/> is true, the resource will be opened in the default
+ /// editor or <param name="useXmlEditor"/> is true, the resource will be opened in the default
/// XML editor.
/// </summary>
/// <param name="resourceId"></param>
Modified: trunk/Tools/Maestro/Maestro.Base/Services/ResourcePreviewerFactory.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/ResourcePreviewerFactory.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/ResourcePreviewerFactory.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -33,13 +33,29 @@
namespace Maestro.Base.Services
{
+ /// <summary>
+ /// Defines an interface for previewing resources
+ /// </summary>
public interface IResourcePreviewer
{
+ /// <summary>
+ /// Gets whether the specified resource can be previewed
+ /// </summary>
+ /// <param name="res"></param>
+ /// <returns></returns>
bool IsPreviewable(IResource res);
+ /// <summary>
+ /// Previews the specified resource
+ /// </summary>
+ /// <param name="res">The resource to be previewed</param>
+ /// <param name="edSvc">The editor service</param>
void Preview(IResource res, IEditorService edSvc);
}
+ /// <summary>
+ /// The default resource previewer implementation
+ /// </summary>
public class DefaultResourcePreviewer : IResourcePreviewer
{
abstract class PreviewResult
@@ -57,6 +73,11 @@
public Image ImagePreview { get; set; }
}
+ /// <summary>
+ /// Previews the specified resource
+ /// </summary>
+ /// <param name="res">The resource to be previewed</param>
+ /// <param name="edSvc">The editor service</param>
public void Preview(IResource res, IEditorService edSvc)
{
//TODO: Prompt for symbol parameters if there are any, as these can affect the rendered output
@@ -131,6 +152,11 @@
});
}
+ /// <summary>
+ /// Gets whether the specified resource can be previewed
+ /// </summary>
+ /// <param name="res"></param>
+ /// <returns></returns>
public bool IsPreviewable(IResource res)
{
var rt = res.ResourceType;
@@ -149,20 +175,38 @@
}
}
+ /// <summary>
+ /// A simple <see cref="T:Maestro.Base.Service.IResourcePreviewer"/> resolution container
+ /// </summary>
public static class ResourcePreviewerFactory
{
static Dictionary<string, IResourcePreviewer> _previewers = new Dictionary<string, IResourcePreviewer>();
+ /// <summary>
+ /// Registers the given <see cref="T:Maestro.Base.Service.IResourcePreviewer"/> for a given connection provider
+ /// </summary>
+ /// <param name="provider">The name of the connection provider</param>
+ /// <param name="previewer">The previewer implementation</param>
public static void RegisterPreviewer(string provider, IResourcePreviewer previewer)
{
_previewers[provider.ToUpper()] = previewer;
}
+ /// <summary>
+ /// Gets whether a previewer has been registered for the given connection provider
+ /// </summary>
+ /// <param name="provider"></param>
+ /// <returns></returns>
public static bool HasPreviewer(string provider)
{
return _previewers.ContainsKey(provider.ToUpper());
}
+ /// <summary>
+ /// Gets the registered previewer for the specified connection provider
+ /// </summary>
+ /// <param name="provider"></param>
+ /// <returns></returns>
public static IResourcePreviewer GetPreviewer(string provider)
{
if (HasPreviewer(provider))
Modified: trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -27,9 +27,22 @@
namespace Maestro.Base.Services
{
+ /// <summary>
+ /// Defines a method for connection-related events
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="name"></param>
public delegate void ServerConnectionEventHandler(object sender, string name);
+ /// <summary>
+ /// Defines a method that handles connection pre-removal
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="e"></param>
public delegate void ServerConnectionRemovingEventHandler(object sender, ServerConnectionRemovingEventArgs e);
+ /// <summary>
+ /// Defines a cancelable event for a connection that is about to be closed
+ /// </summary>
public class ServerConnectionRemovingEventArgs : CancelEventArgs
{
public ServerConnectionRemovingEventArgs(string name)
@@ -41,25 +54,51 @@
public string ConnectionName { get; set; }
}
+ /// <summary>
+ /// Manages <see cref="T:OSGeo.MapGuide.MaestroAPI.IServerConnection"/> instances
+ /// </summary>
public class ServerConnectionManager : ServiceBase
{
+ /// <summary>
+ /// Raised when a connection has been added
+ /// </summary>
public event ServerConnectionEventHandler ConnectionAdded;
+
+ /// <summary>
+ /// Raised when a connection is about to be removed. Subscribers can cancel this event if required
+ /// </summary>
public event ServerConnectionRemovingEventHandler ConnectionRemoving;
+
+ /// <summary>
+ /// Raised when a connection has been removed
+ /// </summary>
public event ServerConnectionEventHandler ConnectionRemoved;
private Dictionary<string, IServerConnection> _connections = new Dictionary<string, IServerConnection>();
+ /// <summary>
+ /// Gets the names of all currently open connections
+ /// </summary>
+ /// <returns></returns>
public ICollection<string> GetConnectionNames()
{
return _connections.Keys;
}
+ /// <summary>
+ /// Initializes this instance
+ /// </summary>
public override void Initialize()
{
base.Initialize();
LoggingService.Info(Strings.Service_Init_Server_Connection_Manager);
}
-
+
+ /// <summary>
+ /// Gets the connection by its registered name
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public IServerConnection GetConnection(string name)
{
if (_connections.ContainsKey(name))
@@ -68,6 +107,11 @@
return null;
}
+ /// <summary>
+ /// Registers a connection by a given name
+ /// </summary>
+ /// <param name="name"></param>
+ /// <param name="conn"></param>
public void AddConnection(string name, IServerConnection conn)
{
_connections.Add(name, conn);
@@ -76,6 +120,11 @@
handler(this, name);
}
+ /// <summary>
+ /// Removes a connection by its given name
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public IServerConnection RemoveConnection(string name)
{
if (_connections.ContainsKey(name))
Modified: trunk/Tools/Maestro/Maestro.Base/Services/ServiceRegistry.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/ServiceRegistry.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/ServiceRegistry.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,12 +26,19 @@
namespace Maestro.Base.Services
{
+ /// <summary>
+ /// A utility class to access application-level services
+ /// </summary>
public static class ServiceRegistry
{
private static List<ServiceBase> _services;
private static bool _init = false;
+ /// <summary>
+ /// Initializes from the AddIn registry
+ /// </summary>
+ /// <param name="callback"></param>
public static void Initialize(Action callback)
{
if (_init)
@@ -49,6 +56,11 @@
callback();
}
+ /// <summary>
+ /// Gets the application-level service
+ /// </summary>
+ /// <typeparam name="T"></typeparam>
+ /// <returns></returns>
public static T GetService<T>() where T : ServiceBase
{
foreach (var svc in _services)
Modified: trunk/Tools/Maestro/Maestro.Base/Services/UrlLauncherService.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/UrlLauncherService.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/UrlLauncherService.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,13 +28,26 @@
namespace Maestro.Base.Services
{
+ /// <summary>
+ /// Defines an interface for launching URLs
+ /// </summary>
public interface IUrlLauncherService
{
+ /// <summary>
+ /// Opens the specified url using the system default web browser
+ /// </summary>
+ /// <param name="url"></param>
void OpenUrl(string url);
}
+ /// <summary>
+ /// An application-level service for launching URLs
+ /// </summary>
public class UrlLauncherService : ServiceBase, IUrlLauncherService
{
+ /// <summary>
+ /// Initializes this instance
+ /// </summary>
public override void Initialize()
{
base.Initialize();
Modified: trunk/Tools/Maestro/Maestro.Base/Services/ViewContentManager.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/ViewContentManager.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Services/ViewContentManager.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,8 +26,14 @@
namespace Maestro.Base.Services
{
+ /// <summary>
+ /// Manages view content
+ /// </summary>
public class ViewContentManager : ViewContentManagerBase
{
+ /// <summary>
+ /// Initializes this instance
+ /// </summary>
public override void Initialize()
{
_singletonInstances = new List<IViewContent>();
@@ -45,6 +51,10 @@
LoggingService.Info(Strings.Service_Init_ViewContent_Manager);
}
+ /// <summary>
+ /// Gets the workbench implementation
+ /// </summary>
+ /// <returns></returns>
protected override WorkbenchBase GetWorkbench()
{
return Workbench.Instance;
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/ApplicationDefinitionItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/ApplicationDefinitionItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/ApplicationDefinitionItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,7 +30,7 @@
namespace Maestro.Base.Templates
{
- public class ApplicationDefinitionItemTemplate : ItemTemplate
+ internal class ApplicationDefinitionItemTemplate : ItemTemplate
{
public ApplicationDefinitionItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/DrawingLayerDefinitionItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/DrawingLayerDefinitionItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/DrawingLayerDefinitionItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,7 +30,7 @@
namespace Maestro.Base.Templates
{
- public class DrawingLayerDefinitionItemTemplate : ItemTemplate
+ internal class DrawingLayerDefinitionItemTemplate : ItemTemplate
{
public DrawingLayerDefinitionItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/DrawingSourceItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/DrawingSourceItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/DrawingSourceItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Templates
{
- public class DrawingSourceItemTemplate : ItemTemplate
+ internal class DrawingSourceItemTemplate : ItemTemplate
{
public DrawingSourceItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/DwfLoadProcedureItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/DwfLoadProcedureItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/DwfLoadProcedureItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,7 +30,7 @@
namespace Maestro.Base.Templates
{
- public class DwfLoadProcedureItemTemplate : ItemTemplate
+ internal class DwfLoadProcedureItemTemplate : ItemTemplate
{
public DwfLoadProcedureItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/FeatureSourceItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/FeatureSourceItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/FeatureSourceItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Templates
{
- public class FeatureSourceItemTemplate : ItemTemplate
+ internal class FeatureSourceItemTemplate : ItemTemplate
{
public FeatureSourceItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/ItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/ItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/ItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,16 +28,34 @@
namespace Maestro.Base.Templates
{
+ /// <summary>
+ /// The base class of new resource item template
+ /// </summary>
public abstract class ItemTemplate : IComparable<ItemTemplate>
{
- public string Name { get; set; }
+ /// <summary>
+ /// Gets or sets the name of this template
+ /// </summary>
+ public string Name { get; protected set; }
- public string Description { get; set; }
+ /// <summary>
+ /// Gets or sets the description of this template
+ /// </summary>
+ public string Description { get; protected set; }
+ /// <summary>
+ /// Gets the category this template belongs in
+ /// </summary>
public string Category { get; protected set; }
+ /// <summary>
+ /// Gets the resource type of this template
+ /// </summary>
public string ResourceType { get; protected set; }
+ /// <summary>
+ /// Gets the icon for this template
+ /// </summary>
public Image Icon { get; protected set; }
/// <summary>
@@ -59,6 +77,11 @@
/// <returns>a new resource, null if the user cancelled during this process</returns>
public abstract IResource CreateItem(string startFolder, IServerConnection conn);
+ /// <summary>
+ /// Compares this template against the specified template
+ /// </summary>
+ /// <param name="other"></param>
+ /// <returns></returns>
public int CompareTo(ItemTemplate other)
{
return this.Name.CompareTo(other.Name);
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/MapDefinitionItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/MapDefinitionItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/MapDefinitionItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Templates
{
- public class MapDefinitionItemTemplate : ItemTemplate
+ internal class MapDefinitionItemTemplate : ItemTemplate
{
public MapDefinitionItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/PrintLayoutItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/PrintLayoutItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/PrintLayoutItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Templates
{
- public class PrintLayoutItemTemplate : ItemTemplate
+ internal class PrintLayoutItemTemplate : ItemTemplate
{
public PrintLayoutItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/RasterLayerDefinitionItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/RasterLayerDefinitionItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/RasterLayerDefinitionItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.Templates
{
- public class RasterLayerDefinitionItemTemplate : ItemTemplate
+ internal class RasterLayerDefinitionItemTemplate : ItemTemplate
{
public RasterLayerDefinitionItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/SdfLoadProcedureItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/SdfLoadProcedureItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/SdfLoadProcedureItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,7 +30,7 @@
namespace Maestro.Base.Templates
{
- public class SdfLoadProcedureItemTemplate : ItemTemplate
+ internal class SdfLoadProcedureItemTemplate : ItemTemplate
{
public SdfLoadProcedureItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/ShpLoadProcedureItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/ShpLoadProcedureItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/ShpLoadProcedureItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,7 +30,7 @@
namespace Maestro.Base.Templates
{
- public class ShpLoadProcedureItemTemplate : ItemTemplate
+ internal class ShpLoadProcedureItemTemplate : ItemTemplate
{
public ShpLoadProcedureItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/SymbolDefinitionItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/SymbolDefinitionItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/SymbolDefinitionItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Templates
{
- public class SimpleSymbolDefinitionItemTemplate : ItemTemplate
+ internal class SimpleSymbolDefinitionItemTemplate : ItemTemplate
{
public SimpleSymbolDefinitionItemTemplate()
{
@@ -53,7 +53,7 @@
}
}
- public class CompoundSymbolDefinitionItemTemplate : ItemTemplate
+ internal class CompoundSymbolDefinitionItemTemplate : ItemTemplate
{
public CompoundSymbolDefinitionItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/UserItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/UserItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/UserItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Templates
{
- public class UserItemTemplate : ItemTemplate
+ internal class UserItemTemplate : ItemTemplate
{
private IResource _res;
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/VectorLayerDefinitionItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/VectorLayerDefinitionItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/VectorLayerDefinitionItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,7 +30,7 @@
namespace Maestro.Base.Templates
{
- public class VectorLayerDefinitionItemTemplate : ItemTemplate
+ internal class VectorLayerDefinitionItemTemplate : ItemTemplate
{
public VectorLayerDefinitionItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Templates/WebLayoutItemTemplate.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Templates/WebLayoutItemTemplate.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Templates/WebLayoutItemTemplate.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.Templates
{
- public class WebLayoutItemTemplate : ItemTemplate
+ internal class WebLayoutItemTemplate : ItemTemplate
{
public WebLayoutItemTemplate()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/AboutDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/AboutDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/AboutDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -44,7 +44,7 @@
this.Icon = Properties.Resources.MapGuide_Maestro;
}
- public AboutDialog(IServerConnection connection)
+ internal AboutDialog(IServerConnection connection)
: this()
{
m_connection = connection;
Modified: trunk/Tools/Maestro/Maestro.Base/UI/BoundsPicker.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/BoundsPicker.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/BoundsPicker.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.UI
{
- public partial class BoundsPicker : Form
+ internal partial class BoundsPicker : Form
{
private string m_bounds;
public string SRSBounds
Modified: trunk/Tools/Maestro/Maestro.Base/UI/BroadcastTextWriter.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/BroadcastTextWriter.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/BroadcastTextWriter.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -24,12 +24,23 @@
namespace Maestro.Base.UI
{
+ /// <summary>
+ /// Defines a method to log a message
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="msg"></param>
public delegate void LogBroadcastEventHandler(object sender, LogMessage msg);
+ /// <summary>
+ /// A TextWriter that broadcasts all messages written to it
+ /// </summary>
public class BroadcastTextWriter : TextWriter
{
private static BroadcastTextWriter _instance = null;
+ /// <summary>
+ /// Gets the current instance
+ /// </summary>
public static BroadcastTextWriter Instance
{
get
@@ -44,6 +55,9 @@
private BroadcastTextWriter() : base() { }
+ /// <summary>
+ /// Raised when a log message is written
+ /// </summary>
public event LogBroadcastEventHandler LogMessage;
private List<LogMessage> _buffered = new List<LogMessage>();
@@ -65,16 +79,30 @@
}
}
+ /// <summary>
+ /// Writes the specified character
+ /// </summary>
+ /// <param name="value"></param>
public override void Write(char value)
{
Write(value.ToString());
}
+ /// <summary>
+ /// Writes the specified characters
+ /// </summary>
+ /// <param name="buffer"></param>
+ /// <param name="index"></param>
+ /// <param name="count"></param>
public override void Write(char[] buffer, int index, int count)
{
Write(new string(buffer, index, count));
}
+ /// <summary>
+ /// Writes the specified string
+ /// </summary>
+ /// <param name="value"></param>
public override void Write(string value)
{
var message = new LogMessage() { LogDate = DateTime.Now, Message = value };
@@ -96,25 +124,45 @@
}
}
+ /// <summary>
+ /// Writes a new line
+ /// </summary>
public override void WriteLine()
{
WriteLine(string.Empty);
}
+ /// <summary>
+ /// Writes the specified string with a newline at the end
+ /// </summary>
+ /// <param name="value"></param>
public override void WriteLine(string value)
{
Write(value + Environment.NewLine);
}
+ /// <summary>
+ /// Gets the encoding
+ /// </summary>
public override Encoding Encoding
{
get { return Encoding.Unicode; }
}
}
+ /// <summary>
+ /// An application log message
+ /// </summary>
public class LogMessage
{
+ /// <summary>
+ /// Gets or sets the log date
+ /// </summary>
public DateTime LogDate { get; set; }
+
+ /// <summary>
+ /// Gets or sets the log message
+ /// </summary>
public string Message { get; set; }
}
}
Modified: trunk/Tools/Maestro/Maestro.Base/UI/DirtyStateConfirmationDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/DirtyStateConfirmationDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/DirtyStateConfirmationDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -35,7 +35,7 @@
namespace Maestro.Base.UI
{
- public partial class DirtyStateConfirmationDialog : Form
+ internal partial class DirtyStateConfirmationDialog : Form
{
private DirtyStateConfirmationDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ISiteExplorer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ISiteExplorer.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ISiteExplorer.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,6 +26,9 @@
namespace Maestro.Base.UI
{
+ /// <summary>
+ /// Represents the Site Explorer
+ /// </summary>
public interface ISiteExplorer : IViewContent
{
/// <summary>
@@ -51,29 +54,34 @@
/// <summary>
/// Refreshes the tree model
/// </summary>
+ /// <param name="connectionName">The name of the connection</param>
void RefreshModel(string connectionName);
/// <summary>
/// Refreshes the tree model from the specified resource id
/// </summary>
+ /// <param name="connectionName">The name of the connection</param>
/// <param name="resId"></param>
void RefreshModel(string connectionName, string resId);
/// <summary>
/// Expands the node indicated by the specified id
/// </summary>
+ /// <param name="connectionName">The name of the connection</param>
/// <param name="folderId"></param>
void ExpandNode(string connectionName, string folderId);
/// <summary>
/// Selects the node indicated by the specified id
/// </summary>
+ /// <param name="connectionName">The name of the connection</param>
/// <param name="resourceId"></param>
void SelectNode(string connectionName, string resourceId);
/// <summary>
/// Flags the node indicated by the specified action
/// </summary>
+ /// <param name="connectionName">The name of the connection</param>
/// <param name="resourceId"></param>
/// <param name="action"></param>
void FlagNode(string connectionName, string resourceId, NodeFlagAction action);
@@ -89,8 +97,16 @@
event RepositoryItemEventHandler ItemsSelected;
}
+ /// <summary>
+ /// Defines a method to handle item selection in the Site Explorer
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="items"></param>
public delegate void RepositoryItemEventHandler(object sender, RepositoryItem[] items);
+ /// <summary>
+ /// Defines a set of possible actions that can be performed on nodes in the Site Explorer
+ /// </summary>
public enum NodeFlagAction
{
/*
Modified: trunk/Tools/Maestro/Maestro.Base/UI/IncompatibleResourcesDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/IncompatibleResourcesDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/IncompatibleResourcesDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.UI
{
- public partial class IncompatibleResourcesDialog : Form
+ internal partial class IncompatibleResourcesDialog : Form
{
private IncompatibleResourcesDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/LabelLocalizationDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/LabelLocalizationDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/LabelLocalizationDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.UI
{
- public partial class LabelLocalizationDialog : Form
+ internal partial class LabelLocalizationDialog : Form
{
private LabelLocalizationDialog()
{
@@ -88,7 +88,7 @@
}
}
- public class LocalizableElement : INotifyPropertyChanged
+ internal class LocalizableElement : INotifyPropertyChanged
{
private List<XmlNode> _element;
Modified: trunk/Tools/Maestro/Maestro.Base/UI/MessageViewer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/MessageViewer.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/MessageViewer.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,10 +30,10 @@
namespace Maestro.Base.UI
{
- public partial class MessageViewer : SingletonViewContent
+ internal partial class MessageViewer : SingletonViewContent
{
/// <summary>
- /// Internal use only. Do not invoke directly. Use <see cref="ViewContentManager"/> for that
+ /// Internal use only. Do not invoke directly. Use <see cref="T:Maestro.Base.Services.ViewContentManager"/> for that
/// </summary>
public MessageViewer()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/NewFolderDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/NewFolderDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/NewFolderDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -27,7 +27,7 @@
namespace Maestro.Base.UI
{
- public partial class NewFolderDialog : Form
+ internal partial class NewFolderDialog : Form
{
private List<string> _folderNames;
Modified: trunk/Tools/Maestro/Maestro.Base/UI/NewResourceDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/NewResourceDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/NewResourceDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -35,7 +35,7 @@
{
//FIXME: Exceptions thrown in Mono centered around a non-existent image
- public partial class NewResourceDialog : Form
+ internal partial class NewResourceDialog : Form
{
private static bool _subsequentRun = false;
private static List<string> _lastSelectedCategoies = new List<string>();
Modified: trunk/Tools/Maestro/Maestro.Base/UI/OpenResourceIdDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/OpenResourceIdDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/OpenResourceIdDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -33,7 +33,7 @@
namespace Maestro.Base.UI
{
- public partial class OpenResourceIdDialog : Form
+ internal partial class OpenResourceIdDialog : Form
{
private OpenResourceIdDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/OutboundRequestViewer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/OutboundRequestViewer.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/OutboundRequestViewer.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -32,7 +32,7 @@
namespace Maestro.Base.UI
{
- public partial class OutboundRequestViewer : SingletonViewContent
+ internal partial class OutboundRequestViewer : SingletonViewContent
{
public OutboundRequestViewer()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/Packaging/CreatePackageDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/Packaging/CreatePackageDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/Packaging/CreatePackageDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -32,7 +32,7 @@
namespace Maestro.Base.UI.Packaging
{
- public partial class CreatePackageDialog : Form
+ internal partial class CreatePackageDialog : Form
{
public CreatePackageDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -27,20 +27,74 @@
namespace Maestro.Base.UI.Preferences
{
+ /// <summary>
+ /// Configuration property keys for the Maestro base addin
+ /// </summary>
public static class ConfigProperties
{
+ /// <summary>
+ /// The type of viewer to preview
+ /// </summary>
public const string PreviewViewerType = "General.PreviewViewerType"; //NOXLATE
+
+ /// <summary>
+ /// The user template directory
+ /// </summary>
public const string UserTemplatesDirectory = "General.UserTemplatesDirectory"; //NOXLATE
+
+ /// <summary>
+ /// Show the messages view
+ /// </summary>
public const string ShowMessages = "General.ShowMessages"; //NOXLATE
+
+ /// <summary>
+ /// Show the outbound requests view
+ /// </summary>
public const string ShowOutboundRequests = "General.ShowOutboundRequests"; //NOXLATE
+
+ /// <summary>
+ /// The color for open resources in the Site Explorer
+ /// </summary>
public const string OpenColor = "General.OpenColor"; //NOXLATE
+
+ /// <summary>
+ /// The color for unsaved resources in the Site Explorer
+ /// </summary>
public const string DirtyColor = "General.DirtyColor"; //NOXLATE
+
+ /// <summary>
+ /// The path to MgCooker.exe
+ /// </summary>
public const string MgCookerPath = "General.MgCookerPath"; //NOXLATE
+
+ /// <summary>
+ /// The path to RtMapInspector.exe
+ /// </summary>
public const string RtMapInspectorPath = "General.RtMapInspectorPath"; //NOXLATE
+
+ /// <summary>
+ /// The path to MaestroFsPreview.exe
+ /// </summary>
public const string LocalFsPreviewPath = "General.LocalFsPreviewPath"; //NOXLATE
+
+ /// <summary>
+ /// Validate resources when saving
+ /// </summary>
public const string ValidateOnSave = "General.ValidateResourceOnSave"; //NOXLATE
+
+ /// <summary>
+ /// The path to MapGuide XML schemas
+ /// </summary>
public const string XsdSchemaPath = "Editor.XsdSchemaPath"; //NOXLATE
+
+ /// <summary>
+ /// Show the tip of the day on startup
+ /// </summary>
public const string ShowTipOfTheDay = "General.ShowTipOfTheDay"; //NOXLATE
+
+ /// <summary>
+ /// The path to Maestro.LiveMapEditor.exe
+ /// </summary>
public const string LiveMapEditorPath = "General.LiveMapEditorPath"; //NOXLATE
internal static void ApplyDefaults()
@@ -70,30 +124,69 @@
Props.Set(ConfigProperties.LiveMapEditorPath, DefaultLiveMapEditorPath);
}
+ /// <summary>
+ /// Default setting for "Show tip of the day"
+ /// </summary>
public static bool DefaultShowTipOfTheDay { get { return true; } }
+ /// <summary>
+ /// Default path to MgCooker.exe
+ /// </summary>
public static string DefaultMgCookerPath { get { return Path.Combine(FileUtility.ApplicationRootPath, "MgCooker.exe"); } } //NOXLATE
+ /// <summary>
+ /// Default path to MaestroFsPreview.exe
+ /// </summary>
public static string DefaultLocalFsPreviewPath { get { return Path.Combine(FileUtility.ApplicationRootPath, "MaestroFsPreview.exe"); } } //NOXLATE
+ /// <summary>
+ /// Default path to RtMapInspector.exe
+ /// </summary>
public static string DefaultRtMapInspectorPath { get { return Path.Combine(FileUtility.ApplicationRootPath, "RtMapInspector.exe"); } } //NOXLATE
+ /// <summary>
+ /// Default path to Maestro.LiveMapEditor.exe
+ /// </summary>
public static string DefaultLiveMapEditorPath { get { return Path.Combine(FileUtility.ApplicationRootPath, "Maestro.LiveMapEditor.exe"); } } //NOXLATE
-
+
+ /// <summary>
+ /// Default color for open resources in the Site Explorer
+ /// </summary>
public static Color DefaultOpenColor { get { return Color.LightGreen; } }
+ /// <summary>
+ /// Default color for unsaved resources in the Site Explorer
+ /// </summary>
public static Color DefaultDirtyColor { get { return Color.Pink; } }
+ /// <summary>
+ /// Default setting for "Show Messages"
+ /// </summary>
public static bool DefaultShowMessages { get { return true; } }
+ /// <summary>
+ /// Default setting for "Show Outbound Requests"
+ /// </summary>
public static bool DefaultShowOutboundRequests { get { return true; } }
-
+
+ /// <summary>
+ /// Default setting for "Validate Resources on Save"
+ /// </summary>
public static bool DefaultValidateOnSave { get { return true; } }
+ /// <summary>
+ /// Default MapGuide XML schema path
+ /// </summary>
public static string DefaultXsdSchemaPath { get { return Path.Combine(FileUtility.ApplicationRootPath, "Schemas"); } } //NOXLATE
+ /// <summary>
+ /// Default preview viewer type
+ /// </summary>
public static string DefaultPreviewViewerType { get { return "AJAX"; } } //NOXLATE
+ /// <summary>
+ /// Default user template directory
+ /// </summary>
public static string DefaultUserTemplatesDirectory { get { return Path.Combine(FileUtility.ApplicationRootPath, "UserTemplates"); } } //NOXLATE
}
}
Modified: trunk/Tools/Maestro/Maestro.Base/UI/Preferences/EditorPreferencesCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/Preferences/EditorPreferencesCtrl.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/Preferences/EditorPreferencesCtrl.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -9,7 +9,7 @@
namespace Maestro.Base.UI.Preferences
{
- public partial class EditorPreferencesCtrl : UserControl, IPreferenceSheet
+ internal partial class EditorPreferencesCtrl : UserControl, IPreferenceSheet
{
public EditorPreferencesCtrl()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/Preferences/GeneralPreferencesCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/Preferences/GeneralPreferencesCtrl.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/Preferences/GeneralPreferencesCtrl.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -31,7 +31,7 @@
namespace Maestro.Base.UI.Preferences
{
- public partial class GeneralPreferencesCtrl : UserControl, IPreferenceSheet
+ internal partial class GeneralPreferencesCtrl : UserControl, IPreferenceSheet
{
public GeneralPreferencesCtrl()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/RenameItemDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/RenameItemDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/RenameItemDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -28,7 +28,7 @@
namespace Maestro.Base.UI
{
- public partial class RenameItemDialog : Form
+ internal partial class RenameItemDialog : Form
{
private RenameItemDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/RepointerDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/RepointerDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/RepointerDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -31,7 +31,7 @@
namespace Maestro.Base.UI
{
- public partial class RepointerDialog : Form
+ internal partial class RepointerDialog : Form
{
private RepointerDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -40,7 +40,7 @@
private bool _notify = false;
- public RepositoryItem(string connectionName, IRepositoryItem item)
+ internal RepositoryItem(string connectionName, IRepositoryItem item)
{
_name = string.Empty;
_children = new Dictionary<string, RepositoryItem>();
@@ -104,6 +104,11 @@
_notify = true;
}
+ /// <summary>
+ /// Gets whether the specified child item (name) exists
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public bool Contains(string name)
{
return _children.ContainsKey(name);
@@ -120,17 +125,26 @@
set;
}
+ /// <summary>
+ /// Gets the parent of this item
+ /// </summary>
public RepositoryItem Parent
{
get;
private set;
}
+ /// <summary>
+ /// Gets the children of this item
+ /// </summary>
public IEnumerable<RepositoryItem> Children
{
get { return _children.Values; }
}
+ /// <summary>
+ /// Gets the qualified name of this item
+ /// </summary>
public string NameQualified
{
get
@@ -160,6 +174,10 @@
}
}
+ /// <summary>
+ /// Adds the specified item as a child item
+ /// </summary>
+ /// <param name="item"></param>
public void AddChild(RepositoryItem item)
{
item.Parent = this;
@@ -167,6 +185,10 @@
NotifyStructureChanged(this);
}
+ /// <summary>
+ /// Removes the child item
+ /// </summary>
+ /// <param name="item"></param>
public void RemoveChild(RepositoryItem item)
{
if (_children.ContainsKey(item.NameQualified) && item.Parent == this)
@@ -196,17 +218,26 @@
}
}
+ /// <summary>
+ /// Gets whether this item is a root node
+ /// </summary>
public bool IsRoot
{
get { return this.ResourceId == StringConstants.RootIdentifier; }
}
+ /// <summary>
+ /// Gets the resource id
+ /// </summary>
public string ResourceId
{
get;
internal set;
}
+ /// <summary>
+ /// Gets the name of the associated connection
+ /// </summary>
public string ConnectionName
{
get;
@@ -215,6 +246,9 @@
private string _name;
+ /// <summary>
+ /// Gets the name of this resource
+ /// </summary>
public string Name
{
get { return _name; }
@@ -267,6 +301,9 @@
}
}
+ /// <summary>
+ /// Gets the resource type
+ /// </summary>
public string ResourceType
{
get;
@@ -275,33 +312,48 @@
private string _owner;
+ /// <summary>
+ /// Gets or sets the resource owner
+ /// </summary>
public string Owner
{
get { return _owner; }
- set
+ internal set
{
_owner = value;
NotifyNodesChanged();
}
}
+ /// <summary>
+ /// Gets the date this resource was created
+ /// </summary>
public DateTime CreatedDate
{
get;
internal set;
}
+ /// <summary>
+ /// Gets the modified date of this resource
+ /// </summary>
public DateTime ModifiedDate
{
get;
internal set;
}
+ /// <summary>
+ /// Gets whether this item is a folder
+ /// </summary>
public bool IsFolder
{
get { return this.ResourceId.EndsWith("/"); } //NOXLATE
}
+ /// <summary>
+ /// Gets the icon for this item
+ /// </summary>
public Image Icon
{
get;
@@ -339,15 +391,30 @@
}
}
+ /// <summary>
+ /// Defines valid clipboard actions for Site Explorer
+ /// </summary>
public enum ClipboardAction
{
+ /// <summary>
+ /// The node was copied
+ /// </summary>
Copy,
+ /// <summary>
+ /// The node was cut
+ /// </summary>
Cut,
+ /// <summary>
+ /// No clipboard action applied
+ /// </summary>
None
}
private ClipboardAction _action = ClipboardAction.None;
+ /// <summary>
+ /// Gets the clipboard state of this item
+ /// </summary>
public ClipboardAction ClipboardState
{
get { return _action; }
@@ -367,8 +434,17 @@
}
}
+ /// <summary>
+ /// Provides tooltips for resources in the Site Explorer
+ /// </summary>
public class RepositoryItemToolTipProvider : IToolTipProvider
{
+ /// <summary>
+ /// Gets the tooltip
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="nodeControl"></param>
+ /// <returns></returns>
public string GetToolTip(TreeNodeAdv node, Aga.Controls.Tree.NodeControls.NodeControl nodeControl)
{
RepositoryItem item = node.Tag as RepositoryItem;
@@ -392,7 +468,7 @@
private OpenResourceManager _openResMgr;
private ClipboardService _clip;
- public RepositoryTreeModel(ServerConnectionManager connManager, TreeViewAdv tree, OpenResourceManager openResMgr, ClipboardService clip)
+ internal RepositoryTreeModel(ServerConnectionManager connManager, TreeViewAdv tree, OpenResourceManager openResMgr, ClipboardService clip)
{
_connManager = connManager;
_tree = tree;
@@ -443,6 +519,11 @@
private Dictionary<string, RepositoryItem> _rootNodes = new Dictionary<string, RepositoryItem>();
+ /// <summary>
+ /// Gets the child nodes in the given tree path
+ /// </summary>
+ /// <param name="treePath"></param>
+ /// <returns></returns>
public override System.Collections.IEnumerable GetChildren(TreePath treePath)
{
if (treePath.IsEmpty())
@@ -527,6 +608,9 @@
}
}
+ /// <summary>
+ /// Refreshes this model
+ /// </summary>
public override void Refresh()
{
//We have to override this because the base impl does not
@@ -544,6 +628,11 @@
OnStructureChanged(new TreePathEventArgs());
}
+ /// <summary>
+ /// Gets whether the specified tree path is a path to a leaf node
+ /// </summary>
+ /// <param name="treePath"></param>
+ /// <returns></returns>
public override bool IsLeaf(TreePath treePath)
{
return !((RepositoryItem)treePath.LastNode).IsFolder;
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ResourceHeaderXmlDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ResourceHeaderXmlDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ResourceHeaderXmlDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -32,7 +32,10 @@
namespace Maestro.Base.UI
{
- public partial class ResourceHeaderXmlDialog : Form
+ /// <summary>
+ /// A dialog for editing a resource's header content
+ /// </summary>
+ internal partial class ResourceHeaderXmlDialog : Form
{
private ResourceHeaderXmlDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ResourceIconCache.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ResourceIconCache.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ResourceIconCache.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -27,17 +27,39 @@
namespace Maestro.Base.UI
{
+ /// <summary>
+ /// Defines a cache of icons for resource types
+ /// </summary>
public interface IResourceIconCache
{
+ /// <summary>
+ /// Gets the small resource icon list
+ /// </summary>
ImageList SmallImageList { get; }
+ /// <summary>
+ /// Gets the large resource icon list
+ /// </summary>
ImageList LargeImageList { get; }
+ /// <summary>
+ /// Gets the specified image list key for the given resource
+ /// </summary>
+ /// <param name="resourceId"></param>
+ /// <returns></returns>
string GetImageKeyFromResourceID(string resourceId);
+ /// <summary>
+ /// Gets the specified image list index for the given resource
+ /// </summary>
+ /// <param name="resourceId"></param>
+ /// <returns></returns>
int GetImageIndexFromResourceID(string resourceId);
}
+ /// <summary>
+ /// A cache of icons for resource types
+ /// </summary>
public class ResourceIconCache : IResourceIconCache
{
private ImageList _small;
@@ -51,6 +73,10 @@
const string UNKNOWN = "UNKNOWN"; //NOXLATE
+ /// <summary>
+ /// Creates the default image lists
+ /// </summary>
+ /// <returns></returns>
public static ResourceIconCache CreateDefault()
{
var icons = new ResourceIconCache();
@@ -81,6 +107,11 @@
return icons;
}
+ /// <summary>
+ /// Gets the specified image list key for the given resource
+ /// </summary>
+ /// <param name="resourceId"></param>
+ /// <returns></returns>
public string GetImageKeyFromResourceID(string resourceId)
{
var rt = ResourceIdentifier.GetResourceType(resourceId);
@@ -101,6 +132,11 @@
}
}
+ /// <summary>
+ /// Gets the specified image list index for the given resource
+ /// </summary>
+ /// <param name="resourceId"></param>
+ /// <returns></returns>
public int GetImageIndexFromResourceID(string resourceId)
{
int idx = _small.Images.IndexOfKey(ResourceIdentifier.GetResourceType(resourceId).ToString());
@@ -111,11 +147,17 @@
return idx;
}
+ /// <summary>
+ /// Gets the small resource icon list
+ /// </summary>
public ImageList SmallImageList
{
get { return _small; }
}
+ /// <summary>
+ /// Gets the large resource icon list
+ /// </summary>
public ImageList LargeImageList
{
get { return _large; }
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,7 +30,7 @@
namespace Maestro.Base.UI
{
- public class ResourceIdNavigator
+ internal class ResourceIdNavigator
{
// How this tool strip is visually laid out
//
Modified: trunk/Tools/Maestro/Maestro.Base/UI/SiteExplorer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/SiteExplorer.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/SiteExplorer.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -40,7 +40,10 @@
namespace Maestro.Base.UI
{
- public partial class SiteExplorer : ViewContentBase, ISiteExplorer
+ /// <summary>
+ /// The site explorer
+ /// </summary>
+ internal partial class SiteExplorer : ViewContentBase, ISiteExplorer
{
/// <summary>
/// Internal use only. Do not invoke directly. Use <see cref="ViewContentManager"/> for that
Modified: trunk/Tools/Maestro/Maestro.Base/UI/TestResourceCompatibilityDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/TestResourceCompatibilityDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/TestResourceCompatibilityDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -29,7 +29,7 @@
namespace Maestro.Base.UI
{
- public partial class TestResourceCompatibilityDialog : Form
+ internal partial class TestResourceCompatibilityDialog : Form
{
public TestResourceCompatibilityDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/TipOfTheDayDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/TipOfTheDayDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/TipOfTheDayDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -32,7 +32,7 @@
namespace Maestro.Base.UI
{
- public partial class TipOfTheDayDialog : Form
+ internal partial class TipOfTheDayDialog : Form
{
private static bool _firstTime = true;
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ValidationResultsDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ValidationResultsDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ValidationResultsDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -31,10 +31,18 @@
namespace Maestro.Base
{
+ /// <summary>
+ /// A dialog for displaying validation results
+ /// </summary>
public partial class ValidationResultsDialog : Form
{
private List<KeyValuePair<string, ValidationIssue[]>> m_issues = new List<KeyValuePair<string, ValidationIssue[]>>();
+ /// <summary>
+ /// Creates a new instance
+ /// </summary>
+ /// <param name="resourceId"></param>
+ /// <param name="issues"></param>
public ValidationResultsDialog(string resourceId, ValidationIssue[] issues)
: this(
new List<KeyValuePair<string, ValidationIssue[]>>(
@@ -45,6 +53,10 @@
)
{ }
+ /// <summary>
+ /// Creates a new instance
+ /// </summary>
+ /// <param name="issues"></param>
public ValidationResultsDialog(List<KeyValuePair<string, ValidationIssue[]>> issues)
: this()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Util/XmlCompareUtil.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Util/XmlCompareUtil.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Util/XmlCompareUtil.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -27,7 +27,7 @@
namespace Maestro.Base.Util
{
- public class XmlCompareUtil
+ internal class XmlCompareUtil
{
/// <summary>
/// Prepares the source and target resource content for XML comparison
Modified: trunk/Tools/Maestro/Maestro.Base/Workbench.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Workbench.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/Workbench.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -86,6 +86,9 @@
}
}
+ /// <summary>
+ /// Gets the active editor view
+ /// </summary>
public IEditorViewContent ActiveEditor
{
get { return this.ActiveDocumentView as IEditorViewContent; }
Modified: trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -27,13 +27,25 @@
namespace Maestro.Base
{
+ /// <summary>
+ /// Initializes the main window
+ /// </summary>
public class WorkbenchInitializer : IWorkbenchInitializer
{
+ /// <summary>
+ /// Gets the main window icon
+ /// </summary>
+ /// <returns></returns>
public System.Drawing.Icon GetIcon()
{
return Properties.Resources.MapGuide_Maestro;
}
+ /// <summary>
+ /// Updates the status of the menu items
+ /// </summary>
+ /// <param name="menu"></param>
+ /// <param name="toolstrips"></param>
public void UpdateMenuItemStatus(MenuStrip menu, IEnumerable<ToolStrip> toolstrips)
{
foreach (ToolStripItem item in menu.Items)
@@ -52,6 +64,11 @@
}
}
+ /// <summary>
+ /// Gets the main menu
+ /// </summary>
+ /// <param name="workbench"></param>
+ /// <returns></returns>
public MenuStrip GetMainMenu(WorkbenchBase workbench)
{
var menu = new System.Windows.Forms.MenuStrip();
@@ -59,16 +76,29 @@
return menu;
}
+ /// <summary>
+ /// Gets the main toolstrip
+ /// </summary>
+ /// <param name="workbench"></param>
+ /// <returns></returns>
public ToolStrip GetMainToolStrip(WorkbenchBase workbench)
{
return ToolbarService.CreateToolStrip(workbench, "/Maestro/Shell/Toolbars/Main"); //NOXLATE
}
+ /// <summary>
+ /// Gets the view content manager
+ /// </summary>
+ /// <returns></returns>
public IViewContentManager GetViewContentManager()
{
return ServiceRegistry.GetService<ViewContentManager>();
}
+ /// <summary>
+ /// Gets the close icon for documents
+ /// </summary>
+ /// <returns></returns>
public System.Drawing.Image GetDocumentCloseIcon()
{
return Properties.Resources.cross_small;
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/XmlContentErrorDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/XmlContentErrorDialog.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/XmlContentErrorDialog.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -47,6 +47,7 @@
/// display the error dialog, or attach the
/// </summary>
/// <param name="ex"></param>
+ /// <param name="origXml"></param>
/// <param name="bDisplay"></param>
public static void CheckAndHandle(Exception ex, string origXml, bool bDisplay)
{
@@ -90,7 +91,6 @@
/// Displays this dialog
/// </summary>
/// <param name="ex"></param>
- /// <param name="origXmlContent"></param>
public static void Show(Exception ex)
{
Check.NotNull(ex, "ex"); //NOXLATE
Modified: trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -43,8 +43,6 @@
grdJoinKeys.DataSource = _propertyJoins;
}
- private bool _init = false;
-
private IAttributeRelation _rel;
private string _primaryFeatureSource;
@@ -63,7 +61,6 @@
_primaryFeatureSource = primaryFeatureSource;
_primaryClass = primaryClass;
- _init = true;
grdJoinKeys.AutoGenerateColumns = false;
_rel = rel;
}
@@ -208,7 +205,6 @@
protected override void OnLoad(EventArgs e)
{
- _init = false;
base.OnLoad(e);
}
Modified: trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/SubEditors/ConnectionStringCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/SubEditors/ConnectionStringCtrl.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/SubEditors/ConnectionStringCtrl.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -74,7 +74,6 @@
return this.ConnectionProperties;
}
-
public event EventHandler RequestDocumentReset;
}
}
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -358,6 +358,11 @@
_findForm.ShowFor(editor, true);
}
+ /// <summary>
+ /// Find and replace all instances of the specified token with its replacement token
+ /// </summary>
+ /// <param name="find"></param>
+ /// <param name="replace"></param>
public void FindAndReplace(string find, string replace)
{
_findForm.ShowFor(txtXmlContent, true, false); //This is just to initialize it just in case
Modified: trunk/Tools/Maestro/Maestro.Editors/MapDefinition/Live/DragMessages.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/MapDefinition/Live/DragMessages.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Editors/MapDefinition/Live/DragMessages.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -24,14 +24,14 @@
namespace Maestro.Editors.MapDefinition.Live
{
- public class ResourceDragMessage
+ internal class ResourceDragMessage
{
public ResourceDragMessage(string resId) { this.ResourceID = resId; }
public string ResourceID { get; private set; }
}
- public class LayerDragMessage
+ internal class LayerDragMessage
{
public LayerDragMessage(string groupName, string layerName)
{
@@ -44,7 +44,7 @@
public string LayerName { get; private set; }
}
- public class GroupDragMessage
+ internal class GroupDragMessage
{
public GroupDragMessage(string groupName)
{
Modified: trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapEditorLegend.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapEditorLegend.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapEditorLegend.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -221,6 +221,9 @@
}
}
+ /// <summary>
+ /// Raised when a drag occurs
+ /// </summary>
public event ItemDragEventHandler ItemDrag;
internal void HandleDragDrop(DragEventArgs e)
Modified: trunk/Tools/Maestro/Maestro.MapViewer/CoreTypes.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/CoreTypes.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.MapViewer/CoreTypes.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -70,19 +70,31 @@
/// <param name="ury">The Y coordinate of the rectangle's upper right point</param>
public delegate void RectangleDigitizationCallback(double llx, double lly, double urx, double ury);
+ /// <summary>
+ /// Represents an entry in the view history stack
+ /// </summary>
public class MapViewHistoryEntry
{
- public MapViewHistoryEntry(double x, double y, double scale)
+ internal MapViewHistoryEntry(double x, double y, double scale)
{
this.X = x;
this.Y = y;
this.Scale = scale;
}
+ /// <summary>
+ /// Gets the X coordinate
+ /// </summary>
public double X { get; private set; }
+ /// <summary>
+ /// Gets the Y coordinate
+ /// </summary>
public double Y { get; private set; }
+ /// <summary>
+ /// Gets the view scale
+ /// </summary>
public double Scale { get; private set; }
}
@@ -180,7 +192,7 @@
/// </summary>
public class ViewerRenderingOptions
{
- public ViewerRenderingOptions(string format, int behavior, Color color)
+ internal ViewerRenderingOptions(string format, int behavior, Color color)
{
this.Format = format;
this.Behavior = behavior;
Modified: trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -62,7 +62,10 @@
this.ThemeCompressionLimit = 25;
this.ShowAllLayersAndGroups = false;
}
-
+
+ /// <summary>
+ /// Raised when item dragging occurs
+ /// </summary>
public event ItemDragEventHandler ItemDrag;
/// <summary>
@@ -73,6 +76,9 @@
private IMapViewer _viewer;
+ /// <summary>
+ /// Gets or sets the viewer instance
+ /// </summary>
public IMapViewer Viewer
{
get { return _viewer; }
@@ -143,7 +149,10 @@
private Stopwatch _legendUpdateStopwatch = new Stopwatch();
private bool _busy = false;
-
+
+ /// <summary>
+ /// Gets whether the viewer is currently busy
+ /// </summary>
[Browsable(false)]
public bool IsBusy
{
@@ -492,12 +501,18 @@
return null;
}
+ /// <summary>
+ /// Gets or sets whether to show node tooltips
+ /// </summary>
public bool ShowTooltips
{
get { return trvLegend.ShowNodeToolTips; }
set { trvLegend.ShowNodeToolTips = value; }
}
+ /// <summary>
+ /// Raised when a legend node is selected
+ /// </summary>
public event NodeEventHandler NodeSelected;
private void trvLegend_AfterSelect(object sender, TreeViewEventArgs e)
@@ -507,6 +522,9 @@
h(this, e.Node);
}
+ /// <summary>
+ /// Gets whether a right-click on a node selects it
+ /// </summary>
public bool SelectOnRightClick { get; set; }
private void trvLegend_MouseDown(object sender, MouseEventArgs e)
@@ -517,6 +535,12 @@
}
}
+ /// <summary>
+ /// Gets the matching node at the specified coordinates
+ /// </summary>
+ /// <param name="x"></param>
+ /// <param name="y"></param>
+ /// <returns></returns>
public TreeNode GetNodeAt(int x, int y)
{
return trvLegend.GetNodeAt(x, y);
Modified: trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -821,23 +821,42 @@
namespace Model
{
+ /// <summary>
+ /// Metadata about a node in the legend
+ /// </summary>
public abstract class LegendNodeMetadata
{
+ /// <summary>
+ /// Gets whether the node is a group
+ /// </summary>
public bool IsGroup { get; protected set; }
+ /// <summary>
+ /// Gets the object id
+ /// </summary>
public abstract string ObjectId { get; }
+ /// <summary>
+ /// Gets whether the node is checkable
+ /// </summary>
public bool Checkable { get; protected set; }
}
+ /// <summary>
+ /// Group metadata
+ /// </summary>
[DebuggerDisplay("Name = {GroupName}, Label = {LegendLabel}")]
public class GroupNodeMetadata : LegendNodeMetadata
{
internal RuntimeMapGroup Group { get; private set; }
+ /// <summary>
+ /// Gets the associated group
+ /// </summary>
+ /// <returns></returns>
public RuntimeMapGroup GetGroup() { return this.Group; }
- public GroupNodeMetadata(RuntimeMapGroup group)
+ internal GroupNodeMetadata(RuntimeMapGroup group)
{
base.IsGroup = true;
this.Group = group;
@@ -853,11 +872,14 @@
get { return this.Group.ObjectId; }
}
}
-
+
+ /// <summary>
+ /// Layer theme node metadata
+ /// </summary>
[DebuggerDisplay("Layer Theme Node")]
public class LayerThemeNodeMetadata : LegendNodeMetadata
{
- public LayerThemeNodeMetadata(bool bPlaceholder, Image themeIcon, string labelText)
+ internal LayerThemeNodeMetadata(bool bPlaceholder, Image themeIcon, string labelText)
{
this.IsPlaceholder = bPlaceholder;
this.ThemeIcon = themeIcon;
@@ -873,18 +895,34 @@
public override string ObjectId
{
- get { return ""; }
+ get { return string.Empty; }
}
}
+ /// <summary>
+ /// Represents a theme category
+ /// </summary>
public class ThemeCategory
{
+ /// <summary>
+ /// Gets the lower bound scale
+ /// </summary>
public string MinScale { get; set; }
+ /// <summary>
+ /// Gets the upper bound scale
+ /// </summary>
public string MaxScale { get; set; }
+ /// <summary>
+ /// Gets the geometry type this category is applicable to
+ /// </summary>
public int GeometryType { get; set; }
+ /// <summary>
+ /// Gets the hash code
+ /// </summary>
+ /// <returns></returns>
public override int GetHashCode()
{
unchecked // Overflow is fine, just wrap
@@ -900,6 +938,11 @@
}
}
+ /// <summary>
+ /// Checks whether this instance is equal to the specified instance
+ /// </summary>
+ /// <param name="obj"></param>
+ /// <returns></returns>
public override bool Equals(object obj)
{
var cat = obj as ThemeCategory;
@@ -912,10 +955,13 @@
}
}
+ /// <summary>
+ /// Information about a layer node
+ /// </summary>
[DebuggerDisplay("Name = {Layer.Name}, Label = {Layer.LegendLabel}")]
public class LayerNodeMetadata : LegendNodeMetadata
{
- public LayerNodeMetadata(RuntimeMapLayer layer, bool bInitiallySelectable, bool bTiled)
+ internal LayerNodeMetadata(RuntimeMapLayer layer, bool bInitiallySelectable, bool bTiled)
{
base.IsGroup = false;
this.Layer = layer;
@@ -928,8 +974,14 @@
_defaultIcons = new Dictionary<ThemeCategory, Image>();
}
+ /// <summary>
+ /// Gets the name
+ /// </summary>
public string Name { get { return this.Layer.Name; } }
+ /// <summary>
+ /// Gets the object id
+ /// </summary>
public override string ObjectId
{
get { return this.Layer.ObjectId; }
@@ -937,6 +989,9 @@
private bool? _isRaster;
+ /// <summary>
+ /// Gets whether this layer is a raster layer
+ /// </summary>
public bool IsRaster
{
get
@@ -956,6 +1011,9 @@
private bool? _isDwf;
+ /// <summary>
+ /// Gets whether this layer is a DWF-based drawing layer
+ /// </summary>
public bool IsDwf
{
get
@@ -975,11 +1033,21 @@
private Dictionary<ThemeCategory, Image> _defaultIcons;
+ /// <summary>
+ /// Sets the default icon of the given theme category
+ /// </summary>
+ /// <param name="cat"></param>
+ /// <param name="image"></param>
public void SetDefaultIcon(ThemeCategory cat, Image image)
{
_defaultIcons[cat] = image;
}
+ /// <summary>
+ /// Gets the default icon for the specified scale
+ /// </summary>
+ /// <param name="scale"></param>
+ /// <returns></returns>
public Image GetDefaultIcon(double scale)
{
foreach (var cat in _defaultIcons.Keys)
@@ -994,11 +1062,11 @@
internal RuntimeMapLayer Layer { get; private set; }
- public bool DrawSelectabilityIcon { get; set; }
+ internal bool DrawSelectabilityIcon { get; set; }
public bool IsSelectable { get; set; }
- public bool WasInitiallySelectable { get; private set; }
+ internal bool WasInitiallySelectable { get; private set; }
public bool IsBaseLayer { get; set; }
@@ -1006,6 +1074,11 @@
private Dictionary<ThemeCategory, List<LayerThemeNodeMetadata>> _themeNodes;
+ /// <summary>
+ /// Gets the theme nodes for this layer
+ /// </summary>
+ /// <param name="category"></param>
+ /// <returns></returns>
public List<LayerThemeNodeMetadata> GetThemeNodes(ThemeCategory category)
{
if (_themeNodes.ContainsKey(category))
@@ -1013,6 +1086,11 @@
return null;
}
+ /// <summary>
+ /// Adds a theme node
+ /// </summary>
+ /// <param name="category"></param>
+ /// <param name="themeMeta"></param>
public void AddThemeNode(ThemeCategory category, LayerThemeNodeMetadata themeMeta)
{
if (!_themeNodes.ContainsKey(category))
Modified: trunk/Tools/Maestro/Maestro.MapViewer/Maestro.MapViewer.csproj
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/Maestro.MapViewer.csproj 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.MapViewer/Maestro.MapViewer.csproj 2012-10-25 15:08:19 UTC (rev 7156)
@@ -30,6 +30,7 @@
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
+ <DocumentationFile>bin\Release\Maestro.MapViewer.XML</DocumentationFile>
</PropertyGroup>
<ItemGroup>
<Reference Include="System" />
Modified: trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,6 +26,9 @@
namespace Maestro.MapViewer
{
+ /// <summary>
+ /// A helper component to auto-wire common viewer events to related UI components
+ /// </summary>
public class MapStatusTracker : Component
{
private IMapViewer _viewer;
@@ -43,10 +46,19 @@
}
}
+ /// <summary>
+ /// Gets the "items selected" label
+ /// </summary>
public ToolStripLabel SelectedLabel { get; set; }
+ /// <summary>
+ /// Gets the "scale" label
+ /// </summary>
public ToolStripLabel ScaleLabel { get; set; }
+ /// <summary>
+ /// Gets the "mouse coordinates" label
+ /// </summary>
public ToolStripLabel CoordinatesLabel { get; set; }
private void WireViewer(IMapViewer viewer)
Modified: trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -591,7 +591,10 @@
}
}
}
-
+
+ /// <summary>
+ /// Gets or sets the amount of pixels to buffer out by when doing point-based selections with the select tool
+ /// </summary>
[Category("MapGuide Viewer")]
[Description("The amount of pixels to buffer out by when doing point-based selections with the Select tool")]
public int PointPixelBuffer { get; set; }
@@ -951,36 +954,65 @@
_rectangleCustomDigitizationPrompt = customPrompt;
}
+ /// <summary>
+ /// Starts circle digitization
+ /// </summary>
+ /// <param name="callback"></param>
public void DigitizeCircle(CircleDigitizationCallback callback)
{
DigitizeCircle(callback, null);
}
+ /// <summary>
+ /// Starts digitize line
+ /// </summary>
+ /// <param name="callback"></param>
public void DigitizeLine(LineDigitizationCallback callback)
{
DigitizeLine(callback, null);
}
+ /// <summary>
+ /// Starts point digitization
+ /// </summary>
+ /// <param name="callback"></param>
public void DigitizePoint(PointDigitizationCallback callback)
{
DigitizePoint(callback, null);
}
+ /// <summary>
+ /// Starts polygon digitization
+ /// </summary>
+ /// <param name="callback"></param>
public void DigitizePolygon(PolygonDigitizationCallback callback)
{
DigitizePolygon(callback, null);
}
+ /// <summary>
+ /// Starts line string digitization
+ /// </summary>
+ /// <param name="callback"></param>
public void DigitizeLineString(LineStringDigitizationCallback callback)
{
DigitizeLineString(callback, (string)null);
}
+ /// <summary>
+ /// Starts line string digitization
+ /// </summary>
+ /// <param name="callback"></param>
+ /// <param name="segmentDigitized"></param>
public void DigitizeLineString(LineStringDigitizationCallback callback, LineDigitizationCallback segmentDigitized)
{
DigitizeLineString(callback, segmentDigitized, null);
}
+ /// <summary>
+ /// Starts rectangle digitization
+ /// </summary>
+ /// <param name="callback"></param>
public void DigitizeRectangle(RectangleDigitizationCallback callback)
{
DigitizeRectangle(callback, null);
@@ -1095,6 +1127,10 @@
return new ViewerRenderingOptions("PNG", (1 | 4), Color.FromArgb(red, green, blue));
}
+ /// <summary>
+ /// Load the viewer with the given runtime map
+ /// </summary>
+ /// <param name="map"></param>
public void LoadMap(RuntimeMap map)
{
_map = map;
@@ -1180,7 +1216,7 @@
/// <summary>
/// Gets or sets a value indicating whether tiled groups are converted to normal groups. Must be set before
- /// a map is loaded via the <see cref="Init"/> method
+ /// a map is loaded
/// </summary>
[Category("MapGuide Viewer")]
[Description("If true, the map being viewed will have all its tiled groups converted to non-tiled groups. Tiled groups are not supported by this viewer and are not rendered")]
@@ -1267,7 +1303,7 @@
public void ClearSelection()
{
//_provider.ClearSelection(_selection);
- _selection.LoadXml("");
+ _selection.LoadXml(string.Empty);
_map.Save();
if (_selectionImage != null)
@@ -2093,6 +2129,10 @@
return IsRasterClass(cls);
}
+ /// <summary>
+ /// Gets the current buffered image
+ /// </summary>
+ /// <returns></returns>
public System.Drawing.Image GetCurrentImage()
{
var bmp = new Bitmap(this.Width, this.Height);
@@ -2810,6 +2850,9 @@
handler(this, new PropertyChangedEventArgs(name));
}
+ /// <summary>
+ /// Gets whether this viewer has a loaded map
+ /// </summary>
public bool HasLoadedMap { get { return _map != null; } }
private bool? _hasTiledLayers;
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/IWorkbenchInitializer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/IWorkbenchInitializer.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/IWorkbenchInitializer.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -25,15 +25,43 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// Initializes the main window
+ /// </summary>
public interface IWorkbenchInitializer
{
+ /// <summary>
+ /// Gets the main window icon
+ /// </summary>
+ /// <returns></returns>
Icon GetIcon();
+ /// <summary>
+ /// Gets the main menu
+ /// </summary>
+ /// <param name="workbench"></param>
+ /// <returns></returns>
MenuStrip GetMainMenu(WorkbenchBase workbench);
+ /// <summary>
+ /// Gets the main toolstrip
+ /// </summary>
+ /// <param name="workbench"></param>
+ /// <returns></returns>
ToolStrip GetMainToolStrip(WorkbenchBase workbench);
+ /// <summary>
+ /// Updates the status of the menu items
+ /// </summary>
+ /// <param name="menu"></param>
+ /// <param name="toolstrips"></param>
void UpdateMenuItemStatus(MenuStrip menu, IEnumerable<ToolStrip> toolstrips);
-
+ /// <summary>
+ /// Gets the view content manager
+ /// </summary>
+ /// <returns></returns>
IViewContentManager GetViewContentManager();
-
+ /// <summary>
+ /// Gets the close icon for documents
+ /// </summary>
+ /// <returns></returns>
Image GetDocumentCloseIcon();
}
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/Collections.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/Collections.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/Collections.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -276,7 +276,7 @@
/// -or-
/// The number of elements in the source <see cref="T:System.Collections.Generic.ICollection`1"/> is greater than the available space from <paramref name="arrayIndex"/> to the end of the destination <paramref name="array"/>.
/// -or-
- /// Type <paramref name="TVal"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
+ /// Type <typeparamref name="TVal"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
/// </exception>
public void CopyTo(TVal[] array, int arrayIndex)
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/MgServerConnectionBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/MgServerConnectionBase.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/MgServerConnectionBase.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -95,6 +95,9 @@
}
}
+ /// <summary>
+ /// Determines whether session auto-recover is possible
+ /// </summary>
protected bool _canAutoRestartSession;
/// <summary>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -858,15 +858,15 @@
public interface IRuleCollection
{
/// <summary>
- /// Gets the index of the specified rule
+ /// Gets the rule at the specified index
/// </summary>
- /// <param name="rule"></param>
+ /// <param name="index"></param>
/// <returns></returns>
IVectorRule GetRuleAt(int index);
/// <summary>
- /// Gets the rule at the specified index
+ /// Gets the index of the specified rule
/// </summary>
- /// <param name="index">The index.</param>
+ /// <param name="rule">The rule.</param>
/// <returns></returns>
int IndexOfRule(IVectorRule rule);
/// <summary>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LongTransaction.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LongTransaction.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LongTransaction.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -54,6 +54,9 @@
partial class FdoLongTransactionList : ILongTransactionList
{
+ /// <summary>
+ /// Gets the long transactions in this list
+ /// </summary>
public IEnumerable<ILongTransaction> Transactions
{
get
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Comparison/DiffEngine.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Comparison/DiffEngine.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Comparison/DiffEngine.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -302,7 +302,11 @@
_length.ToString());
}
#region IComparable Members
-
+ /// <summary>
+ /// Compares this instance against the specified object
+ /// </summary>
+ /// <param name="obj"></param>
+ /// <returns></returns>
public int CompareTo(object obj)
{
return _destIndex.CompareTo(((DiffResultSpan)obj)._destIndex);
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/BatchSettings.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/BatchSettings.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/BatchSettings.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -249,12 +249,21 @@
{
}
+ /// <summary>
+ /// Constructs a new batch setup
+ /// </summary>
+ /// <param name="connection"></param>
public BatchSettings(IServerConnection connection)
{
m_connection = connection;
m_maps = new List<BatchMap>();
}
+ /// <summary>
+ /// Constructs a new batch setup
+ /// </summary>
+ /// <param name="connection"></param>
+ /// <param name="maps"></param>
public BatchSettings(IServerConnection connection, params string[] maps)
{
m_connection = connection;
@@ -263,6 +272,10 @@
AddMapDefinitions(maps);
}
+ /// <summary>
+ /// Adds the specified map definition ids
+ /// </summary>
+ /// <param name="maps"></param>
public void AddMapDefinitions(string[] maps)
{
if (maps == null || maps.Length == 0 || (maps.Length == 1 && maps[0].Trim().Length == 0))
@@ -281,24 +294,40 @@
}
}
+ /// <summary>
+ /// Sets the list of scale indexes
+ /// </summary>
+ /// <param name="scaleindexes"></param>
public void SetScales(int[] scaleindexes)
{
foreach (BatchMap bm in m_maps)
bm.SetScales(scaleindexes);
}
+ /// <summary>
+ /// Sets the list of groups
+ /// </summary>
+ /// <param name="groups"></param>
public void SetGroups(string[] groups)
{
foreach (BatchMap bm in m_maps)
bm.SetGroups(groups);
}
+ /// <summary>
+ /// Limits the number of rows
+ /// </summary>
+ /// <param name="limit"></param>
public void LimitRows(long limit)
{
foreach (BatchMap bm in m_maps)
bm.LimitRows(limit);
}
+ /// <summary>
+ /// Limits the number of columns
+ /// </summary>
+ /// <param name="limit"></param>
public void LimitCols(long limit)
{
foreach (BatchMap bm in m_maps)
@@ -414,7 +443,9 @@
/// </summary>
public int ColTileOffset { get { return m_colTileOffset; } }
- //The map's scales may have been modified, this array is a map of the new values
+ /// <summary>
+ /// The map's scales may have been modified, this array is a map of the new values
+ /// </summary>
public int[] ScaleIndexMap { get { return m_scaleindexmap; } }
/// <summary>
@@ -440,7 +471,7 @@
}
}
- public void CalculateDimensions()
+ internal void CalculateDimensions()
{
int[] tmp = new int[this.Map.BaseMap.ScaleCount];
for (int i = 0; i < tmp.Length; i++)
@@ -449,7 +480,7 @@
SetScales(tmp);
}
- public void CalculateDimensionsInternal()
+ internal void CalculateDimensionsInternal()
{
if (m_mapdefinition.BaseMap.ScaleCount == 0)
{
@@ -520,6 +551,10 @@
}
}
+ /// <summary>
+ /// Sets the list of groups
+ /// </summary>
+ /// <param name="groups"></param>
public void SetGroups(string[] groups)
{
List<string> g = new List<string>();
@@ -530,6 +565,10 @@
m_groups = g.ToArray();
}
+ /// <summary>
+ /// Sets the list of scale indexes
+ /// </summary>
+ /// <param name="scaleindexes"></param>
public void SetScales(int[] scaleindexes)
{
//TODO: Re-read scales from mapdef?
@@ -555,18 +594,21 @@
m_scaleindexmap[i] = keys[i];
}
- public void LimitCols(long limit)
+ internal void LimitCols(long limit)
{
foreach (long[] d in m_dimensions)
d[1] = Math.Min(limit, d[1]);
}
- public void LimitRows(long limit)
+ internal void LimitRows(long limit)
{
foreach (long[] d in m_dimensions)
d[0] = Math.Min(limit, d[0]);
}
+ /// <summary>
+ /// Gets the total number of tiles to be rendered
+ /// </summary>
public long TotalTiles
{
get
@@ -693,25 +735,79 @@
public BatchSettings Parent { get { return m_parent; } }
}
+ /// <summary>
+ /// Parameters for a tiling run
+ /// </summary>
public class TileSettings
{
+ /// <summary>
+ /// The meters per unit
+ /// </summary>
public double MetersPerUnit = 1;
+
+ /// <summary>
+ /// The display DPI
+ /// </summary>
public double DPI = 96;
+
+ /// <summary>
+ /// The tile width
+ /// </summary>
public int TileWidth = 300;
+
+ /// <summary>
+ /// The tile height
+ /// </summary>
public int TileHeight = 300;
+
+ /// <summary>
+ /// The number of times to retry
+ /// </summary>
public int RetryCount = 5;
+
+ /// <summary>
+ /// The display resolution width
+ /// </summary>
public int DisplayResolutionWidth = 1920;
+
+ /// <summary>
+ /// The display resolution height
+ /// </summary>
public int DisplayResolutionHeight = 1280;
+
+ /// <summary>
+ /// Gets or sets whether to use the official method of tile generation. Requires an accurate meters per unit value to work
+ /// </summary>
public bool UseOfficialMethod = false;
+
+ /// <summary>
+ /// Gets or sets whether to randomize the tile generation sequence
+ /// </summary>
public bool RandomizeTileSequence = false;
private int m_threadCount = 1;
+
+ /// <summary>
+ /// Gets or sets the thread count
+ /// </summary>
public int ThreadCount
{
get { return m_threadCount; }
set { m_threadCount = Math.Max(1, value); }
}
+ /// <summary>
+ /// The render method
+ /// </summary>
public RenderMethodDelegate RenderMethod;
+
+ /// <summary>
+ /// Defines a tile render method
+ /// </summary>
+ /// <param name="map"></param>
+ /// <param name="group"></param>
+ /// <param name="col"></param>
+ /// <param name="row"></param>
+ /// <param name="scale"></param>
public delegate void RenderMethodDelegate(string map, string group, int col, int row, int scale);
}
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/RenderThread.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/RenderThread.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Tile/RenderThread.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -26,7 +26,7 @@
namespace OSGeo.MapGuide.MaestroAPI.Tile
{
- public class RenderThreads
+ internal class RenderThreads
{
private class EventPassing
{
@@ -296,11 +296,13 @@
/// <summary>
/// Renders a single tile
/// </summary>
+ /// <param name="ev"></param>
+ /// <param name="tileSvc"></param>
/// <param name="row">The row index of the tile</param>
/// <param name="col">The column index of the tile</param>
/// <param name="scaleindex">The scale index of the tile</param>
/// <param name="group">The name of the baselayer group</param>
- public void RenderTile(EventWaitHandle ev, ITileService tileSvc, long row, long col, int scaleindex, string group)
+ private void RenderTile(EventWaitHandle ev, ITileService tileSvc, long row, long col, int scaleindex, string group)
{
ev.Reset();
lock (SyncLock)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -40,6 +40,9 @@
/// </summary>
public class Utility
{
+ /// <summary>
+ /// The exception data key that hints that an <see cref="T:System.Exception"/> thrown is related to XML content errors
+ /// </summary>
public const string XML_EXCEPTION_KEY = "XmlError"; //NOXLATE
/// <summary>
@@ -978,6 +981,11 @@
return element;
}
+ /// <summary>
+ /// Explodes a themed layer into filtered sub-layers where each sub-layer is filtered on the individual theme rule's filter
+ /// </summary>
+ /// <param name="options"></param>
+ /// <param name="progress"></param>
public static void ExplodeThemeIntoFilteredLayers(ExplodeThemeOptions options, LengthyOperationProgressCallBack progress)
{
var conn = options.Layer.CurrentConnection;
@@ -1064,6 +1072,15 @@
const string RESERVED_CHARS = "\\:*?\"<>|&'%=/";
+ /// <summary>
+ /// Generates a unique layer name for a given vector rule
+ /// </summary>
+ /// <param name="layerFormat"></param>
+ /// <param name="layerName"></param>
+ /// <param name="scaleRange"></param>
+ /// <param name="i"></param>
+ /// <param name="rule"></param>
+ /// <returns></returns>
public static string GenerateLayerName(string layerFormat, string layerName, string scaleRange, int i, IVectorRule rule)
{
StringBuilder sb = new StringBuilder(string.Format(layerFormat, layerName, scaleRange, string.IsNullOrEmpty(rule.LegendLabel) ? ("Rule" + i) : rule.LegendLabel)); //NOXLATE
@@ -1074,6 +1091,11 @@
return sb.ToString().Trim();
}
+ /// <summary>
+ /// String-ifies a scale range
+ /// </summary>
+ /// <param name="parentRange"></param>
+ /// <returns></returns>
public static string GetScaleRangeStr(IVectorScaleRange parentRange)
{
return string.Format("{0} to {1}", //NOXLATE
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/LocalConnection.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/LocalConnection.cs 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/LocalConnection.cs 2012-10-25 15:08:19 UTC (rev 7156)
@@ -55,8 +55,6 @@
return new LocalConnection(initParams);
}
- static bool _init = false;
-
private MgServiceFactory _fact;
protected LocalConnection(NameValueCollection initParams) : base()
@@ -68,7 +66,6 @@
var sw = new Stopwatch();
sw.Start();
MgPlatform.Initialize(_configFile);
- _init = true;
sw.Stop();
Trace.TraceInformation("MapGuide Platform initialized in {0}ms", sw.ElapsedMilliseconds);
}
Property changes on: trunk/Tools/Maestro/SDK/Samples/HelloAddIn
___________________________________________________________________
Added: svn:ignore
+ bin
obj
Modified: trunk/Tools/Maestro/Thirdparty/SharpDevelop/ICSharpCode.Core/ICSharpCode.Core.csproj
===================================================================
--- trunk/Tools/Maestro/Thirdparty/SharpDevelop/ICSharpCode.Core/ICSharpCode.Core.csproj 2012-10-25 12:13:57 UTC (rev 7155)
+++ trunk/Tools/Maestro/Thirdparty/SharpDevelop/ICSharpCode.Core/ICSharpCode.Core.csproj 2012-10-25 15:08:19 UTC (rev 7156)
@@ -42,7 +42,8 @@
<OutputPath>bin\Release\</OutputPath>
<WarningLevel>4</WarningLevel>
<DebugType>None</DebugType>
- <DocumentationFile>bin\Release\ICSharpCode.Core.xml</DocumentationFile>
+ <DocumentationFile>
+ </DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition=" '$(Platform)' == 'AnyCPU' ">
<RegisterForComInterop>False</RegisterForComInterop>
@@ -138,10 +139,6 @@
<Compile Include="Src\AddInTree\AddIn\DefaultDoozers\ToolBarItem\ITextBoxCommand.cs" />
</ItemGroup>
<ItemGroup>
- <Folder Include="Src\Services\LoggingService" />
- <Folder Include="Src\Services\AnalyticsMonitor" />
- <Folder Include="Src\Services\RegistryService" />
- <Folder Include="Src\Services\ResourceService" />
<Content Include="..\..\..\..\data\schemas\AddIn.xsd">
<Link>Src\AddInTree\AddIn\AddIn.xsd</Link>
</Content>
More information about the mapguide-commits
mailing list