← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/monodevelop/oneiric

« back to all changes in this revision

Viewing changes to src/addins/MonoDevelop.Debugger/MonoDevelop.Debugger.Visualizer/IValueVisualizer.cs

  • Committer: Bazaar Package Importer
  • Author(s): Jo Shields
  • Date: 2011-06-27 17:03:13 UTC
  • mto: (1.8.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 54.
  • Revision ID: james.westby@ubuntu.com-20110627170313-6cvz3s19x6e9hqe9
Import upstream version 2.5.92+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/addins/MonoDevelop.Debugger/MonoDevelop.Debugger.Visualizer/IValueVisualizer.cs
31
31
{
32
32
        public interface IValueVisualizer
33
33
        {
 
34
                /// <summary>
 
35
                /// Display name of the visualizer
 
36
                /// </summary>
 
37
                /// <remarks>
 
38
                /// This name is shown in a combo box at the top of the visualizer dialog when
 
39
                /// there is more than one visualizer available for a value
 
40
                /// </remarks>
34
41
                string Name { get; }
 
42
                
 
43
                /// <summary>
 
44
                /// Determines whether this instance can visualize the specified value
 
45
                /// </summary>
 
46
                /// <returns>
 
47
                /// <c>true</c> if this instance can visualize the specified value; otherwise, <c>false</c>.
 
48
                /// </returns>
 
49
                /// <param name='val'>
 
50
                /// The value
 
51
                /// </param>
 
52
                /// <remarks>
 
53
                /// This method must check the value and return <c>true</v> if it is able to display that value.
 
54
                /// Typically, this method will check the TypeName of the value.
 
55
                /// </remarks>
35
56
                bool CanVisualize (ObjectValue val);
 
57
                
 
58
                /// <summary>
 
59
                /// Gets a visualizer widget for a value
 
60
                /// </summary>
 
61
                /// <returns>
 
62
                /// The visualizer widget.
 
63
                /// </returns>
 
64
                /// <param name='val'>
 
65
                /// A value
 
66
                /// </param>
 
67
                /// <remarks>
 
68
                /// This method is called to get a widget for displaying the specified value.
 
69
                /// The method should create the widget and load the required information from
 
70
                /// the value. Notice that the ObjectValue.Value property returns a string
 
71
                /// representation of the value. If the visualizer needs to get values from
 
72
                /// the object properties, it can use the ObjectValue.GetRawValue method.
 
73
                /// </remarks>
36
74
                Gtk.Widget GetVisualizerWidget (ObjectValue val);
 
75
                
 
76
                /// <summary>
 
77
                /// Saves changes done in the visualizer
 
78
                /// </summary>
 
79
                /// <returns>
 
80
                /// <c>true</c> if the changes could be saved
 
81
                /// </returns>
 
82
                /// <param name='val'>
 
83
                /// The value on which to store changes
 
84
                /// </param>
 
85
                /// <remarks>
 
86
                /// This method is called to save changes done in the visualizer.
 
87
                /// The implementation should use ObjectValue.SetRawValue to store the changes.
 
88
                /// </remarks>
37
89
                bool StoreValue (ObjectValue val);
 
90
                
 
91
                /// <summary>
 
92
                /// Determines whether this instance supports editing the specified value
 
93
                /// </summary>
 
94
                /// <returns>
 
95
                /// <c>true</c> if this instance can edit the specified value; otherwise, <c>false</c>.
 
96
                /// </returns>
 
97
                /// <param name='val'>
 
98
                /// The value
 
99
                /// </param>
 
100
                /// <remarks>
 
101
                /// This method is called to determine if this visualizer supports value editing,
 
102
                /// in addition to visualization.
 
103
                /// The method is called only if CanVisualize returns <c>true</c> for the value, and
 
104
                /// if the value doesn't have the ReadOnly flag.
 
105
                /// Editing support is optional. 
 
106
                /// </remarks>
 
107
                bool CanEdit (ObjectValue val);
38
108
        }
39
109
}
40
110