Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Data/BoolDataView.cs @ 1314

Last change on this file since 1314 was 737, checked in by vdorfer, 16 years ago

Created API documentation for HeuristLab.Data namespace (#331)

File size: 3.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.ComponentModel;
25using System.Drawing;
26using System.Data;
27using System.Text;
28using System.Windows.Forms;
29using HeuristicLab.Core;
30
31namespace HeuristicLab.Data {
32  /// <summary>
33  /// The visual representation of the class <see cref="BoolData"/>, symbolizing a boolean value.
34  /// </summary>
35  public partial class BoolDataView : ViewBase {
36    /// <summary>
37    /// Gets or sets the boolean value to represent visually.
38    /// </summary>
39    /// <remarks>Uses property <see cref="HeuristicLab.Core.ViewBase.Item"/> of base class <see cref="ViewBase"/>.
40    /// No own data storage present.</remarks>
41    public BoolData BoolData {
42      get { return (BoolData)Item; }
43      set { base.Item = value; }
44    }
45
46    /// <summary>
47    /// Initializes a new instance of the class <see cref="BoolDataView"/>.
48    /// </summary>
49    public BoolDataView() {
50      InitializeComponent();
51    }
52    /// <summary>
53    /// Initializes a new instance of the class <see cref="BoolDataView"/> with the given
54    /// <paramref name="boolData"/>.
55    /// <note type="caution"> No CopyConstructor! <paramref name="boolData"/> is not copied!</note>
56    /// </summary>
57    /// <param name="boolData">The boolean value to represent visually.</param>
58    public BoolDataView(BoolData boolData)
59      : this() {
60      BoolData = boolData;
61    }
62
63    /// <summary>
64    /// Removes the eventhandler from the underlying <see cref="BoolData"/>.
65    /// </summary>
66    /// <remarks>Calls <see cref="HeuristicLab.Core.ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.
67    /// </remarks>
68    protected override void RemoveItemEvents() {
69      BoolData.Changed -= new EventHandler(BoolData_Changed);
70      base.RemoveItemEvents();
71    }
72    /// <summary>
73    /// Adds an eventhandler to the underlying <see cref="BoolData"/>.
74    /// </summary>
75    /// <remarks>Calls <see cref="HeuristicLab.Core.ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.
76    /// </remarks>
77    protected override void AddItemEvents() {
78      base.AddItemEvents();
79      BoolData.Changed += new EventHandler(BoolData_Changed);
80    }
81
82    /// <summary>
83    /// Sets the <c>dataCheckBox</c> checked or unchecked according to the latest value.
84    /// </summary>
85    protected override void UpdateControls() {
86      base.UpdateControls();
87      if (BoolData == null) {
88        dataCheckBox.Enabled = false;
89      } else {
90        dataCheckBox.Enabled = true;
91        dataCheckBox.Checked = BoolData.Data;
92      }
93    }
94
95    private void dataCheckBox_CheckedChanged(object sender, EventArgs e) {
96      BoolData.Data = dataCheckBox.Checked;
97    }
98
99    private void BoolData_Changed(object sender, EventArgs e) {
100      Refresh();
101    }
102  }
103}
Note: See TracBrowser for help on using the repository browser.