← Back to branch summary

~ubuntu-branches/ubuntu/lucid/tomboy/lucid-proposed

« back to all changes in this revision

Viewing changes to Tomboy/PreferenceTabAddin.cs

Tags: upstream-0.9.4
Import upstream version 0.9.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
Tomboy/PreferenceTabAddin.cs
 
1
using System;
 
2
 
 
3
namespace Tomboy
 
4
{
 
5
        /// <summary>
 
6
        /// Implement this interface to provide a new tab in
 
7
        /// Tomboy's Preferences Dialog.  If you are writing
 
8
        /// a standard add-in, DO NOT ABUSE THIS (you should
 
9
        /// normally extend the /Tomboy/AddinPreferences
 
10
        /// extension point).
 
11
        /// </summary>
 
12
        public abstract class PreferenceTabAddin : AbstractAddin
 
13
        {
 
14
                /// <summary>
 
15
                /// Returns a Gtk.Widget to place in a new tab in Tomboy's
 
16
                /// preferences dialog.
 
17
                /// <param name="parent">The preferences dialog.  Add-ins should
 
18
                /// use this for connecting to Hidden or other events as needed.
 
19
                /// Another use would be to pop open dialogs, so they can properly
 
20
                /// set their parent.
 
21
                /// </param>
 
22
                /// <param name="tabLabel">The string to be used in the tab's
 
23
                /// label.</param>
 
24
                /// <param name="preferenceWidget">The Gtk.Widget to use as the
 
25
                /// content of the tab page.</param>
 
26
                /// <returns>Returns <value>true</value> if the widget is
 
27
                /// valid/created or <value>false</value> otherwise.</returns>
 
28
                /// </summary>
 
29
                public abstract bool GetPreferenceTabWidget (
 
30
                                                                        PreferencesDialog parent,
 
31
                                                                        out string tabLabel,
 
32
                                                                        out Gtk.Widget preferenceWidget);
 
33
        }
 
34
}