2004-12-31 Shane Landrum <epicene@pobox.com>
* en/Gtk/Button.xml * en/Gtk/Calendar.xml * en/Gtk/ButtonBox.xml * en/Gtk/Bindings.xml * en/Gtk/CellRenderer.xml: Added docs svn path=/trunk/gtk-sharp/; revision=38220
This commit is contained in:
Shane Landrum
parent
4c5107d7f7
commit
a990c6af9a
6 changed files with 133 additions and 63 deletions
|
|
@ -1,3 +1,11 @@
|
|||
2004-12-31 Shane Landrum <epicene@pobox.com>
|
||||
|
||||
* en/Gtk/Button.xml
|
||||
* en/Gtk/Calendar.xml
|
||||
* en/Gtk/ButtonBox.xml
|
||||
* en/Gtk/Bindings.xml
|
||||
* en/Gtk/CellRenderer.xml: Added docs.
|
||||
|
||||
2004-12-31 Shane Landrum <epicene@pobox.com>
|
||||
|
||||
* en/Gtk/ArgFlags.xml
|
||||
|
|
|
|||
|
|
@ -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>Key bindings for individual widgets.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.Object</BaseTypeName>
|
||||
|
|
@ -29,11 +29,12 @@
|
|||
<Parameter Name="evnt" Type="Gdk.EventKey" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Looks up key bindings for <paramref name="object"/> to find one matching
|
||||
<paramref name="event"/>, and if one was found, activates it.</summary>
|
||||
<param name="objekt">a <see cref="T:Gtk.Object" /></param>
|
||||
<param name="evnt">a <see cref="T:Gdk.EventKey" /></param>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
|
@ -42,10 +43,10 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Public constructor.</summary>
|
||||
<returns>a <see cref="T:Gtk.Bindings" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
|||
|
|
@ -514,9 +514,11 @@ public class ButtonApp {
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>
|
||||
Whether the button grabs focus when it is clicked with the mouse.
|
||||
</summary>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Xalign">
|
||||
|
|
@ -527,9 +529,15 @@ public class ButtonApp {
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>a <see cref="T:System.Single" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>
|
||||
If the child of the button is a <see cref="T:Gtk.Misc"/>
|
||||
or <see cref="T:Gtk.Alignment"/>, this property
|
||||
can be used to control its horizontal alignment.
|
||||
</summary>
|
||||
<returns>a <see cref="T:System.Single" />;
|
||||
0.0 is left aligned, 1.0 is right aligned.
|
||||
</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Yalign">
|
||||
|
|
@ -540,9 +548,16 @@ public class ButtonApp {
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>a <see cref="T:System.Single" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>
|
||||
If the child of the button is a <see cref="T:Gtk.Misc"/>
|
||||
or <see cref="T:Gtk.Alignment"/>, this property
|
||||
can be used to control its vertical alignment.
|
||||
</summary>
|
||||
<returns>
|
||||
a <see cref="T:System.Single" />;
|
||||
0.0 is top aligned, 1.0 is bottom aligned.
|
||||
</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetAlignment">
|
||||
|
|
@ -556,10 +571,10 @@ public class ButtonApp {
|
|||
<Parameter Name="yalign" Type="System.Single&" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="xalign">a <see cref="T:System.Single" /></param>
|
||||
<param name="yalign">a <see cref="T:System.Single" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Gets the alignment of the child in the button.</summary>
|
||||
<param name="xalign">a <see cref="T:System.Single" /> to put the horizontal alignment in</param>
|
||||
<param name="yalign">a <see cref="T:System.Single" /> to put the vertical alignment in</param>
|
||||
<remarks>A convenience method; shouldn't be </remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SetAlignment">
|
||||
|
|
@ -573,11 +588,21 @@ public class ButtonApp {
|
|||
<Parameter Name="yalign" Type="System.Single" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="xalign">a <see cref="T:System.Single" /></param>
|
||||
<param name="yalign">a <see cref="T:System.Single" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>
|
||||
Sets the alignment of the child.
|
||||
</summary>
|
||||
<param name="xalign">a <see cref="T:System.Single" />,
|
||||
the horizontal position of the child; 0.0 is left aligned,
|
||||
1.0 is right aligned.</param>
|
||||
<param name="yalign">a <see cref="T:System.Single" />,
|
||||
the vertical position of the child; 0.0 is top aligned,
|
||||
1.0 is bottom aligned.</param>
|
||||
<remarks>
|
||||
This has no effect
|
||||
unless the button's child is a <see cref="T:Gtk.Misc"/>
|
||||
or <see cref="T:Gtk.Alignment"/>.
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
|||
|
|
@ -141,10 +141,10 @@
|
|||
<Parameter Name="ipad_y" Type="System.Int32&" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="ipad_x">a <see cref="T:System.Int32" /></param>
|
||||
<param name="ipad_y">a <see cref="T:System.Int32" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Gets the internal padding of the child widgets.</summary>
|
||||
<param name="ipad_x">a <see cref="T:System.Int32" />, the horizontal value</param>
|
||||
<param name="ipad_y">a <see cref="T:System.Int32" />, the vertical value</param>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SetChildSize">
|
||||
|
|
@ -158,10 +158,13 @@
|
|||
<Parameter Name="min_height" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>
|
||||
Sets the minimum width and height of this button box's
|
||||
child widgets.
|
||||
</summary>
|
||||
<param name="min_width">a <see cref="T:System.Int32" /></param>
|
||||
<param name="min_height">a <see cref="T:System.Int32" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SetChildIpadding">
|
||||
|
|
@ -175,10 +178,10 @@
|
|||
<Parameter Name="ipad_y" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="ipad_x">a <see cref="T:System.Int32" /></param>
|
||||
<param name="ipad_y">a <see cref="T:System.Int32" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets the internal padding of the child widgets.</summary>
|
||||
<param name="ipad_x">a <see cref="T:System.Int32" />, the horizontal value</param>
|
||||
<param name="ipad_y">a <see cref="T:System.Int32" />, the vertical value</param>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetChildSize">
|
||||
|
|
@ -192,10 +195,13 @@
|
|||
<Parameter Name="min_height" Type="System.Int32&" RefType="out" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>
|
||||
Sets the minimum width and height of this button box's
|
||||
child widgets.
|
||||
</summary>
|
||||
<param name="min_width">a <see cref="T:System.Int32" /></param>
|
||||
<param name="min_height">a <see cref="T:System.Int32" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Item">
|
||||
|
|
@ -224,10 +230,10 @@
|
|||
<Parameter Name="child" Type="Gtk.Widget" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Returns whether <paramref name="child"/> should appear in a secondary group of children.</summary>
|
||||
<param name="child">a <see cref="T:Gtk.Widget" /></param>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SetChildSecondary">
|
||||
|
|
@ -241,11 +247,31 @@
|
|||
<Parameter Name="is_secondary" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>
|
||||
Sets whether <paramref name="child"/> should appear in a secondary group of children.
|
||||
A typical use of a secondary child is the help button in a dialog.
|
||||
</summary>
|
||||
<param name="child">a <see cref="T:Gtk.Widget" /></param>
|
||||
<param name="is_secondary">a <see cref="T:System.Boolean" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<param name="is_secondary">a <see cref="T:System.Boolean" />: if
|
||||
<see langword="true"/>, the <paramref name="child"/> appears in a secondary group of the button box.
|
||||
</param>
|
||||
<remarks>
|
||||
This group appears after the other children if the style
|
||||
is <see cref="T:Gtk.ButtonBox.Start" />,
|
||||
<see cref="T:Gtk.ButtonBox.Spread" /> or
|
||||
<see cref="T:Gtk.ButtonBox.Edge" />,
|
||||
and before the the other children if the style
|
||||
is %GTK_BUTTONBOX_END.
|
||||
For horizontal button boxes, the definition
|
||||
of before/after depends on direction of the widget (see
|
||||
<see cref="T:Gtk.Widget.SetDirection" />). If the style is
|
||||
<see cref="T:Gtk.ButtonBox.Start" />
|
||||
or <see cref="T:Gtk.ButtonBox.End" />, then the secondary
|
||||
children are aligned at
|
||||
the other end of the button box from the main children. For the
|
||||
other styles, they appear immediately next to the main children.
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
|||
|
|
@ -472,9 +472,9 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The selected day as a number between 1 and 31, or 0 to unselect the currently selected day.</summary>
|
||||
<returns>a <see cref="T:System.Int32" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ShowWeekNumbers">
|
||||
|
|
@ -485,9 +485,9 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>If <see langword="true"/>, week numbers are displayed</summary>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ShowDayNames">
|
||||
|
|
@ -498,9 +498,9 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>If <see langword="true"/>, day names are displayed.</summary>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ShowHeading">
|
||||
|
|
@ -511,9 +511,9 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>If <see langword="true"/>, a heading is displayed</summary>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Month">
|
||||
|
|
@ -524,9 +524,9 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The selected month as a number between 0 and 11.</summary>
|
||||
<returns>a <see cref="T:System.Int32" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Year">
|
||||
|
|
@ -537,9 +537,9 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The selected year.</summary>
|
||||
<returns>a <see cref="T:System.Int32" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="NoMonthChange">
|
||||
|
|
@ -550,9 +550,9 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>If <see langword="true"/>, the selected month can not be changed.</summary>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="DisplayOptions">
|
||||
|
|
@ -571,4 +571,4 @@ void HandleDaySelected (object obj, EventArgs args)
|
|||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
|||
|
|
@ -376,7 +376,7 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>A protected constructor. (FIXME: elaborate.)</summary>
|
||||
<summary>Protected constructor.</summary>
|
||||
<returns>a <see cref="T:Gtk.CellRenderer" /></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
|
|
@ -465,8 +465,14 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>
|
||||
This event is fired when the user cancels the process of
|
||||
editing a cell.
|
||||
</summary>
|
||||
<remarks>
|
||||
For example, an editable cell renderer could be written to cancel
|
||||
editing when the user presses Escape.
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="OnEditingCanceled">
|
||||
|
|
@ -489,9 +495,13 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Causes the cell renderer to fire an <see cref="M:Gtk.CellRenderer.EditingCanceled" /> event.</summary>
|
||||
<remarks>
|
||||
This function is for use only by implementations of cell renderers that need to
|
||||
notify the client program that an editing process was canceled and the
|
||||
changes were not committed.
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
|||
Loading…
Reference in a new issue