mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-26 18:15:41 +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
349 lines
17 KiB
XML
349 lines
17 KiB
XML
<Type Name="ScrolledWindow" FullName="Gtk.ScrolledWindow">
|
|
<TypeSignature Language="C#" Value="public class ScrolledWindow : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Duncan Mak" />
|
|
<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>Adds scrollbars to its child widget.</summary>
|
|
<remarks>
|
|
<para>
|
|
GtkScrolledWindow is a <see cref="T:Gtk.Bin" /> subclass: it's a container the accepts a single child widget. GtkScrolledWindow adds scrollbars to the child widget and optionally draws a beveled frame around the child widget.
|
|
</para>
|
|
<para>
|
|
The scrolled window can work in two ways. Some widgets have native scrolling support; these widgets have "slots" for <see cref="T:Gtk.Adjustment" /> objects. Widgets with native scroll support include <see cref="T:Gtk.TreeView" />, <see cref="T:Gtk.TextView" />, and <see cref="T:Gtk.Layout" />.
|
|
</para>
|
|
<para>
|
|
The position of the scrollbars is controlled by the scroll adjustments. See <see cref="T:Gtk.Adjustment" /> for the properties in an adjustment - for <see cref="T:Gtk.Scrollbar" />, used by <see cref="T:Gtk.ScrolledWindow" />, the <see cref="P:Gtk.Adjustment.Value" /> property represents the position of the scrollbar, which must be between the <see cref="P:Gtk.Adjustment.Lower" /> and <see cref="P:Gtk.Adjustment.Upper" /> - <see cref="P:Gtk.Adjustment.PageSize" />. The <see cref="P:Gtk.Adjustment.PageSize" /> property represents the size of the visible scrollable area. The <see cref="P:Gtk.Adjustment.StepIncrement" /> and <see cref="P:Gtk.Adjustment.PageIncrement" /> properties are used when the user asks to step down (using the small stepper arrows) or page down (using for example the PageDown key).
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Bin</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="AddWithViewport">
|
|
<MemberSignature Language="C#" Value="public void AddWithViewport (Gtk.Widget child);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="child" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Used to add children without native scrolling capabilities.</summary>
|
|
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
|
|
<remarks>
|
|
<para>
|
|
Used to add children without native scrolling capabilities. This is simply a convenience function; it is equivalent to adding the unscrollable child to a viewport, then adding the viewport to the scrolled window. If a child has native scrolling, use <see cref="M:Gtk.Container.Add" /> instead of this function.
|
|
</para>
|
|
<para>
|
|
The viewport scrolls the child by moving its <see cref="T:Gdk.Window" />, and takes the size of the child to be the size of its toplevel <see cref="T:Gdk.Window" />. This will be very wrong for most widgets that support native scrolling; for example, if you add a widget such as <see cref="T:Gtk.TreeView" /> with a viewport, the whole widget will scroll, including the column headings. Thus, widgets with native scrolling support should not be used with the <see cref="T:Gtk.Viewport" /> proxy.
|
|
</para>
|
|
<para>
|
|
A widget supports scrolling natively if the set_scroll_adjustments_signal field in GtkWidgetClass is non-zero, i.e. has been filled in with a valid signal identifier.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetPolicy">
|
|
<MemberSignature Language="C#" Value="public void SetPolicy (Gtk.PolicyType hscrollbar_policy, Gtk.PolicyType vscrollbar_policy);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="hscrollbar_policy" Type="Gtk.PolicyType" />
|
|
<Parameter Name="vscrollbar_policy" Type="Gtk.PolicyType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the scrollbar policy for the horizontal and vertical scrollbars.</summary>
|
|
<param name="hscrollbar_policy">Policy for horizontal bar.</param>
|
|
<param name="vscrollbar_policy">Policy for vertical bar.</param>
|
|
<remarks>
|
|
<para>
|
|
Sets the scrollbar policy for the horizontal and vertical scrollbars. The policy determines when the scrollbar should appear; it is a value from the <see cref="T:Gtk.PolicyType" /> enumeration. If <see cref="T:Gtk.PolicyType.Always" />, the scrollbar is always present; if <see cref="T:Gtk.PolicyType.Never" />, the scrollbar is never present; if <see cref="T:Gtk.PolicyType.Automatic" />, the scrollbar is present only if needed (that is, if the slider part of the bar would be smaller than the trough - the display is larger than the page size).
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetPolicy">
|
|
<MemberSignature Language="C#" Value="public void GetPolicy (out Gtk.PolicyType hscrollbar_policy, out Gtk.PolicyType vscrollbar_policy);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="hscrollbar_policy" Type="Gtk.PolicyType&" />
|
|
<Parameter Name="vscrollbar_policy" Type="Gtk.PolicyType&" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Retrieves the current policy values for the horizontal and vertical scrollbars.</summary>
|
|
<param name="hscrollbar_policy">Location to store the policy for the horizontal scrollbar.</param>
|
|
<param name="vscrollbar_policy">Location to store the policy for the horizontal scrollbar.</param>
|
|
<remarks>
|
|
<para>
|
|
Retrieves the current policy values for the horizontal and vertical scrollbars.
|
|
</para>
|
|
</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 ScrolledWindow (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 ScrolledWindow, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.ScrolledWindow" /> 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 ScrolledWindow (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 ScrolledWindow, 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 ScrolledWindow (Gtk.Adjustment hadjustment, Gtk.Adjustment vadjustment);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="hadjustment" Type="Gtk.Adjustment" />
|
|
<Parameter Name="vadjustment" Type="Gtk.Adjustment" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a new scrolled window.</summary>
|
|
<param name="hadjustment">Horizontal adjustment.</param>
|
|
<param name="vadjustment">Vertical adjustment.</param>
|
|
<returns>To be added: an object of type 'Gtk.ScrolledWindow'</returns>
|
|
<remarks>
|
|
<para>
|
|
Creates a new scrolled window. The two arguments are the scrolled window's adjustments; these will be shared with the scrollbars and the child widget to keep the bars in sync with the child. Usually you want to pass <see cref="langword:null" /> for the adjustments, which will cause the scrolled window to create them for you.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ScrolledWindow ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'Gtk.ScrolledWindow'</returns>
|
|
<remarks>To be added</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.ScrolledWindow</summary>
|
|
<returns>The GLib Type for the Gtk.ScrolledWindow class.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Placement">
|
|
<MemberSignature Language="C#" Value="public Gtk.CornerType Placement { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.CornerType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.CornerType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Determines the location of the child widget with respect to the scrollbars.</summary>
|
|
<param name="value">Position of the child window.</param>
|
|
<returns />
|
|
<remarks>
|
|
<para>
|
|
Determines the location of the child widget with respect to the scrollbars. The default is <see cref="T:Gtk.CornerType.TopLeft" />, meaning the child is in the top left, with the scrollbars underneath and to the right. Other values in <see cref="T:Gtk.CornerType" /> are <see cref="T:Gtk.CornerType.TopRight" />, <see cref="T:Gtk.CornerType.BottomLeft" />, and <see cref="T:Gtk.CornerType.BottomRight" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="HscrollbarPolicy">
|
|
<MemberSignature Language="C#" Value="public Gtk.PolicyType HscrollbarPolicy { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PolicyType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.PolicyType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>When the horizontal scrollbar is displayed.</summary>
|
|
<param name="value">To be added: an object of type 'Gtk.PolicyType'</param>
|
|
<returns>To be added: an object of type 'Gtk.PolicyType'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Hadjustment">
|
|
<MemberSignature Language="C#" Value="public Gtk.Adjustment Hadjustment { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Adjustment</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.Adjustment" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the <see cref="T:Gtk.Adjustment" /> for the horizontal scrollbar.</summary>
|
|
<param name="value">Horizontal scroll adjustment.</param>
|
|
<returns>The horizontal GtkAdjustment.</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="VscrollbarPolicy">
|
|
<MemberSignature Language="C#" Value="public Gtk.PolicyType VscrollbarPolicy { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PolicyType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.PolicyType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>When the vertical scrollbar is displayed.</summary>
|
|
<param name="value">To be added: an object of type 'Gtk.PolicyType'</param>
|
|
<returns>To be added: an object of type 'Gtk.PolicyType'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Vadjustment">
|
|
<MemberSignature Language="C#" Value="public Gtk.Adjustment Vadjustment { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Adjustment</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.Adjustment" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or Gets the <see cref="T:Gtk.Adjustment" /> for the vertical scrollbar.</summary>
|
|
<param name="value">Vertical scroll adjustment.</param>
|
|
<returns>The vertical GtkAdjustment.</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ShadowType">
|
|
<MemberSignature Language="C#" Value="public Gtk.ShadowType ShadowType { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.ShadowType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.ShadowType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets the shadow type of the scrolled window.</summary>
|
|
<param name="value">Kind of shadow to draw around scrolled window contents.</param>
|
|
<returns>The current shadow type.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="WindowPlacement">
|
|
<MemberSignature Language="C#" Value="public Gtk.CornerType WindowPlacement { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.CornerType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.CornerType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Where the contents are located with respect to the scrollbars.</summary>
|
|
<param name="value">To be added: an object of type 'Gtk.CornerType'</param>
|
|
<returns>To be added: an object of type 'Gtk.CornerType'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ScrollChild">
|
|
<MemberSignature Language="C#" Value="public event GtkSharp.ScrollChildHandler ScrollChild;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnpValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MoveFocusOut">
|
|
<MemberSignature Language="C#" Value="public event GtkSharp.MoveFocusOutHandler MoveFocusOut;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected ScrolledWindow (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 ScrolledWindow, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.ScrolledWindow" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |