[mapguide-commits] r7962 - in trunk/Tools/Maestro: Generated Maestro.AddIn.Local Maestro.Base Maestro.Base/Commands/SiteExplorer Maestro.Base/Editor Maestro.Base/Services Maestro.Base/UI Maestro.Base/UI/Preferences Maestro.Editors/Common Maestro.Editors/FeatureSource Maestro.Editors/Generic Maestro.Editors/Generic/XmlEditor Maestro.Editors/Generic/XmlEditor/AutoCompletion Maestro.Editors/LayerDefinition/Vector/Scales Maestro.Editors/MapDefinition Maestro.Editors/Preview Maestro.Login Maestro.MapViewer Maestro.Shared.UI OSGeo.MapGuide.MaestroAPI OSGeo.MapGuide.MaestroAPI/Commands OSGeo.MapGuide.MaestroAPI/Mapping OSGeo.MapGuide.MaestroAPI/ObjectModels OSGeo.MapGuide.MaestroAPI/Resource/Conversion OSGeo.MapGuide.MaestroAPI.Local
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Mon Dec 23 07:14:25 PST 2013
Author: jng
Date: 2013-12-23 07:14:25 -0800 (Mon, 23 Dec 2013)
New Revision: 7962
Modified:
trunk/Tools/Maestro/Generated/RuntimeMap-2.6.0.designer.cs
trunk/Tools/Maestro/Maestro.AddIn.Local/Maestro.AddIn.Local.csproj
trunk/Tools/Maestro/Maestro.Base/Commands/SiteExplorer/TestResourceCompatibilityCommand.cs
trunk/Tools/Maestro/Maestro.Base/Editor/DrawingSourceEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs
trunk/Tools/Maestro/Maestro.Base/Editor/FeatureSourceEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/FsEditorOptionPanel.cs
trunk/Tools/Maestro/Maestro.Base/Editor/FusionEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/LayerDefinitionEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/LoadProcedureEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/MapDefinitionEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/PrintLayoutEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/ResourceEditorService.cs
trunk/Tools/Maestro/Maestro.Base/Editor/SymbolDefinitionEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/UnsupportedEditorControl.cs
trunk/Tools/Maestro/Maestro.Base/Editor/WatermarkDefinitionEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/WebLayoutEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditor.cs
trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs
trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs
trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs
trunk/Tools/Maestro/Maestro.Base/UI/ConfirmDeleteResourcesDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs
trunk/Tools/Maestro/Maestro.Base/UI/ProfilingDialog.cs
trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs
trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs
trunk/Tools/Maestro/Maestro.Base/UI/ResourcePropertiesDialog.cs
trunk/Tools/Maestro/Maestro.Base/Workbench.cs
trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs
trunk/Tools/Maestro/Maestro.Editors/Common/EditorWindow.cs
trunk/Tools/Maestro/Maestro.Editors/Common/ExpressionEditor.cs
trunk/Tools/Maestro/Maestro.Editors/Common/IExpressionEditor.cs
trunk/Tools/Maestro/Maestro.Editors/Common/ITextEditor.cs
trunk/Tools/Maestro/Maestro.Editors/Common/TextEditor.cs
trunk/Tools/Maestro/Maestro.Editors/FeatureSource/CreateLayersFromFeatureSourceDialog.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedName.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedNameCollection.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlCompletionDataCollection.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlElementPath.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlParser.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaAssociation.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionData.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionDataCollection.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaManager.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlEditorOptions.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFoldingStrategy.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFormattingStrategy.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlTextEditorControl.cs
trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/SymbolInstancePropertiesDialog.cs
trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/VectorScaleRangeCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs
trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapDefinitionEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/Preview/DefaultResourcePreviewer.cs
trunk/Tools/Maestro/Maestro.Editors/Preview/LocalMapPreviewer.cs
trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewEngine.cs
trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewFactory.cs
trunk/Tools/Maestro/Maestro.Editors/Preview/StubPreviewer.cs
trunk/Tools/Maestro/Maestro.Login/LocalNativeStubCtrl.cs
trunk/Tools/Maestro/Maestro.Login/LocalStubCtrl.cs
trunk/Tools/Maestro/Maestro.MapViewer/DefaultToolbar.cs
trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs
trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs
trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs
trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs
trunk/Tools/Maestro/Maestro.Shared.UI/BusyWaitDialog.cs
trunk/Tools/Maestro/Maestro.Shared.UI/IViewContentManager.cs
trunk/Tools/Maestro/Maestro.Shared.UI/ServiceBase.cs
trunk/Tools/Maestro/Maestro.Shared.UI/SingletonViewContent.cs
trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentBase.cs
trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentManagerBase.cs
trunk/Tools/Maestro/Maestro.Shared.UI/WorkbenchBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/OSGeo.MapGuide.MaestroAPI.Local.csproj
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommandImpl.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommands.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapImpl.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/ImageSymbolConverter.cs
Log:
Maestro API cleanup:
- Fix a boatload of compiler warnings, most concerning missing XML documentation and documentation of non-existent method parameters.
- Internalize some previously public classes. These are mostly UI and/or supporting utility classes that should never have been public in the first place.
Modified: trunk/Tools/Maestro/Generated/RuntimeMap-2.6.0.designer.cs
===================================================================
--- trunk/Tools/Maestro/Generated/RuntimeMap-2.6.0.designer.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Generated/RuntimeMap-2.6.0.designer.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -1,3 +1,4 @@
+#pragma warning disable 1591, 0114, 0108
// ------------------------------------------------------------------------------
// <auto-generated>
// Generated by Xsd2Code. Version 3.3.0.2211
Modified: trunk/Tools/Maestro/Maestro.AddIn.Local/Maestro.AddIn.Local.csproj
===================================================================
--- trunk/Tools/Maestro/Maestro.AddIn.Local/Maestro.AddIn.Local.csproj 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.AddIn.Local/Maestro.AddIn.Local.csproj 2013-12-23 15:14:25 UTC (rev 7962)
@@ -43,6 +43,7 @@
<DefineConstants>DEBUG;TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
+ <PlatformTarget>x86</PlatformTarget>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType>
@@ -51,6 +52,7 @@
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
+ <PlatformTarget>x86</PlatformTarget>
</PropertyGroup>
<ItemGroup>
<Reference Include="OSGeo.MapGuide.Desktop, Version=2.4.0.6897, Culture=neutral, PublicKeyToken=e75f9fd7cf82dc3f, processorArchitecture=x86">
Modified: trunk/Tools/Maestro/Maestro.Base/Commands/SiteExplorer/TestResourceCompatibilityCommand.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Commands/SiteExplorer/TestResourceCompatibilityCommand.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Commands/SiteExplorer/TestResourceCompatibilityCommand.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -31,6 +31,8 @@
using OSGeo.MapGuide.MaestroAPI.Resource;
using OSGeo.MapGuide.ObjectModels.Common;
+#pragma warning disable 1591
+
namespace Maestro.Base.Commands.SiteExplorer
{
internal class TestResourceCompatibilityCommand : AbstractMenuCommand
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/DrawingSourceEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/DrawingSourceEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/DrawingSourceEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -29,8 +29,16 @@
using Maestro.Editors;
using Maestro.Editors.DrawingSource;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Drawing Source resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class DrawingSourceEditor : EditorContentBase
{
public DrawingSourceEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/EditorContentBase.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -37,11 +37,16 @@
using Maestro.Base.Services;
using Maestro.Editors.Preview;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
/// <summary>
/// The base class of all editor views
/// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class EditorContentBase : ViewContentBase, IEditorViewContent
{
public EditorContentBase()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/FeatureSourceEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/FeatureSourceEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/FeatureSourceEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -30,8 +30,16 @@
using OSGeo.MapGuide.ObjectModels.MapDefinition;
using Maestro.Editors.FeatureSource;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Feature Source resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class FeatureSourceEditor : EditorContentBase
{
public FeatureSourceEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/FsEditorOptionPanel.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/FsEditorOptionPanel.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/FsEditorOptionPanel.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -39,7 +39,7 @@
namespace Maestro.Base.Editor
{
- public partial class FsEditorOptionPanel : EditorBindableCollapsiblePanel
+ internal partial class FsEditorOptionPanel : EditorBindableCollapsiblePanel
{
public FsEditorOptionPanel()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/FusionEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/FusionEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/FusionEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -28,8 +28,16 @@
using OSGeo.MapGuide.MaestroAPI.Resource;
using Maestro.Editors.Fusion;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Application Definition (Flexible Layout) resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class FusionEditor: EditorContentBase
{
public FusionEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/LayerDefinitionEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/LayerDefinitionEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/LayerDefinitionEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -34,8 +34,16 @@
using Maestro.Base.UI.Preferences;
using OSGeo.MapGuide.ObjectModels.MapDefinition;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Layer Definition resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class LayerDefinitionEditor : EditorContentBase
{
public LayerDefinitionEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/LoadProcedureEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/LoadProcedureEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/LoadProcedureEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -27,8 +27,16 @@
using Maestro.Editors.LoadProcedure;
using OSGeo.MapGuide.ObjectModels.LoadProcedure;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Load Procedure resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class LoadProcedureEditor : EditorContentBase
{
public LoadProcedureEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/MapDefinitionEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/MapDefinitionEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/MapDefinitionEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -30,8 +30,16 @@
using OSGeo.MapGuide.ObjectModels.MapDefinition;
using Maestro.Editors.MapDefinition;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Map Definition resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class MapDefinitionEditor : EditorContentBase
{
public MapDefinitionEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/PrintLayoutEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/PrintLayoutEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/PrintLayoutEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -26,8 +26,16 @@
using System.Windows.Forms;
using Maestro.Editors.PrintLayout;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Print Layout resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class PrintLayoutEditor : EditorContentBase
{
public PrintLayoutEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/ResourceEditorService.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/ResourceEditorService.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/ResourceEditorService.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -36,7 +36,7 @@
namespace Maestro.Base.Editor
{
- public class ResourceEditorService : ResourceEditorServiceBase
+ internal class ResourceEditorService : ResourceEditorServiceBase
{
private IUrlLauncherService _launcher;
private ISiteExplorer _siteExp;
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/SymbolDefinitionEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/SymbolDefinitionEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/SymbolDefinitionEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -27,8 +27,16 @@
using Maestro.Editors.SymbolDefinition;
using OSGeo.MapGuide.ObjectModels.SymbolDefinition;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Symbol Definition resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class SymbolDefinitionEditor : EditorContentBase
{
public SymbolDefinitionEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/UnsupportedEditorControl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/UnsupportedEditorControl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/UnsupportedEditorControl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -30,7 +30,7 @@
/// <summary>
/// A placeholder control for resource sub-types that cannot be edited with a specialized editor
/// </summary>
- public partial class UnsupportedEditorControl : UserControl
+ internal partial class UnsupportedEditorControl : UserControl
{
public UnsupportedEditorControl()
{
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/WatermarkDefinitionEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/WatermarkDefinitionEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/WatermarkDefinitionEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -28,8 +28,16 @@
using Maestro.Editors;
using Maestro.Editors.WatermarkDefinition;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Watermark Definition resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class WatermarkDefinitionEditor : EditorContentBase
{
public WatermarkDefinitionEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/WebLayoutEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/WebLayoutEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/WebLayoutEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -26,8 +26,16 @@
using System.Windows.Forms;
using Maestro.Editors.WebLayout;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A specialized editor for Web Layout resources.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class WebLayoutEditor : EditorContentBase
{
public WebLayoutEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -39,8 +39,16 @@
using Maestro.Editors.Common;
using Maestro.Editors.Preview;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A generic XML editor for any resource.
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class XmlEditor : EditorContentBase
{
public XmlEditor()
Modified: trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Editor/XmlEditorDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -33,8 +33,16 @@
using Maestro.Base.UI.Preferences;
using ICSharpCode.Core;
+#pragma warning disable 1591
+
namespace Maestro.Base.Editor
{
+ /// <summary>
+ /// A generic XML editor for any resource, housed within a dialog
+ /// </summary>
+ /// <remarks>
+ /// Although public, this class is undocumented and reserved for internal use by built-in Maestro AddIns
+ /// </remarks>
public partial class XmlEditorDialog : Form, INotifyResourceChanged
{
private XmlEditorCtrl _ed;
Modified: trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Services/OpenResourceManager.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -164,7 +164,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 <param name="useXmlEditor"/> is true, the resource will be opened in the default
+ /// editor or useXmlEditor is true, the resource will be opened in the default
/// XML editor.
/// </summary>
/// <param name="res"></param>
@@ -244,12 +244,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 <param name="useXmlEditor"/> is true, the resource will be opened in the default
+ /// editor or useXmlEditor is true, the resource will be opened in the default
/// XML editor.
/// </summary>
/// <param name="resourceId"></param>
/// <param name="conn"></param>
/// <param name="useXmlEditor"></param>
+ /// <param name="siteExp"></param>
public IEditorViewContent Open(string resourceId, IServerConnection conn, bool useXmlEditor, ISiteExplorer siteExp)
{
IResource res = null;
Modified: trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Services/ServerConnectionManager.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -45,12 +45,19 @@
/// </summary>
public class ServerConnectionRemovingEventArgs : CancelEventArgs
{
+ /// <summary>
+ /// Initializes a new instance of the ServerConnectionRemovingEventArgs class
+ /// </summary>
+ /// <param name="name"></param>
public ServerConnectionRemovingEventArgs(string name)
{
this.ConnectionName = name;
base.Cancel = false;
}
+ /// <summary>
+ /// Gets the name of the connection that is about to be closed
+ /// </summary>
public string ConnectionName { get; set; }
}
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ConfirmDeleteResourcesDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ConfirmDeleteResourcesDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ConfirmDeleteResourcesDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -28,6 +28,10 @@
namespace Maestro.Base.UI
{
+ /// <summary>
+ /// A dialog that is used to provide a detailed confirmation prompt when deleting a resource
+ /// with dependent resources.
+ /// </summary>
public partial class ConfirmDeleteResourcesDialog : Form
{
private ConfirmDeleteResourcesDialog()
@@ -35,6 +39,10 @@
InitializeComponent();
}
+ /// <summary>
+ /// Initializes a new instance of the ConfirmDeleteResourcesDialog class
+ /// </summary>
+ /// <param name="dependents"></param>
public ConfirmDeleteResourcesDialog(IEnumerable<Editors.RepositoryHandle> dependents)
: this()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/UI/Preferences/ConfigProperties.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -136,6 +136,9 @@
Props.Set(ConfigProperties.LiveMapEditorPath, DefaultLiveMapEditorPath);
}
+ /// <summary>
+ /// Default locale setting for web-based resource previews
+ /// </summary>
public static string DefaultPreviewLocale { get { return "en"; } } //NOXLATE
/// <summary>
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ProfilingDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ProfilingDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ProfilingDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -38,6 +38,9 @@
namespace Maestro.Base.UI
{
+ /// <summary>
+ /// A dialog that profiles a given resource for performance
+ /// </summary>
public partial class ProfilingDialog : Form
{
private IServerConnection m_connection;
@@ -46,6 +49,12 @@
private RuntimeMap m_tempmap;
+ /// <summary>
+ /// Initializes a new instance of the ProfilingDialog class
+ /// </summary>
+ /// <param name="item"></param>
+ /// <param name="resourceId"></param>
+ /// <param name="connection"></param>
public ProfilingDialog(IResource item, string resourceId, IServerConnection connection)
: this()
{
Modified: trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/UI/RepositoryTreeModel.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -114,6 +114,11 @@
return _children.ContainsKey(name);
}
+ /// <summary>
+ /// Gets the child RepositoryItem by its name
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public RepositoryItem this[string name]
{
get { return _children[name]; }
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ResourceIdNavigator.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -129,8 +129,6 @@
}
}
- private bool bNoRaiseEvents = false;
-
void OnViewActivated(object sender, Shared.UI.IViewContent content)
{
var ed = content as IEditorViewContent;
Modified: trunk/Tools/Maestro/Maestro.Base/UI/ResourcePropertiesDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/UI/ResourcePropertiesDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/UI/ResourcePropertiesDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -40,6 +40,9 @@
namespace Maestro.Base.UI
{
+ /// <summary>
+ /// A dialog that displays various properties of a given resource
+ /// </summary>
public partial class ResourcePropertiesDialog : Form
{
private ResourcePropertiesDialog()
@@ -92,6 +95,14 @@
private OpenResourceManager _openMgr;
private ISiteExplorer _siteExp;
+ /// <summary>
+ /// Initializes a new instance of the ResourcePropertiesDialog class
+ /// </summary>
+ /// <param name="icons"></param>
+ /// <param name="connection"></param>
+ /// <param name="resourceId"></param>
+ /// <param name="openMgr"></param>
+ /// <param name="siteExp"></param>
public ResourcePropertiesDialog(IResourceIconCache icons, IServerConnection connection, string resourceId, OpenResourceManager openMgr, ISiteExplorer siteExp)
: this()
{
@@ -105,6 +116,10 @@
InReferenceList.SmallImageList = OutReferenceList.SmallImageList = icons.SmallImageList;
}
+ /// <summary>
+ /// Raises the System.Windows.Forms.Form.Load event
+ /// </summary>
+ /// <param name="e"></param>
protected override void OnLoad(EventArgs e)
{
Dictionary<string, ListViewItem> ul = new Dictionary<string, ListViewItem>();
Modified: trunk/Tools/Maestro/Maestro.Base/Workbench.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Workbench.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/Workbench.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -30,6 +30,9 @@
namespace Maestro.Base
{
+ /// <summary>
+ /// The top level application window
+ /// </summary>
public partial class Workbench : WorkbenchBase
{
static Workbench instance;
@@ -99,6 +102,11 @@
/// </summary>
public event EventHandler ActiveDocumentChanged;
+ /// <summary>
+ /// Raises the ActiveDocumentChanged event
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="content"></param>
protected override void OnViewActivated(object sender, IViewContent content)
{
var h = this.ActiveDocumentChanged;
@@ -106,6 +114,10 @@
h(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Initializes a new instance of the Workbench class
+ /// </summary>
+ /// <param name="init">The workbench initializer</param>
public Workbench(IWorkbenchInitializer init) : base(init) { }
}
}
Modified: trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Base/WorkbenchInitializer.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -32,8 +32,15 @@
/// </summary>
public class WorkbenchInitializer : IWorkbenchInitializer
{
+ /// <summary>
+ /// Initializes a new instance of the WorkbenchInitializer class
+ /// </summary>
+ /// <param name="bStartMaximized"></param>
public WorkbenchInitializer(bool bStartMaximized) { this.StartMaximized = bStartMaximized; }
+ /// <summary>
+ /// Gets whether the workbench will start fully maximized
+ /// </summary>
public bool StartMaximized { get; private set; }
/// <summary>
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/EditorWindow.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/EditorWindow.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/EditorWindow.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -110,6 +110,11 @@
//infrastructure and not available in this standalone library
private Generic.XmlEditorCtrl _ed;
+ /// <summary>
+ /// Initializes a new instance of the EditorWindow class
+ /// </summary>
+ /// <param name="conn"></param>
+ /// <param name="resourceId"></param>
public EditorWindow(IServerConnection conn, string resourceId)
: this()
{
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/ExpressionEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/ExpressionEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/ExpressionEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -59,6 +59,10 @@
_contextualBuffer = new StringBuilder();
}
+ /// <summary>
+ /// Raises the System.Windows.Forms.Form.Load event.
+ /// </summary>
+ /// <param name="e"></param>
protected override void OnLoad(EventArgs e)
{
_editor.SetParent(ExpressionText);
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/IExpressionEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/IExpressionEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/IExpressionEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -48,10 +48,14 @@
/// </summary>
string Expression { get; set; }
+ /// <summary>
+ /// Shows the form as a modal dialog box
+ /// </summary>
+ /// <returns></returns>
System.Windows.Forms.DialogResult ShowDialog();
}
- public static class FdoExpressionEditorFactory
+ internal static class FdoExpressionEditorFactory
{
public static IExpressionEditor Create()
{
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/ITextEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/ITextEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/ITextEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -151,7 +151,7 @@
/// <summary>
/// Sets the parent control for this editor
/// </summary>
- /// <param name="frm"></param>
+ /// <param name="ctrl"></param>
void SetParent(System.Windows.Forms.Control ctrl);
}
}
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/TextEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/TextEditor.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/TextEditor.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -42,7 +42,7 @@
namespace Maestro.Editors.Common
{
- public abstract class TextEditorBase : ITextEditor
+ internal abstract class TextEditorBase : ITextEditor
{
delegate string GetLineInvoker(int index);
delegate void WriteInvoker(string text, Color color, Color fore);
@@ -242,8 +242,16 @@
public virtual void SetParent(Control frm) { }
}
+ /// <summary>
+ /// Resolves the appropriate ITextEditor instance for the given text editor
+ /// </summary>
public static class TextEditorFactory
{
+ /// <summary>
+ /// Creates the appropriate ITextEditor instance for the given text editor
+ /// </summary>
+ /// <param name="textEditor">The text editor instance</param>
+ /// <returns></returns>
public static ITextEditor CreateEditor(TextEditorControl textEditor)
{
if (Platform.IsRunningOnMono)
@@ -285,7 +293,7 @@
{
//Not ready for beta 5. Remove after release of beta 5.
return;
-
+ /*
var context = new AutoCompletionListBox.AutoCompleteContext()
{
AutoCompleteTooltip = _autoCompleteTooltip,
@@ -296,6 +304,7 @@
InsertionOffset = textEditorControl.ActiveTextAreaControl.Caret.Offset
};
_autoBox.SetCompletionItems(textEditorControl.ParentForm, context, string.Empty);
+ */
}
private Point GetCaretPoint()
Modified: trunk/Tools/Maestro/Maestro.Editors/FeatureSource/CreateLayersFromFeatureSourceDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/FeatureSource/CreateLayersFromFeatureSourceDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/FeatureSource/CreateLayersFromFeatureSourceDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -31,6 +31,10 @@
namespace Maestro.Editors.FeatureSource
{
+ /// <summary>
+ /// A dialog that allows for the easy creation of Layer Definitions with default styles from one or more selected
+ /// feature classes in the given feature source
+ /// </summary>
public partial class CreateLayersFromFeatureSourceDialog : Form
{
private CreateLayersFromFeatureSourceDialog()
@@ -40,6 +44,11 @@
private IServerConnection _conn;
+ /// <summary>
+ /// Initializes a new instance of the CreateLayersFromFeatureSourceDialog class
+ /// </summary>
+ /// <param name="conn"></param>
+ /// <param name="featureSource"></param>
public CreateLayersFromFeatureSourceDialog(IServerConnection conn, string featureSource)
: this()
{
@@ -47,6 +56,10 @@
txtFeatureSource.Text = featureSource;
}
+ /// <summary>
+ /// Raises the System.Windows.Forms.Form.Load event.
+ /// </summary>
+ /// <param name="e"></param>
protected override void OnLoad(EventArgs e)
{
LoadFeatureClassesAsync();
@@ -81,16 +94,25 @@
lstFeatureClasses.SelectedItems.Count > 0;
}
+ /// <summary>
+ /// Gets the selected Feature Source
+ /// </summary>
public string FeatureSource
{
get { return txtFeatureSource.Text; }
}
+ /// <summary>
+ /// Gets the selected target folder where default Layer Definitions will be created
+ /// </summary>
public string TargetFolder
{
get { return txtCreateTargetFolder.Text; }
}
-
+
+ /// <summary>
+ /// Gets the selected feature classes to create default Layer Definition documents for
+ /// </summary>
public string[] FeatureClasses
{
get
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedName.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedName.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedName.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -45,7 +45,7 @@
/// class just adds this extra information alongside the
/// <see cref="XmlQualifiedName"/>.
/// </remarks>
- public class QualifiedName
+ internal class QualifiedName
{
XmlQualifiedName xmlQualifiedName = XmlQualifiedName.Empty;
string prefix = String.Empty;
@@ -111,6 +111,10 @@
return equals;
}
+ /// <summary>
+ /// Returns the hash code for the QualifiedName
+ /// </summary>
+ /// <returns></returns>
public override int GetHashCode()
{
return xmlQualifiedName.GetHashCode();
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedNameCollection.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedNameCollection.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/QualifiedNameCollection.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -40,7 +40,7 @@
/// A collection that stores <see cref='QualifiedName'/> objects.
/// </summary>
[Serializable()]
- public class QualifiedNameCollection : CollectionBase
+ internal class QualifiedNameCollection : CollectionBase
{
/// <summary>
@@ -96,7 +96,6 @@
/// </summary>
/// <param name='val'>The <see cref='QualifiedName'/> to add.</param>
/// <returns>The index at which the new element was inserted.</returns>
- /// <seealso cref='QualifiedNameCollection.AddRange'/>
public int Add(QualifiedName val)
{
return List.Add(val);
@@ -157,11 +156,11 @@
/// <para><paramref name='array'/> is multidimensional.</para>
/// <para>-or-</para>
/// <para>The number of elements in the <see cref='QualifiedNameCollection'/> is greater than
- /// the available space between <paramref name='arrayIndex'/> and the end of
+ /// the available space between <paramref name='index'/> and the end of
/// <paramref name='array'/>.</para>
/// </exception>
/// <exception cref='ArgumentNullException'><paramref name='array'/> is <see langword='null'/>. </exception>
- /// <exception cref='ArgumentOutOfRangeException'><paramref name='arrayIndex'/> is less than <paramref name='array'/>'s lowbound. </exception>
+ /// <exception cref='ArgumentOutOfRangeException'><paramref name='index'/> is less than <paramref name='array'/>'s lowbound. </exception>
/// <seealso cref='Array'/>
public void CopyTo(QualifiedName[] array, int index)
{
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlCompletionDataCollection.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlCompletionDataCollection.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlCompletionDataCollection.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -100,7 +100,6 @@
/// </remarks>
/// <param name='val'>The <see cref='XmlCompletionData'/> to add.</param>
/// <returns>The index at which the new element was inserted.</returns>
- /// <seealso cref='XmlCompletionDataCollection.AddRange'/>
public int Add(XmlCompletionData val)
{
int index = -1;
@@ -195,11 +194,11 @@
/// <para><paramref name='array'/> is multidimensional.</para>
/// <para>-or-</para>
/// <para>The number of elements in the <see cref='XmlCompletionDataCollection'/> is greater than
- /// the available space between <paramref name='arrayIndex'/> and the end of
+ /// the available space between <paramref name='index'/> and the end of
/// <paramref name='array'/>.</para>
/// </exception>
/// <exception cref='ArgumentNullException'><paramref name='array'/> is <see langword='null'/>. </exception>
- /// <exception cref='ArgumentOutOfRangeException'><paramref name='arrayIndex'/> is less than <paramref name='array'/>'s lowbound. </exception>
+ /// <exception cref='ArgumentOutOfRangeException'><paramref name='index'/> is less than <paramref name='array'/>'s lowbound. </exception>
/// <seealso cref='Array'/>
public void CopyTo(XmlCompletionData[] array, int index)
{
@@ -224,7 +223,6 @@
/// The index of the <see cref='XmlCompletionData'/> of <paramref name='val'/> in the
/// <see cref='XmlCompletionDataCollection'/>, if found; otherwise, -1.
/// </returns>
- /// <seealso cref='XmlCompletionDataCollection.Contains'/>
public int IndexOf(XmlCompletionData val)
{
return List.IndexOf(val);
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlElementPath.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlElementPath.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlElementPath.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -39,7 +39,7 @@
/// Represents the path to an xml element starting from the root of the
/// document.
/// </summary>
- public class XmlElementPath
+ internal class XmlElementPath
{
QualifiedNameCollection elements = new QualifiedNameCollection();
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlParser.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlParser.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlParser.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -894,6 +894,8 @@
/// </summary>
/// <remarks>If the index outside the start tag then an empty path
/// is returned.</remarks>
+ /// <param name="index"></param>
+ /// <param name="xml"></param>
/// <param name="namespaces">Returns the namespaces that are
/// exist in the xml.</param>
static XmlElementPath GetActiveElementStartPath(string xml, int index, QualifiedNameCollection namespaces)
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaAssociation.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaAssociation.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaAssociation.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -38,7 +38,7 @@
/// <summary>
/// Represents an association between an xml schema and a file extension.
/// </summary>
- public class XmlSchemaAssociation //: IXmlConvertable
+ internal class XmlSchemaAssociation //: IXmlConvertable
{
string namespaceUri = String.Empty;
string extension = String.Empty;
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionData.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionData.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionData.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -48,7 +48,7 @@
/// this schema redefines the xml namespace, even though this is
/// allowed by the w3.org specification.
/// </remarks>
- public class XmlSchemaCompletionData
+ internal class XmlSchemaCompletionData
{
string namespaceUri = String.Empty;
XmlSchema schema;
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionDataCollection.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionDataCollection.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaCompletionDataCollection.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -40,7 +40,7 @@
/// A collection that stores <see cref='XmlSchemaCompletionData'/> objects.
/// </summary>
[Serializable()]
- public class XmlSchemaCompletionDataCollection : System.Collections.CollectionBase
+ internal class XmlSchemaCompletionDataCollection : System.Collections.CollectionBase
{
/// <summary>
@@ -122,7 +122,6 @@
/// </summary>
/// <param name='val'>The <see cref='XmlSchemaCompletionData'/> to add.</param>
/// <returns>The index at which the new element was inserted.</returns>
- /// <seealso cref='XmlSchemaCompletionDataCollection.AddRange'/>
public int Add(XmlSchemaCompletionData val)
{
return List.Add(val);
@@ -183,11 +182,11 @@
/// <para><paramref name='array'/> is multidimensional.</para>
/// <para>-or-</para>
/// <para>The number of elements in the <see cref='XmlSchemaCompletionDataCollection'/> is greater than
- /// the available space between <paramref name='arrayIndex'/> and the end of
+ /// the available space between <paramref name='index'/> and the end of
/// <paramref name='array'/>.</para>
/// </exception>
/// <exception cref='ArgumentNullException'><paramref name='array'/> is <see langword='null'/>. </exception>
- /// <exception cref='ArgumentOutOfRangeException'><paramref name='arrayIndex'/> is less than <paramref name='array'/>'s lowbound. </exception>
+ /// <exception cref='ArgumentOutOfRangeException'><paramref name='index'/> is less than <paramref name='array'/>'s lowbound. </exception>
/// <seealso cref='Array'/>
public void CopyTo(XmlSchemaCompletionData[] array, int index)
{
@@ -223,7 +222,6 @@
/// <summary>
/// Returns an enumerator that can iterate through the <see cref='XmlSchemaCompletionDataCollection'/>.
/// </summary>
- /// <seealso cref='IEnumerator'/>
public new XmlSchemaCompletionDataEnumerator GetEnumerator()
{
return new XmlSchemaCompletionDataEnumerator(this);
@@ -359,7 +357,6 @@
/// <summary>
/// Enumerator that can iterate through a XmlSchemaCompletionDataCollection.
/// </summary>
- /// <seealso cref='IEnumerator'/>
/// <seealso cref='XmlSchemaCompletionDataCollection'/>
/// <seealso cref='XmlSchemaCompletionData'/>
public class XmlSchemaCompletionDataEnumerator : System.Collections.IEnumerator
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaManager.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaManager.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/AutoCompletion/XmlSchemaManager.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -41,7 +41,7 @@
/// Keeps track of all the schemas that the Xml Editor is aware
/// of.
/// </summary>
- public class XmlSchemaManager
+ internal class XmlSchemaManager
{
public const string XmlSchemaNamespace = "http://www.w3.org/2001/XMLSchema";
@@ -82,7 +82,7 @@
/// <summary>
/// Gets the schemas that SharpDevelop knows about.
/// </summary>
- public XmlSchemaCompletionDataCollection SchemaCompletionDataItems
+ internal XmlSchemaCompletionDataCollection SchemaCompletionDataItems
{
get
{
@@ -94,7 +94,7 @@
/// Gets the schema completion data that is associated with the
/// specified file extension.
/// </summary>
- public XmlSchemaCompletionData GetSchemaCompletionData(string extension)
+ internal XmlSchemaCompletionData GetSchemaCompletionData(string extension)
{
XmlSchemaCompletionData data = null;
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlEditorOptions.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlEditorOptions.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlEditorOptions.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -36,16 +36,22 @@
namespace Maestro.Editors.Generic.XmlEditor
{
+ /// <summary>
+ /// Options for the generic XML editor
+ /// </summary>
public class XmlEditorOptions
{
static XmlEditorOptions()
{
- ShowSchemaAnnotation = true;
+ //ShowSchemaAnnotation = true;
ShowAttributesWhenFolded = true;
}
- public static bool ShowSchemaAnnotation { get; set; }
+ //public static bool ShowSchemaAnnotation { get; set; }
+ /// <summary>
+ /// Gets whether to show XML element attributes when the element is folded
+ /// </summary>
public static bool ShowAttributesWhenFolded { get; set; }
}
}
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFoldingStrategy.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFoldingStrategy.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFoldingStrategy.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -51,6 +51,13 @@
string name = String.Empty;
string foldText = String.Empty;
+ /// <summary>
+ /// Initializes a new instance of the XmlFoldStart class
+ /// </summary>
+ /// <param name="prefix"></param>
+ /// <param name="name"></param>
+ /// <param name="line"></param>
+ /// <param name="col"></param>
public XmlFoldStart(string prefix, string name, int line, int col)
{
this.line = line;
@@ -127,6 +134,9 @@
/// </summary>
bool showAttributesWhenFolded = false;
+ /// <summary>
+ /// Initializes a new instance of the XmlFoldingStrategy class
+ /// </summary>
public XmlFoldingStrategy()
{
}
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFormattingStrategy.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFormattingStrategy.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditor/XmlFormattingStrategy.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -47,7 +47,7 @@
/// This class currently inserts the closing tags to typed openening tags
/// and does smart indentation for xml files.
/// </summary>
- public class XmlFormattingStrategy : DefaultFormattingStrategy
+ internal class XmlFormattingStrategy : DefaultFormattingStrategy
{
public override void FormatLine(TextArea textArea, int lineNr, int caretOffset, char charTyped) // used for comment tag formater/inserter
{
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -98,6 +98,10 @@
txtXmlContent.TextChanged += new EventHandler(OnTextContentChanged);
}
+ /// <summary>
+ /// Initializes auto-completion data from the given XML Schema path
+ /// </summary>
+ /// <param name="xsdPath"></param>
public void LoadAutoCompletionData(string xsdPath)
{
txtXmlContent.SchemaCompletionDataItems = Maestro.Editors.Generic.XmlEditor.AutoCompletion.XmlSchemaManager.Instance.SchemaCompletionDataItems;
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlTextEditorControl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlTextEditorControl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlTextEditorControl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -51,6 +51,10 @@
Document.FoldingManager.FoldingStrategy = new XmlFoldingStrategy();
}
+ /// <summary>
+ /// Applies the given text editor properties
+ /// </summary>
+ /// <param name="props"></param>
public void ApplySettings(ITextEditorProperties props)
{
this.TextEditorProperties = props;
@@ -87,6 +91,10 @@
#region XML auto-completion stuff
+ /// <summary>
+ ///
+ /// </summary>
+ /// <param name="newControl"></param>
protected override void InitializeTextAreaControl(TextAreaControl newControl)
{
base.InitializeTextAreaControl(newControl);
@@ -117,7 +125,7 @@
/// allows us to share the completion data amongst multiple
/// xml editor controls.
/// </remarks>
- public XmlSchemaCompletionDataCollection SchemaCompletionDataItems
+ internal XmlSchemaCompletionDataCollection SchemaCompletionDataItems
{
get
{
@@ -133,7 +141,7 @@
/// Gets or sets the default schema completion data associated with this
/// view.
/// </summary>
- public XmlSchemaCompletionData DefaultSchemaCompletionData
+ internal XmlSchemaCompletionData DefaultSchemaCompletionData
{
get
{
@@ -289,7 +297,7 @@
/// CodeCompletionWindow.CaretOffsetChanged:
/// <code>[[!CDATA[ int offset = control.ActiveTextAreaControl.Caret.Offset;
///
- /// if (offset < startOffset || offset > endOffset) {
+ /// if (offset < startOffset || offset > endOffset) {
/// Close();
/// } else {
/// codeCompletionListView.SelectItemWithStart(control.Document.GetText(startOffset, offset - startOffset));
@@ -355,7 +363,7 @@
#endregion
}
- public class TextEditorProperties : ITextEditorProperties
+ internal class TextEditorProperties : ITextEditorProperties
{
public bool CaretLine
{
Modified: trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -53,7 +53,7 @@
/// </summary>
/// <param name="parent">The parent.</param>
/// <param name="styles">The styles.</param>
- public void Load(IVectorScaleRange2 parent, BindingList<ICompositeTypeStyle> styles)
+ public void LoadStyles(IVectorScaleRange2 parent, BindingList<ICompositeTypeStyle> styles)
{
_parent = parent;
foreach (var ctrl in _controls.Values)
Modified: trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/SymbolInstancePropertiesDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/SymbolInstancePropertiesDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/SymbolInstancePropertiesDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -32,7 +32,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class SymbolInstancePropertiesDialog : Form
+ internal partial class SymbolInstancePropertiesDialog : Form
{
private SymbolInstancePropertiesDialog()
{
Modified: trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/VectorScaleRangeCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/VectorScaleRangeCtrl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/VectorScaleRangeCtrl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -111,7 +111,7 @@
if (_cts.Count == 0)
_cts.Add(parent.Factory.CreateDefaultCompositeStyle());
- compList.Load(vsr2, _cts);
+ compList.LoadStyles(vsr2, _cts);
}
else
{
Modified: trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -161,7 +161,6 @@
}
Check.NotNull(layers, "layers");
- IEnvelope env = null;
int processed = 0;
//Begin
Modified: trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapDefinitionEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapDefinitionEditorCtrl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/MapDefinition/LiveMapDefinitionEditorCtrl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -96,6 +96,9 @@
private IMapDefinition _shadowCopy;
private IMappingService _mapSvc;
+ /// <summary>
+ /// Gets the runtime map being edited
+ /// </summary>
public RuntimeMap Map
{
get { return _rtMap; }
@@ -124,11 +127,17 @@
ReloadViewer();
}
+ /// <summary>
+ /// Rebuilds the current Runtime Map
+ /// </summary>
public void RebuildRuntimeMap()
{
_rtMap = _mapSvc.CreateMap(_shadowCopy);
}
+ /// <summary>
+ /// Reloads the current viewer
+ /// </summary>
public void ReloadViewer()
{
viewer.LoadMap(_rtMap);
Modified: trunk/Tools/Maestro/Maestro.Editors/Preview/DefaultResourcePreviewer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Preview/DefaultResourcePreviewer.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Preview/DefaultResourcePreviewer.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -39,6 +39,10 @@
{
private IUrlLauncherService _launcher;
+ /// <summary>
+ /// Initializes a new instance of the DefaultResourcePreviewer class
+ /// </summary>
+ /// <param name="launcher"></param>
public DefaultResourcePreviewer(IUrlLauncherService launcher)
{
_launcher = launcher;
Modified: trunk/Tools/Maestro/Maestro.Editors/Preview/LocalMapPreviewer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Preview/LocalMapPreviewer.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Preview/LocalMapPreviewer.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -32,22 +32,38 @@
namespace Maestro.Editors.Preview
{
+ /// <summary>
+ /// A resource previewer that uses the built-in map viewer component
+ /// </summary>
public class LocalMapPreviewer : IResourcePreviewer
{
private IResourcePreviewer _inner;
private IUrlLauncherService _launcher;
+ /// <summary>
+ /// Initializes a new instance of the LocalMapPreviewer class
+ /// </summary>
+ /// <param name="inner">The inner resource previewer</param>
+ /// <param name="launcher">The URL launcher service</param>
public LocalMapPreviewer(IResourcePreviewer inner, IUrlLauncherService launcher)
{
_inner = inner;
_launcher = launcher;
}
+ /// <summary>
+ /// Gets whether to use the built-in map viewer for previewing
+ /// </summary>
public bool UseLocal
{
get { return PreviewSettings.UseLocalPreview; }
}
+ /// <summary>
+ /// Gets whether the given resource is previewable with this previewer
+ /// </summary>
+ /// <param name="res"></param>
+ /// <returns></returns>
public bool IsPreviewable(IResource res)
{
if (this.UseLocal)
@@ -67,6 +83,11 @@
res.ResourceType == ResourceTypes.WatermarkDefinition;
}
+ /// <summary>
+ /// Previews the given resource
+ /// </summary>
+ /// <param name="res"></param>
+ /// <param name="edSvc"></param>
public void Preview(IResource res, IEditorService edSvc)
{
Preview(res, edSvc, null);
@@ -77,6 +98,12 @@
return Array.IndexOf(conn.Capabilities.SupportedServices, (int)ServiceType.Mapping) >= 0;
}
+ /// <summary>
+ /// Previews the given resource
+ /// </summary>
+ /// <param name="res"></param>
+ /// <param name="edSvc"></param>
+ /// <param name="locale"></param>
public void Preview(IResource res, IEditorService edSvc, string locale)
{
IServerConnection conn = res.CurrentConnection;
Modified: trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewEngine.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewEngine.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewEngine.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -32,11 +32,19 @@
namespace Maestro.Editors.Preview
{
+ /// <summary>
+ /// Performs any necessary setup required to preview a given resource in a web browser
+ /// </summary>
public class ResourcePreviewEngine
{
private string _rootUrl;
private IEditorService _edSvc;
+ /// <summary>
+ /// Initializes a new instance of the ResourcePreviewEngine class
+ /// </summary>
+ /// <param name="rootUrl"></param>
+ /// <param name="edSvc"></param>
public ResourcePreviewEngine(string rootUrl, IEditorService edSvc)
{
_rootUrl = rootUrl;
@@ -280,6 +288,12 @@
return url;
}
+ /// <summary>
+ /// Generates the appropriate viewer URL to preview the given resource under the given locale
+ /// </summary>
+ /// <param name="res"></param>
+ /// <param name="locale"></param>
+ /// <returns></returns>
public string GeneratePreviewUrl(IResource res, string locale)
{
switch (res.ResourceType)
Modified: trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewFactory.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewFactory.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Preview/ResourcePreviewFactory.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -37,7 +37,6 @@
/// </summary>
/// <param name="provider">The name of the connection provider</param>
/// <param name="previewer">The previewer implementation</param>
- /// <param name="launcher">The URL launcher</param>
public static void RegisterPreviewer(string provider, IResourcePreviewer previewer)
{
_previewers[provider.ToUpper()] = previewer;
Modified: trunk/Tools/Maestro/Maestro.Editors/Preview/StubPreviewer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Preview/StubPreviewer.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Editors/Preview/StubPreviewer.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -31,16 +31,36 @@
/// </summary>
public class StubPreviewer : IResourcePreviewer
{
+ /// <summary>
+ /// Gets whether the specified resource can be previewed
+ /// </summary>
+ /// <param name="res"></param>
+ /// <returns></returns>
public bool IsPreviewable(IResource res)
{
return false;
}
+ /// <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)
{
}
+ /// <summary>
+ /// Previews the specified resource using the given locale
+ /// </summary>
+ /// <param name="res">The resource to be previewed</param>
+ /// <param name="edSvc">The editor service</param>
+ /// <param name="locale">The locale</param>
+ /// <remarks>
+ /// The locale parameter should be treated as a hint. The underlying <see cref="T:OSGeo.MapGuide.MaestroAPI.IServerConnection"/> implementation
+ /// may not actually respect this value.
+ /// </remarks>
public void Preview(IResource res, IEditorService edSvc, string locale)
{
Modified: trunk/Tools/Maestro/Maestro.Login/LocalNativeStubCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Login/LocalNativeStubCtrl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Login/LocalNativeStubCtrl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -28,7 +28,7 @@
namespace Maestro.Login
{
- public partial class LocalNativeStubCtrl : UserControl, ILoginCtrl
+ internal partial class LocalNativeStubCtrl : UserControl, ILoginCtrl
{
public LocalNativeStubCtrl()
{
Modified: trunk/Tools/Maestro/Maestro.Login/LocalStubCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Login/LocalStubCtrl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Login/LocalStubCtrl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -28,7 +28,7 @@
namespace Maestro.Login
{
- public partial class LocalStubCtrl : UserControl, ILoginCtrl
+ internal partial class LocalStubCtrl : UserControl, ILoginCtrl
{
public LocalStubCtrl()
{
Modified: trunk/Tools/Maestro/Maestro.MapViewer/DefaultToolbar.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/DefaultToolbar.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.MapViewer/DefaultToolbar.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -33,7 +33,7 @@
public class DefaultToolbar : ToolStrip, IDefaultToolbar
{
/// <summary>
- /// Initializes a new instance of the <see cref="MgDefaultToolbar"/> class.
+ /// Initializes a new instance of the <see cref="DefaultToolbar"/> class.
/// </summary>
public DefaultToolbar()
: base()
@@ -362,7 +362,7 @@
}
/// <summary>
- /// Determines the behaviour of the zoom out command in the <see cref="MgDefaultToolbar"/>
+ /// Determines the behaviour of the zoom out command in the <see cref="DefaultToolbar"/>
/// </summary>
public enum ZoomOutMode
{
Modified: trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.MapViewer/Legend.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -35,8 +35,16 @@
namespace Maestro.MapViewer
{
+ /// <summary>
+ ///
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="node"></param>
public delegate void NodeEventHandler(object sender, TreeNode node);
+ /// <summary>
+ /// A control that displays a legend for a map and provides interactive layer toggling capabilities
+ /// </summary>
public partial class Legend : UserControl, INotifyPropertyChanged
{
const string IMG_BROKEN = "lc_broken";
@@ -174,6 +182,9 @@
}
}
+ /// <summary>
+ /// Raised when a control property has changed
+ /// </summary>
public event PropertyChangedEventHandler PropertyChanged;
private void OnPropertyChanged(string propertyName)
@@ -237,6 +248,9 @@
}
}
+ /// <summary>
+ /// Gets the selected node of the legend control
+ /// </summary>
public TreeNode SelectedNode { get { return trvLegend.SelectedNode; } }
private static void ClearNodes(TreeNodeCollection nodes)
Modified: trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.MapViewer/LegendPresenter.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -886,12 +886,24 @@
this.Checkable = true;
}
+ /// <summary>
+ /// Gets the legend label
+ /// </summary>
public string LegendLabel { get { return this.Group.LegendLabel; } }
+ /// <summary>
+ /// Gets the name of the parent group
+ /// </summary>
public string ParentGroupName { get { return this.Group.Group; } }
+ /// <summary>
+ /// Gets the name of this group
+ /// </summary>
public string Name { get { return this.Group.Name; } }
+ /// <summary>
+ /// Gets the unique id of this group
+ /// </summary>
public override string ObjectId
{
get { return this.Group.ObjectId; }
@@ -912,12 +924,24 @@
this.Checkable = false;
}
+ /// <summary>
+ /// Gets whether this node is a placeholder
+ /// </summary>
public bool IsPlaceholder { get; private set; }
-
+
+ /// <summary>
+ /// Gets the icon for this theme node
+ /// </summary>
public Image ThemeIcon { get; set; }
+ /// <summary>
+ /// Gets the label for this theme node
+ /// </summary>
public string Label { get; private set; }
+ /// <summary>
+ /// Gets the unique id for this node
+ /// </summary>
public override string ObjectId
{
get { return string.Empty; }
@@ -986,6 +1010,10 @@
[DebuggerDisplay("Name = {Layer.Name}, Label = {Layer.LegendLabel}")]
public class LayerNodeMetadata : LegendNodeMetadata
{
+ /// <summary>
+ /// Initializes a new instance of the LayerNodeMetadata class
+ /// </summary>
+ /// <param name="layer"></param>
public LayerNodeMetadata(RuntimeMapLayer layer)
: this(layer, layer.Selectable, layer.Type == RuntimeMapLayer.kBaseMap)
{
@@ -1099,12 +1127,21 @@
internal bool DrawSelectabilityIcon { get; set; }
+ /// <summary>
+ /// Gets or sets whether the layer is selectable
+ /// </summary>
public bool IsSelectable { get; set; }
internal bool WasInitiallySelectable { get; private set; }
+ /// <summary>
+ /// Gets or sets whether the layer is a base (tiled) layer
+ /// </summary>
public bool IsBaseLayer { get; set; }
+ /// <summary>
+ /// Gets or sets the Layer Definition XML content
+ /// </summary>
public string LayerDefinitionContent { get; set; }
private Dictionary<ThemeCategory, List<LayerThemeNodeMetadata>> _themeNodes;
Modified: trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.MapViewer/MapStatusTracker.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -33,6 +33,9 @@
{
private IMapViewer _viewer;
+ /// <summary>
+ /// Gets the viewer that is being wired
+ /// </summary>
public IMapViewer Viewer
{
get { return _viewer; }
Modified: trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.MapViewer/MapViewer.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -39,6 +39,9 @@
namespace Maestro.MapViewer
{
+ /// <summary>
+ /// An interactive map viewer control
+ /// </summary>
[ToolboxItem(true)]
public class MapViewer : Control, IMapViewer
{
@@ -1686,6 +1689,13 @@
_extY2 = coord.Y - mcsHeight / 2;
}
+ /// <summary>
+ /// Gets the current view extent
+ /// </summary>
+ /// <param name="minX"></param>
+ /// <param name="minY"></param>
+ /// <param name="maxX"></param>
+ /// <param name="maxY"></param>
public void GetViewExtent(out double minX, out double minY, out double maxX, out double maxY)
{
//NOTE: Something strange about the AJAX viewer code we grafted this from. Y2 is not the max Y, Y1 is the max Y.
@@ -2207,6 +2217,10 @@
};
}
+ /// <summary>
+ /// Raises the System.Windows.Forms.Control.Resize event
+ /// </summary>
+ /// <param name="e"></param>
protected override void OnResize(EventArgs e)
{
OnControlResized(this, e);
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/BusyWaitDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/BusyWaitDialog.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/BusyWaitDialog.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -25,6 +25,10 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ ///
+ /// </summary>
+ /// <returns></returns>
public delegate object BusyWaitDelegate();
/// <summary>
@@ -45,20 +49,44 @@
_culture = culture;
}
+ /// <summary>
+ /// Raises the System.Windows.Forms.Form.Load event.
+ /// </summary>
+ /// <param name="e"></param>
protected override void OnLoad(EventArgs e)
{
base.OnLoad(e);
bgWorker.RunWorkerAsync();
}
+ /// <summary>
+ /// Gets the return value of the completed background worker (if any)
+ /// </summary>
public object ReturnValue { get; private set; }
+
+ /// <summary>
+ /// Gets the error thrown by the completed background worker (if any)
+ /// </summary>
public Exception Error { get; private set; }
+ /// <summary>
+ /// Opens a modal dialog to execute the given delegate in a background worker
+ /// </summary>
+ /// <param name="message"></param>
+ /// <param name="action"></param>
+ /// <param name="onComplete"></param>
public static void Run(string message, BusyWaitDelegate action, Action<object, Exception> onComplete)
{
Run(message, action, onComplete, true);
}
+ /// <summary>
+ /// Opens a modal dialog to execute the given delegate in a background worker
+ /// </summary>
+ /// <param name="message"></param>
+ /// <param name="action"></param>
+ /// <param name="onComplete"></param>
+ /// <param name="bPreserveThreadCulture"></param>
public static void Run(string message, BusyWaitDelegate action, Action<object, Exception> onComplete, bool bPreserveThreadCulture)
{
if (action == null)
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/IViewContentManager.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/IViewContentManager.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/IViewContentManager.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -21,18 +21,83 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// A method that creates an object of the given type
+ /// </summary>
+ /// <typeparam name="T"></typeparam>
+ /// <returns></returns>
public delegate T CreateFunc<T>();
+ /// <summary>
+ /// Manages <see cref="T:Maestro.Shared.UI.IViewContent"/> instances
+ /// </summary>
public interface IViewContentManager
{
+ /// <summary>
+ /// Hides the given single-instance view content
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
void HideContent<T>() where T : IViewContent;
+
+ /// <summary>
+ /// Initializes this instance
+ /// </summary>
void Initialize();
+
+ /// <summary>
+ /// Gets whether the given single-instance view content type has already been created
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <returns></returns>
bool IsCreated<T>() where T : IViewContent;
+
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <param name="method">A method that will create the required view content the view content has not been created yet</param>
+ /// <returns></returns>
T OpenContent<T>(ViewRegion region, CreateFunc<T> method) where T : IViewContent;
+
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <returns></returns>
T OpenContent<T>(ViewRegion region) where T : IViewContent;
+
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="title"></param>
+ /// <param name="description"></param>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <param name="method">A method that will create the required view content the view content has not been created yet</param>
+ /// <returns></returns>
T OpenContent<T>(string title, string description, ViewRegion region, CreateFunc<T> method) where T : IViewContent;
+
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="title"></param>
+ /// <param name="description"></param>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <returns></returns>
T OpenContent<T>(string title, string description, ViewRegion region) where T : IViewContent;
+
+ /// <summary>
+ /// Displays the given single-instance view content
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
void ShowContent<T>() where T : IViewContent;
+
+ /// <summary>
+ /// Raised when a view is hidden
+ /// </summary>
event EventHandler ViewHidden;
}
}
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/ServiceBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/ServiceBase.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/ServiceBase.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -23,12 +23,24 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// The base class of all application services
+ /// </summary>
public abstract class ServiceBase
{
+ /// <summary>
+ /// Initializes this service
+ /// </summary>
public virtual void Initialize() { }
+ /// <summary>
+ /// Load this service
+ /// </summary>
public virtual void Load() { }
+ /// <summary>
+ /// Instructs this service to save any data before the application shuts down
+ /// </summary>
public virtual void Save() { }
}
}
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/SingletonViewContent.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/SingletonViewContent.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/SingletonViewContent.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -27,13 +27,22 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// Represnents a single-instnace view content
+ /// </summary>
public partial class SingletonViewContent : ViewContentBase
{
+ /// <summary>
+ /// Initializes a new instance of the SingletonViewContent class
+ /// </summary>
public SingletonViewContent()
{
InitializeComponent();
}
+ /// <summary>
+ /// Gets whether the user can close this instance manually
+ /// </summary>
public override bool AllowUserClose
{
get
@@ -42,11 +51,17 @@
}
}
+ /// <summary>
+ /// Does nothing.
+ /// </summary>
public override void Close()
{
//Do nothing. Singletons aren't closeable
}
+ /// <summary>
+ /// Gets the default view region
+ /// </summary>
public override ViewRegion DefaultRegion
{
get
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentBase.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentBase.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -41,8 +41,14 @@
InitializeComponent();
}
+ /// <summary>
+ /// Gets whether this instance is a modal window
+ /// </summary>
public virtual bool IsModalWindow { get { return false; } }
+ /// <summary>
+ /// Gets whether this instance can only be docked to the document region
+ /// </summary>
public virtual bool IsExclusiveToDocumentRegion { get { return false; } }
private string _title;
@@ -70,6 +76,10 @@
private Form _parent;
+ /// <summary>
+ /// Sets the parent form for this instance
+ /// </summary>
+ /// <param name="form"></param>
public void SetParentForm(Form form)
{
if (_parent != null)
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentManagerBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentManagerBase.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/ViewContentManagerBase.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -24,14 +24,35 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// The base class for managing View Content instances
+ /// </summary>
public abstract class ViewContentManagerBase : ServiceBase, IViewContentManager
{
+ /// <summary>
+ /// A dictionary of single-instance view content types
+ /// </summary>
protected Dictionary<string, Type> _singletonViewContentTypes = new Dictionary<string, Type>();
+
+ /// <summary>
+ /// A list of single-instance view content
+ /// </summary>
protected List<IViewContent> _singletonInstances = new List<IViewContent>();
+ /// <summary>
+ /// Raised when a view is hidden
+ /// </summary>
public event EventHandler ViewHidden;
+
+ /// <summary>
+ /// Raised when a view is activated
+ /// </summary>
public event ViewEventHandler ViewActivated;
+ /// <summary>
+ /// Gets the workbench
+ /// </summary>
+ /// <returns></returns>
protected abstract WorkbenchBase GetWorkbench();
/// <summary>
@@ -43,6 +64,11 @@
base.Initialize();
}
+ /// <summary>
+ /// Gets whether the given single-instance view content type has already been created
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <returns></returns>
public bool IsCreated<T>() where T : IViewContent
{
var type = typeof(T);
@@ -63,6 +89,10 @@
}
}
+ /// <summary>
+ /// Hides the given single-instance view content
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
public void HideContent<T>() where T : IViewContent
{
var type = typeof(T);
@@ -90,6 +120,10 @@
}
}
+ /// <summary>
+ /// Displays the given single-instance view content
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
public void ShowContent<T>() where T : IViewContent
{
var type = typeof(T);
@@ -117,21 +151,51 @@
}
}
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <param name="method">A method that will create the required view content the view content has not been created yet</param>
+ /// <returns></returns>
public T OpenContent<T>(ViewRegion region, CreateFunc<T> method) where T : IViewContent
{
return OpenContent<T>(null, null, region, method);
}
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <returns></returns>
public T OpenContent<T>(ViewRegion region) where T : IViewContent
{
return OpenContent<T>(null, null, region);
}
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="title"></param>
+ /// <param name="description"></param>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <returns></returns>
public T OpenContent<T>(string title, string description, ViewRegion region) where T : IViewContent
{
return OpenContent<T>(title, description, region, () => { return (T)Activator.CreateInstance(typeof(T), true); });
}
+ /// <summary>
+ /// Creates and/or opens the given view content in the specified region
+ /// </summary>
+ /// <typeparam name="T">The type implementing the <see cref="T:Maestro.Shared.UI.IViewContent"/> interface</typeparam>
+ /// <param name="title"></param>
+ /// <param name="description"></param>
+ /// <param name="region">The desired region to show the view content in</param>
+ /// <param name="method">A method that will create the required view content the view content has not been created yet</param>
+ /// <returns></returns>
public T OpenContent<T>(string title, string description, ViewRegion region, CreateFunc<T> method) where T : IViewContent
{
var type = typeof(T);
@@ -166,5 +230,10 @@
}
}
+ /// <summary>
+ ///
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="content"></param>
public delegate void ViewEventHandler(object sender, IViewContent content);
}
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/WorkbenchBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/WorkbenchBase.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/WorkbenchBase.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -28,6 +28,9 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// The Workbench base class
+ /// </summary>
public partial class WorkbenchBase : Form
{
MenuStrip menu;
@@ -48,6 +51,10 @@
InitializeComponent();
}
+ /// <summary>
+ /// Initializes a new instance of the WorkbenchBase class
+ /// </summary>
+ /// <param name="init"></param>
protected WorkbenchBase(IWorkbenchInitializer init) : this()
{
_workbenchInitializer = init;
@@ -111,6 +118,11 @@
const string BASE_TOOLSTRIP = "Base"; //NOXLATE
+ /// <summary>
+ /// Called when a view content has been activated
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="content"></param>
protected virtual void OnViewActivated(object sender, IViewContent content) { }
private Dictionary<string, ToolStrip> _toolstrips;
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommandImpl.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommandImpl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommandImpl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -289,18 +289,6 @@
}
/// <summary>
- /// Gets or sets the feature source id.
- /// </summary>
- /// <value>
- /// The feature source id.
- /// </value>
- public string FeatureSourceId
- {
- get;
- set;
- }
-
- /// <summary>
/// Executes this instance.
/// </summary>
public void Execute()
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommands.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommands.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/FeatureManipulationCommands.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -180,8 +180,13 @@
/// Defines a command that inserts a series of features into a Feature Source
/// </summary>
/// <remarks>
+ /// <para>
/// This command is only supported on certain implementations of <see cref="T:OSGeo.MapGuide.MaestroAPI.IServerConnection"/>
/// You can find out if the connection supports this command through the <see cref="P:OSGeo.MapGuide.MaestroAPI.IServerConnection.Capabilities"/>
+ /// </para>
+ /// <para>
+ /// Nothing implements this interface at the moment
+ /// </para>
/// </remarks>
public interface IBatchInsertFeatures : IFeatureCommand
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -341,6 +341,11 @@
return CreateConnection(provider, initP);
}
+ /// <summary>
+ /// Gets the entry for the given connection provider name
+ /// </summary>
+ /// <param name="provider"></param>
+ /// <returns></returns>
public static ConnectionProviderEntry FindProvider(string provider)
{
string cmp = provider.ToUpper();
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -263,6 +263,7 @@
/// </summary>
/// <param name="mdf">The map definition to create this map from.</param>
/// <param name="metersPerUnit">The meters per unit value</param>
+ /// <param name="suppressErrors"></param>
internal RuntimeMap(IMapDefinition mdf, double metersPerUnit, bool suppressErrors)
: this(mdf.CurrentConnection)
{
@@ -1823,5 +1824,10 @@
}
}
+ /// <summary>
+ ///
+ /// </summary>
+ /// <param name="sender"></param>
+ /// <param name="layer"></param>
public delegate void LayerEventHandler(object sender, RuntimeMapLayer layer);
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -124,6 +124,7 @@
/// Initializes this instances from the specified Layer Definition
/// </summary>
/// <param name="ldf"></param>
+ /// <param name="suppressErrors"></param>
protected void Initialize(ILayerDefinition ldf, bool suppressErrors)
{
Check.NotNull(ldf, "ldf"); //NOXLATE
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -534,6 +534,7 @@
/// </summary>
/// <param name="map"></param>
/// <param name="group"></param>
+ /// <param name="bDetachIfEmpty"></param>
public static void RemoveBaseLayerGroup(this IMapDefinition map, IBaseMapGroup group, bool bDetachIfEmpty)
{
Check.NotNull(map, "map"); //NOXLATE
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapImpl.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapImpl.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapImpl.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -323,6 +323,9 @@
RuleInfoCollection _roRules;
+ /// <summary>
+ /// Gets the rules in this feature style
+ /// </summary>
public IRuleInfoCollection Rules
{
get
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapInterfaces.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/RuntimeMapInterfaces.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -126,106 +126,226 @@
/// </summary>
double MetersPerUnit { get; }
}
-
+
+ /// <summary>
+ /// Models a legend element
+ /// </summary>
public interface IRuntimeMapLegendElement
{
+ /// <summary>
+ /// Gets the name of the element
+ /// </summary>
string Name { get; }
+ /// <summary>
+ /// Gets the label of the element
+ /// </summary>
string LegendLabel { get; }
+ /// <summary>
+ /// Gets the unique id of the element
+ /// </summary>
string ObjectID { get; }
+ /// <summary>
+ /// Gets the unique id of the element's parent
+ /// </summary>
string ParentID { get; }
+ /// <summary>
+ /// Gets whether the element will be shown in the legend
+ /// </summary>
bool DisplayInLegend { get; }
+ /// <summary>
+ /// Gets whether the element will be expanded in the legend
+ /// </summary>
bool ExpandInLegend { get; }
+ /// <summary>
+ /// Gets whether the element is potentially
+ /// </summary>
bool Visible { get; }
+ /// <summary>
+ /// Gets whether the element is actually element
+ /// </summary>
bool ActuallyVisible { get; }
}
+ /// <summary>
+ /// Represents a layer of the runtime map
+ /// </summary>
public interface IRuntimeLayerInfo : IRuntimeMapLegendElement
{
+ /// <summary>
+ /// Gets the type of layer
+ /// </summary>
int LayerType { get; }
+ /// <summary>
+ /// Gets the Layer Definition ID
+ /// </summary>
string LayerDefinition { get; }
+ /// <summary>
+ /// Gets feature source information of the layer
+ /// </summary>
IFeatureSourceInfo FeatureSource { get; }
+ /// <summary>
+ /// Gets information about the scale ranges in the layer
+ /// </summary>
IScaleRangeInfoCollection ScaleRanges { get; }
}
+ /// <summary>
+ /// Represents Feature Source information for a layer
+ /// </summary>
public interface IFeatureSourceInfo
{
+ /// <summary>
+ /// Gets the resource id of the Feature Source
+ /// </summary>
string ResourceID { get; }
+ /// <summary>
+ /// Gets the name of the feature class that the layer is rendered from
+ /// </summary>
string ClassName { get; }
+ /// <summary>
+ /// Gets the name of the geometry property of the feature class that the layer is rendered from
+ /// </summary>
string Geometry { get; }
}
+ /// <summary>
+ /// Represents a group of a runtime map
+ /// </summary>
public interface IRuntimeLayerGroupInfo : IRuntimeMapLegendElement
{
+ /// <summary>
+ /// Gets the type of the group
+ /// </summary>
int GroupType { get; }
}
+ /// <summary>
+ /// Represents a scale range of a layer
+ /// </summary>
public interface IScaleRangeInfo
{
+ /// <summary>
+ /// Gets the minimum scale this scale range is applicable for
+ /// </summary>
double MinScale { get; }
+ /// <summary>
+ /// Gets the maximum scale this scale range is applicable for
+ /// </summary>
double MaxScale { get; }
+ /// <summary>
+ /// Gets the feature styles for this scale range
+ /// </summary>
IFeatureStyleInfoCollection FeatureStyle { get; }
}
+ /// <summary>
+ /// Represents a feature style
+ /// </summary>
public interface IFeatureStyleInfo
{
+ /// <summary>
+ /// Gets the type of the feature style
+ /// </summary>
int Type { get; }
+ /// <summary>
+ /// Gets the style rules for this feature style
+ /// </summary>
IRuleInfoCollection Rules { get; }
}
+ /// <summary>
+ /// Represents a style rule
+ /// </summary>
public interface IRuleInfo
{
+ /// <summary>
+ /// Gets the legend label for this rule
+ /// </summary>
string LegendLabel { get; }
+ /// <summary>
+ /// Gets the filter for this rule
+ /// </summary>
string Filter { get; }
+ /// <summary>
+ /// Gets the icon for this rule
+ /// </summary>
string IconBase64 { get; }
}
+ /// <summary>
+ /// A generic read-only collection interface
+ /// </summary>
+ /// <typeparam name="T"></typeparam>
public interface IReadOnlyCollection<T> : IEnumerable<T>
{
+ /// <summary>
+ /// Gets the number of items in this collection
+ /// </summary>
int Count { get; }
+ /// <summary>
+ /// Gets the item at the given index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
T this[int index]
{
get;
}
}
+ /// <summary>
+ /// A collection of layers
+ /// </summary>
public interface IRuntimeLayerInfoCollection : IReadOnlyCollection<IRuntimeLayerInfo>
{
}
+ /// <summary>
+ /// A collection of groups
+ /// </summary>
public interface IRuntimeLayerGroupInfoCollection : IReadOnlyCollection<IRuntimeLayerGroupInfo>
{
}
+ /// <summary>
+ /// A collection of scale ranges
+ /// </summary>
public interface IScaleRangeInfoCollection : IReadOnlyCollection<IScaleRangeInfo>
{
}
+ /// <summary>
+ /// A collection of feature styles
+ /// </summary>
public interface IFeatureStyleInfoCollection : IReadOnlyCollection<IFeatureStyleInfo>
{
}
+ /// <summary>
+ /// A collection of style rules
+ /// </summary>
public interface IRuleInfoCollection : IReadOnlyCollection<IRuleInfo>
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -1904,6 +1904,10 @@
}
}
+ /// <summary>
+ /// Gets the MPU calculator
+ /// </summary>
+ /// <returns></returns>
public virtual IMpuCalculator GetCalculator()
{
return new DefaultCalculator(this);
@@ -2211,7 +2215,6 @@
/// <param name="runtimeMapResourceId"></param>
/// <param name="mdf"></param>
/// <param name="metersPerUnit"></param>
- /// <param name="suppressErrors"></param>
/// <returns></returns>
public virtual RuntimeMap CreateMap(string runtimeMapResourceId, IMapDefinition mdf, double metersPerUnit)
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/ImageSymbolConverter.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/ImageSymbolConverter.cs 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/ImageSymbolConverter.cs 2013-12-23 15:14:25 UTC (rev 7962)
@@ -42,6 +42,11 @@
private string _symbolLibId;
private IServerConnection _conn;
+ /// <summary>
+ /// Initializes a new instance of the ImageSymbolConverter class
+ /// </summary>
+ /// <param name="conn"></param>
+ /// <param name="symbolLibId"></param>
public ImageSymbolConverter(IServerConnection conn, string symbolLibId)
{
Check.NotNull(conn, "conn"); //NOXLATE
@@ -145,6 +150,12 @@
return Math.Round(res, 1);
}
+ /// <summary>
+ /// Extracts the DWF symbol data store from the given symbol library to a new session-based drawing source
+ /// </summary>
+ /// <param name="conn"></param>
+ /// <param name="symResId"></param>
+ /// <returns></returns>
public static IDrawingSource PrepareSymbolDrawingSource(IServerConnection conn, string symResId)
{
//Extract the symbols.dwf resource data and copy to a session based drawing source
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/OSGeo.MapGuide.MaestroAPI.Local.csproj
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/OSGeo.MapGuide.MaestroAPI.Local.csproj 2013-12-23 12:48:14 UTC (rev 7961)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI.Local/OSGeo.MapGuide.MaestroAPI.Local.csproj 2013-12-23 15:14:25 UTC (rev 7962)
@@ -42,6 +42,7 @@
<DefineConstants>TRACE;DEBUG;LOCAL_API</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
+ <PlatformTarget>AnyCPU</PlatformTarget>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType>
@@ -50,6 +51,7 @@
<DefineConstants>TRACE;LOCAL_API</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
+ <PlatformTarget>AnyCPU</PlatformTarget>
</PropertyGroup>
<ItemGroup>
<Reference Include="NetTopologySuite.Merged, Version=1.8.0.0, Culture=neutral, PublicKeyToken=f580a05016ebada1, processorArchitecture=MSIL">
More information about the mapguide-commits
mailing list