ada2962e92
* Added new documentation files for the new classes, and fixed the off-by-one enum member name bug that was introduced in the previous commit. svn path=/trunk/gtk-sharp/; revision=16325
206 lines
No EOL
8.8 KiB
XML
206 lines
No EOL
8.8 KiB
XML
<Type Name="Tooltips" FullName="Gtk.Tooltips">
|
|
<TypeSignature Language="C#" Value="public class Tooltips : Gtk.Object, IWrapper, IDisposable" Maintainer="John Luke" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<Attributes />
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
|
<Docs>
|
|
<summary>Add Tooltips to your widgets.</summary>
|
|
<remarks>
|
|
<para>Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time.
|
|
They are especially helpful for adding more verbose descriptions of things such as <see cref="T:Gtk.Button" /> in a toolbar.</para>
|
|
<para>An individual tooltip belongs to a group of tooltips.
|
|
A group is created by calling the constructor <see cref="C:Gtk.Tooltips()" />.
|
|
Every tooltip in the group can then be turned off with <see cref="M:Gtk.Tooltips.Disable()" /> and on with <see cref="M:Gtk.Tooltips.Enable()" />.</para>
|
|
<para>To assign a tip to a particular <see cref="T:Gtk.Widget" />, <see cref="M:Gtk.Tooltips.SetTip(Gtk.Widget,System.String,System.String)" /> is used.</para>
|
|
<para>Note: Tooltips can only be set on widgets which have their own X window.
|
|
To add a tooltip to a <see cref="T:Gtk.Widget" /> that does not have its own <see cref="T:Gtk.Window" />, place the widget inside a <see cref="T:Gtk.EventBox" /> and add a tooltip to that instead.</para>
|
|
<para>The default appearance of all tooltips in a program is determined by the current Gtk theme that the user has selected.</para>
|
|
<example>
|
|
<code lang="C#">
|
|
using Gtk;
|
|
using GtkSharp;
|
|
|
|
class ToolTipsExample
|
|
{
|
|
static void Main()
|
|
{
|
|
|
|
Application.Init();
|
|
|
|
Window win = new Window("Tooltips");
|
|
Button load_button, save_button;
|
|
HBox hbox;
|
|
Tooltips button_bar_tips;
|
|
|
|
button_bar_tips = new Tooltips ();
|
|
|
|
// Create the buttons and pack them into a Gtk.HBox
|
|
hbox = new HBox (true, 2);
|
|
win.Add(hbox);
|
|
|
|
load_button = new Button ("Load a file");
|
|
hbox.Add(load_button);
|
|
|
|
save_button = new Button ("Save a file");
|
|
hbox.Add(save_button);
|
|
|
|
// Add the tips
|
|
button_bar_tips.SetTip (load_button,
|
|
"Load a new document into this window",
|
|
"longer explanation");
|
|
|
|
button_bar_tips.SetTip (save_button,
|
|
"Saves the current document to a file",
|
|
"longer explanation");
|
|
|
|
win.ShowAll();
|
|
Application.Run();
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="Enable">
|
|
<MemberSignature Language="C#" Value="public void Enable ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Allows the user to see your tooltips as they navigate your application.</summary>
|
|
<remarks>Allows the user to see your tooltips as they navigate your application.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Disable">
|
|
<MemberSignature Language="C#" Value="public void Disable ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Causes all tooltips in the tooltips group to become inactive.</summary>
|
|
<remarks>Causes all tooltips in the tooltips group to become inactive.
|
|
Any widgets that have tips associated with that group will no longer display their tips until they are enabled again with <see cref="M:Gtk.Tooltips.Enable()" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ForceWindow">
|
|
<MemberSignature Language="C#" Value="public void ForceWindow ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Ensures that the window used for displaying the given tooltip is created.</summary>
|
|
<remarks>Ensures that the window used for displaying the given tooltip is created.
|
|
(Applications should never have to call this function, since Gtk# takes care of this.) </remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetTip">
|
|
<MemberSignature Language="C#" Value="public void SetTip (Gtk.Widget widget, string tip_text, string tip_private);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="widget" Type="Gtk.Widget" />
|
|
<Parameter Name="tip_text" Type="System.String" />
|
|
<Parameter Name="tip_private" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Adds a tooltip containing the specified message to the specified <see cref="T:Gtk.Widget" />.</summary>
|
|
<param name="widget">an object of type <see cref="T:Gtk.Widget" /></param>
|
|
<param name="tip_text">an object of type <see cref="System.String" /></param>
|
|
<param name="tip_private">an object of type <see cref="System.String" /></param>
|
|
<remarks>Adds a tooltip containing the specified message to the specified <see cref="T:Gtk.Widget" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Disposes the resources associated with the object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Tooltips (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="raw">Pointer to the C object.</param>
|
|
<returns>An instance of Tooltips, wrapping the C object.</returns>
|
|
<remarks>
|
|
<para>This is an internal constructor, and should not be used by user code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Tooltips ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Creates an empty group of tooltips.</summary>
|
|
<returns>an object of type <see cref="T:Gtk.Tooltips" /></returns>
|
|
<remarks>Creates an empty group of tooltips. This function initializes a <see cref="T:Gtk.TooltipsData" /> structure.
|
|
Without at least one such structure, you can not add individual tips to your application.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gtk.Tooltips" /></summary>
|
|
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gtk.Tooltips" /> class.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Tooltips (GLib.Type gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.Type" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of <see cref="T:Gtk.Tooltips" />, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Tooltips" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |