ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-24 12:35:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

2004-12-20 John Luke <john.luke@gmail.com>

Browse source 
* en/Gtk/CellView.xml: doc most of this
        * en/Gtk/EntryCompletion.xml: add an example from GtkDemo


svn path=/trunk/gtk-sharp/; revision=38008
This commit is contained in:
John Luke 2004-12-21 00:16:14 +00:00
parent 7535410958
commit 2cdcc3714c
3 changed files with 90 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2004-12-20 John Luke <john.luke@gmail.com>
* en/Gtk/CellView.xml: doc most of this
* en/Gtk/EntryCompletion.xml: add an example from GtkDemo
2004-12-20 Dan Winship <danw@novell.com>
* en/Gtk/TextCharPredicate.xml: update signature... this is usable now

60
doc/en/Gtk/CellView.xml
View file

@ -9,8 +9,8 @@
</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>To be added</summary>
<remarks>To be added</remarks>
<summary>A widget displaying a single row of a <see cref="T:Gtk.TreeModel" /></summary>
<remarks>A <see cref="T:Gtk.CellView" /> displays a single row of a <see cref="T:Gtk.TreeModel" />, using cell renderers just like <see cref="T:Gtk.TreeView" />. <see cref="T:Gtk.CellView" /> does not support some of the more complex features of <see cref="T:Gtk.TreeView" />, like cell editing and drag and drop.</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -41,10 +41,10 @@
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes its show <paramref name="markup" />.</summary>
<param name="markup">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="NewWithText">
@ -57,10 +57,10 @@
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes its show <paramref name="text" />.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -105,11 +105,11 @@
<Parameter Name="requisition" Type="Gtk.Requisition" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets <paramref name="requisition" /> to the size needed by the CellView to display the model row pointed to by <paramref name="path" />.</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="requisition">a <see cref="T:Gtk.Requisition" /></param>
<param name="requisition">a <see cref="T:Gtk.Requisition" />, return location for the size</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Reorder">
@ -217,10 +217,10 @@
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Internal constructor</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -231,10 +231,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -243,9 +243,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget.</summary>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -256,10 +256,10 @@
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererPixbuf" /> to it, and makes its show <paramref name="pixbuf" />.</summary>
<param name="pixbuf">a <see cref="T:Gdk.Pixbuf" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -270,9 +270,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.CellView" />.</remarks>
</Docs>
</Member>
<Member MemberName="BackgroundGdk">
@ -283,9 +283,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The background color as a <see cref="T:Gdk.Color" /></summary>
<returns>a <see cref="T:Gdk.Color" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Background">
@ -295,9 +295,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Background color as a string.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Model">
@ -307,9 +307,9 @@
<ReturnType>Gtk.TreeModel</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Sets the model for the CellView.</summary>
<returns>a <see cref="T:Gtk.TreeModel" /></returns>
<remarks>To be added</remarks>
<remarks>If the CellView already has a model set, it will remove it before setting the new model. If <paramref name="model" /> is <see langword="null" />, then it will unset the old model.</remarks>
</Docs>
</Member>
<Member MemberName="BackgroundColor">
@ -319,9 +319,9 @@
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The background color</summary>
<returns>a <see cref="T:Gdk.Color" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="DisplayedRow">
@ -332,9 +332,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.TreePath" /></returns>
<remarks>To be added</remarks>
<summary>The row of the model that is currently displayed</summary>
<returns>a <see cref="T:Gtk.TreePath" />, or <see langword="null" /> to unset.</returns>
<remarks>If the path is unset, then the contents of the cellview "stick" at their last value; this is not normally a desired result, but may be a needed intermediate state if say, the model for the <see cref="T:Gtk.CellView" /> becomes temporarily empty.</remarks>
</Docs>
</Member>
<Member MemberName="SetCellDataFunc">

60
doc/en/Gtk/EntryCompletion.xml
View file

@ -13,7 +13,57 @@
This object allows a widget to suggest possible completions of a string which has been partially entered.
</summary>
<remarks>
The partially-entered string is also referred to as a "key".
<para>
The partially-entered string is also referred to as a "key".
</para>
<example>
<code lang="C#">
using System;
using Gtk;
public class DemoEntryCompletion : Window
{
static void Main ()
{
Application.Init ();
new DemoEntryCompletion ();
Application.Run ();
}
public DemoEntryCompletion () : base ("Demo Entry Completion")
{
this.BorderWidth = 10;
this.Resizable = false;
VBox vbox = new VBox ();
Label label = new Label ("Completion demo, try writing &lt;b&gt;total&lt;/b&gt; or &lt;/b&gt;gnome&lt;/b&gt; for example.");
label.UseMarkup = true;
vbox.PackStart (label, false, true, 0);
Entry entry = new Entry ();
entry.Completion = new EntryCompletion ();
entry.Completion.Model = CreateCompletionModel ();
entry.Completion.TextColumn = 0;
vbox.PackStart (entry, false, true, 0);
this.Add (vbox);
this.ShowAll ();
}
TreeModel CreateCompletionModel ()
{
ListStore store = new ListStore (typeof (string));
store.AppendValues ("GNOME");
store.AppendValues ("total");
store.AppendValues ("totally");
return store;
}
}
</code>
</example>
</remarks>
</Docs>
<Base>
@ -302,9 +352,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks />
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.EntryCompletion" />.</remarks>
</Docs>
</Member>
<Member MemberName="MinimumKeyLength">
@ -332,7 +382,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Setting this property generates acompletion list with just strings.
<summary>Setting this property generates a completion list with just strings.
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>
@ -446,4 +496,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>