Changeset 9915

Timestamp:

08/29/13 11:43:55 (11 years ago)

Author:

ascheibe

Message:

#2100 added a help button to View which opens and displays help texts if a help resource path is specified in the view attribute

Location:

trunk/sources

Files:

• HeuristicLab.MainForm.WindowsForms/3.3/Dialogs/InfoBox.Designer.cs (added)
• HeuristicLab.MainForm.WindowsForms/3.3/Dialogs/InfoBox.cs (added)
• HeuristicLab.MainForm.WindowsForms/3.3/HeuristicLab.MainForm.WindowsForms-3.3.csproj (modified) (2 diffs)
• HeuristicLab.MainForm.WindowsForms/3.3/Views/View.Designer.cs (modified) (2 diffs)
• HeuristicLab.MainForm.WindowsForms/3.3/Views/View.cs (modified) (2 diffs)
• HeuristicLab.MainForm/3.3/ViewAttribute.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/HeuristicLab.MainForm.WindowsForms-3.3.csproj

@@ -138 +138 @@
       <DependentUpon>DefineArithmeticProgressionDialog.cs</DependentUpon>
     </Compile>
+    <Compile Include="Dialogs\InfoBox.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="Dialogs\InfoBox.Designer.cs">
+      <DependentUpon>InfoBox.cs</DependentUpon>
+    </Compile>
     <Compile Include="Plugin.cs" />
     <Compile Include="Views\AsynchronousContentView.cs">
@@ -266 +272 @@
     </BootstrapperPackage>
   </ItemGroup>
-  <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 

trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/Views/View.Designer.cs

@@ -45 +45 @@
     /// </summary>
     private void InitializeComponent() {
+      this.components = new System.ComponentModel.Container();
+      this.helpLabel = new System.Windows.Forms.Label();
+      this.helpToolTip = new System.Windows.Forms.ToolTip(this.components);
       this.SuspendLayout();
       // 
-      // ViewBase
+      // helpLabel
       // 
-      this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
+      this.helpLabel.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Right)));
+      this.helpLabel.Image = HeuristicLab.Common.Resources.VSImageLibrary.Help;
+      this.helpLabel.Location = new System.Drawing.Point(131, 0);
+      this.helpLabel.Name = "helpLabel";
+      this.helpLabel.Size = new System.Drawing.Size(16, 16);
+      this.helpLabel.TabIndex = 0;
+      this.helpToolTip.SetToolTip(this.helpLabel, "Double Click to Show Help");
+      this.helpLabel.Visible = false;
+      this.helpLabel.DoubleClick += new System.EventHandler(this.helpLabel_DoubleClick);
+      // 
+      // View
+      // 
       this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Inherit;
-      this.Name = "ViewBase";
+      this.Controls.Add(this.helpLabel);
+      this.Name = "View";
       this.Load += new System.EventHandler(this.View_Load);
       this.ResumeLayout(false);
@@ -58 +73 @@
 
     #endregion
+
+    protected System.Windows.Forms.Label helpLabel;
+    protected System.Windows.Forms.ToolTip helpToolTip;
+
   }
 }

trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/Views/View.cs

@@ -38 +38 @@
       else
         this.Caption = "View";
+
+      if (ViewAttribute.HasHelpResourcePath((this.GetType())))
+        helpLabel.Visible = true;
     }
 
@@ -261 +264 @@
         ((Control)this).ResumeRepaint(refresh);
     }
+
+    protected void helpLabel_DoubleClick(object sender, EventArgs e) {
+      using (InfoBox dialog = new InfoBox("Help for " + ViewAttribute.GetViewName(this.GetType()), ViewAttribute.GetHelpResourcePath(this.GetType()), this)) {
+        dialog.ShowDialog(this);
+      }
+    }
   }
 }

trunk/sources/HeuristicLab.MainForm/3.3/ViewAttribute.cs

@@ -28 +28 @@
     public ViewAttribute(string name) {
       this.name = name;
+      this.helpResourcePath = string.Empty;
+    }
+
+    public ViewAttribute(string name, string helpResourcePath) {
+      this.name = name;
+      this.helpResourcePath = helpResourcePath;
     }
 
@@ -34 +40 @@
       get { return this.name; }
       set { this.name = value; }
+    }
+
+    private string helpResourcePath;
+    public string HelpResourcePath {
+      get { return this.helpResourcePath; }
+      set { this.helpResourcePath = value; }
     }
 
@@ -47 +59 @@
       return viewType.Name;
     }
+
+    public static string GetHelpResourcePath(MemberInfo viewType) {
+      ViewAttribute[] attributes = (ViewAttribute[])viewType.GetCustomAttributes(typeof(ViewAttribute), false);
+      if (attributes.Length == 1)
+        return attributes[0].helpResourcePath;
+      return string.Empty;
+    }
+
+    public static bool HasHelpResourcePath(MemberInfo viewType) {
+      ViewAttribute[] attributes = (ViewAttribute[])viewType.GetCustomAttributes(typeof(ViewAttribute), false);
+      if (attributes.Length == 1)
+        return attributes[0].helpResourcePath != string.Empty;
+      return false;
+    }
   }
 }