mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-27 01:55:29 +00:00
efa9acf122
* en/*/*.xml: Updated all the docs to match the new API. All the nodes that no longer have a corresponding member in the type are now marked as deprecated. We'll have to wait for Miguel to implement this in the browser to stop displaying them. All gtype constructors have been regenerated, because of the 'uint' to 'GLib.Type' change. However, this patch will preserve (well, it was regenerated) the customized text for those GType constructors. A lot of the 'Finalized' methods are also now marked as deprecated, because the classes implement 'Dispose' instead. This is a possible place for customized scripts to generate template documentation, similar to the GType property and GType constructors. svn path=/trunk/gtk-sharp/; revision=12270
214 lines
9.1 KiB
XML
214 lines
9.1 KiB
XML
<Type Name="CheckMenuItem" FullName="Gtk.CheckMenuItem">
|
|
<TypeSignature Language="C#" Value="public class CheckMenuItem : Gtk.MenuItem, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
|
<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>A menu item with a check box.</summary>
|
|
<remarks>
|
|
<para>A CheckMenuItem is a menu item that maintains the state of a boolean value in addition to a <see cref="T:Gtk.MenuItem" />'s usual role in activating application code.</para>
|
|
<para>A check box indicating the state of the boolean value is displayed at the left side of the <see cref="T:Gtk.MenuItem" />. Activating the <see cref="T:Gtk.MenuItem" /> toggles the value.</para>
|
|
<para>Whether the CheckMenuItem is 'on' or not can be determined with the <see cref="P:Gtk.CheckMenuItem.Active" /> property.</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.MenuItem</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>Atk.Implementor</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="NewWithLabel">
|
|
<MemberSignature Language="C#" Value="public static Gtk.CheckMenuItem NewWithLabel (string label);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.CheckMenuItem</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="label" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>A static way of creating a new CheckMenuItem</summary>
|
|
<param name="label">The name of the menu item</param>
|
|
<returns>A new CheckMenuItem</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Toggle">
|
|
<MemberSignature Language="C#" Value="public void Toggle ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Toggles the state of the check box between active and inactive.</summary>
|
|
<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" Deprecated="true">
|
|
<MemberSignature Language="C#" Value="protected CheckMenuItem (uint gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of CheckMenuItem, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.CheckMenuItem" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public CheckMenuItem (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 CheckMenuItem, 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 CheckMenuItem ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Creates a CheckMenuItem with no label</summary>
|
|
<returns>A new CheckMenuItem</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public CheckMenuItem (string label);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="label" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Create a new CheckMenuItem with the specified <paramref name="label" />.</summary>
|
|
<param name="label">The text to appear on the menu item.</param>
|
|
<returns>A new CheckMenuItem</returns>
|
|
<remarks>
|
|
<para>The text label will be created using <see cref="M:Gtk.Label.NewWithNmemonic" />, so underscores in the label indicate the mnemonic for the menu item.</para>
|
|
</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 GLib Type for Gtk.CheckMenuItem</summary>
|
|
<returns>The GLib Type for the Gtk.CheckMenuItem class.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Inconsistent">
|
|
<MemberSignature Language="C#" Value="public bool Inconsistent { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Manages whether the CheckMenuItem is in the 'inconsistent' state.</summary>
|
|
<param name="value">
|
|
<see langword="true" /> to mark the check box as inconsistent, <see langword="false" /> otherwise.</param>
|
|
<returns>
|
|
<see langword="true" /> if this CheckMenuItem is in the inconsistent state, <see langword="false" /> otherwise.</returns>
|
|
<remarks>
|
|
<para>If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a boolean setting, and the current values in that range are inconsistent, you may want to display the check in an "in between" state. This property turns on "in between" display.</para>
|
|
<para>Normally you would turn off the inconsistent state again if the user explicitly selects a setting. This has to be done manually, this property only affects visual appearance, it doesn't affect the semantics of the widget.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Active">
|
|
<MemberSignature Language="C#" Value="public bool Active { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The 'active' state of the CheckMenuItem</summary>
|
|
<param name="value">
|
|
<see langword="true" /> if the menu item has been set active, <see langword="false" /> otherwise.</param>
|
|
<returns />
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Toggled">
|
|
<MemberSignature Language="C#" Value="public event EventHandler Toggled;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>An event that is fired whenever the state of the CheckMenuItem is toggled.</summary>
|
|
<remarks>
|
|
<para>Connect to this event with a standard <see cref="T:System.EventHandler" />.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected CheckMenuItem (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 CheckMenuItem, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.CheckMenuItem" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |