2004-12-12 Shane Landrum <epicene@pobox.com>

* en/Gtk/ToolItem.xml
	* en/Gtk/Toolbar.xml: Expanded docs for toolbar-related classes.
	* en/Gtk/SubmenuDirection.xml
	* en/Gtk/SubmenuPlacement.xml: Docced submenu enums.


svn path=/trunk/gtk-sharp/; revision=37678
This commit is contained in:
Shane Landrum 2004-12-13 02:51:29 +00:00
parent 4da41dbe67
commit c11a708513
5 changed files with 192 additions and 82 deletions

View File

@ -1,3 +1,10 @@
2004-12-12 Shane Landrum <epicene@pobox.com>
* en/Gtk/ToolItem.xml
* en/Gtk/Toolbar.xml: Expanded docs for toolbar-related classes.
* en/Gtk/SubmenuDirection.xml
* en/Gtk/SubmenuPlacement.xml: Docced submenu enums.
2004-12-09 Mike Kestner <mkestner@novell.com>
* en/Gtk/HTML*.xml : size_t marshaling updates.

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>Enumeration for direction of submenus.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,8 +37,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Left direction.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="GtkDirectionRight">
@ -50,8 +50,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Right direction.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="value__">
@ -68,4 +68,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

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>Enumeration for placement of submenus.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,8 +37,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Place submenu top-to-bottom.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="GtkLeftRight">
@ -50,8 +50,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Place submenu left-to-right.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="value__">
@ -68,4 +68,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

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>Objects to fill a <see cref="T:Gtk.Toolbar"/>.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>Gtk.Bin</BaseTypeName>
@ -36,8 +36,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Override for any actions required before object destruction.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="OnToolbarReconfigured">
@ -96,10 +96,15 @@
<Parameter Name="menu_item" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Sets the <see cref="T:Gtk.MenuItem"/> used in the toolbar overflow menu.
</summary>
<param name="menu_item_id">a <see cref="T:System.String" /></param>
<param name="menu_item">a <see cref="T:Gtk.Widget" /></param>
<remarks>To be added</remarks>
<remarks>
The <paramref name="menu_item_id"/> is used to identify the caller of this function and
should also be used with <see cref="M:Gtk.ToolItem.GetProxyMenuItem"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="GetProxyMenuItem">
@ -112,10 +117,22 @@
<Parameter Name="menu_item_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
If <paramref name="menu_item_id"/> matches the string passed to
<see cref="M:Gtk.ToolItem.SetProxyMenuItem"/>,
return the corresponding <see cref="T:Gtk.MenuItem"/>.
</summary>
<param name="menu_item_id">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks>
Custom subclasses of <see cref="T:Gtk.ToolItem"/> should use this
function to update their menu item when the
<see cref="T:Gtk.ToolItem"/> changes. That the
<paramref name="menu_item_id"/>s must match ensures that a
<see cref="T:Gtk.ToolItem"/> will not
inadvertently change a menu item that they did not create.
</remarks>
</Docs>
</Member>
<Member MemberName="SetTooltip">
@ -130,11 +147,15 @@
<Parameter Name="tip_private" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Sets the <see cref="T:Gtk.Tooltips"/> object to be used for
this tool item, the text to be displayed as tooltip on the
item and the private text to be used.
</summary>
<param name="tooltips">a <see cref="T:Gtk.Tooltips" /></param>
<param name="tip_text">a <see cref="T:System.String" /></param>
<param name="tip_private">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<param name="tip_text">a <see cref="T:System.String" />, the tooltip text for the item</param>
<param name="tip_private">a <see cref="T:System.String" />, the pricate text</param>
<remarks/>
</Docs>
</Member>
<Member MemberName="RetrieveProxyMenuItem">
@ -145,9 +166,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
Returns the <see cref="T:Gtk.MenuItem"/> that was last set by
<see cref="M:Gtk.ToolItem.SetProxyMenuItem"/>; that is, the
<see cref="T:Gtk.MenuItem"/> that is going to appear in the
overflow menu.
</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -158,10 +184,10 @@
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.ToolItem" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -172,10 +198,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<summary>Constructor for internal use. Do not use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C object.</param>
<returns>a <see cref="T:Gtk.ToolItem" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -184,9 +210,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.ToolItem" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="GType">
@ -199,7 +225,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="VisibleHorizontal">
@ -210,9 +236,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Whether the toolbar item is visible when the toolbar is in a horizontal orientation.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="VisibleVertical">
@ -223,9 +249,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Whether the toolbar item is visible when the toolbar is in a vertical orientation.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="IsImportant">
@ -236,9 +262,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Whether the toolbar item is considered important.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
When TRUE, toolbar buttons show text when the toolbar is in
<see cref="T:Gtk.ToolbarStyle.BothHoriz"/> mode.
</remarks>
</Docs>
</Member>
<Member MemberName="ToolbarStyle">
@ -249,9 +278,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Sets some display styles for this toolbar; see
<see cref="T:Gtk.ToolbarStyle" /> for details. </summary>
<returns>a <see cref="T:Gtk.ToolbarStyle" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Orientation">
@ -262,9 +292,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The orientation used for this tool item. See <see cref="T:Gtk.Orientation" />.</summary>
<returns>a <see cref="T:Gtk.Orientation" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="IconSize">
@ -275,9 +305,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The size of icons in this toolbar. See <see cref="T:Gtk.IconSize" />.</summary>
<returns>a <see cref="T:Gtk.IconSize" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="UseDragWindow">
@ -288,9 +318,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
Whether this toolitem has a drag window.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
When this is TRUE the toolitem can be used as a drag source through
<see cref="M:Gtk.Drag.SourceSet"/>.
When this toolitem has a drag window it will intercept all events,
even those that would otherwise be sent to a child of the toolitem.
</remarks>
</Docs>
</Member>
<Member MemberName="ReliefStyle">
@ -301,9 +338,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
Returns the relief style of this toolitem. See <see cref="T:Gtk.ReliefStyle" />.
</summary>
<returns>a <see cref="T:Gtk.ReliefStyle" /></returns>
<remarks>To be added</remarks>
<remarks>
Custom subclasses of <see cref="T:Gtk.ToolItem"/> should call
this function in the handler
of the <see cref="E:Gtk.ToolItem.ToolbarReconfigured"/> signal
to find out the relief style of buttons.
</remarks>
</Docs>
</Member>
<Member MemberName="Expand">
@ -314,12 +358,18 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
Whether this toolitem is allocated extra space when there
is more room on the toolbar then needed for the items.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
If true, the effect is that the item gets bigger when the
toolbar gets bigger and smaller when the toolbar gets smaller.
</remarks>
</Docs>
</Member>
<Member MemberName="Homogeneous">
<see cref="T:Gtk.ReliefStyle" /> <Member MemberName="Homogeneous">
<MemberSignature Language="C#" Value="public bool Homogeneous { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
@ -327,9 +377,15 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
Whether this toolitem is to be allocated the same size as other
homogeneous items.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
If true, the effect is that all homogeneous items will have
the same width as the widest of the items.
</remarks>
</Docs>
</Member>
<Member MemberName="ToolbarReconfigured">
@ -340,8 +396,21 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
This signal is emitted when some property of the toolbar that the
item is a child of changes.
</summary>
<remarks>
For custom subclasses of
<see cref="T:Gtk.ToolItem"/>,
the default handler of this signal uses the properties
<see cref="P:Gtk.Toolbar.Orientation"/>,
<see cref="P:Gtk.Toolbar.Style"/>,
<see cref="P:Gtk.Toolbar.IconSize"/>, and
<see cref="P:Gtk.Toolbar.ReliefStyle"/>
to find out what the toolbar should look like and change
themselves accordingly.
</remarks>
</Docs>
</Member>
<Member MemberName="CreateMenuProxy">
@ -353,7 +422,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="TooltipSet">
@ -364,9 +433,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
This signal is emitted when the toolitem's tooltip changes.
</summary>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -583,9 +583,9 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Whether to show an arrow if the toolbar doesn't fit.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="ReliefStyle">
@ -596,9 +596,9 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The relief style of buttons on the toolbar.</summary>
<returns>a <see cref="T:Gtk.ReliefStyle" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="NItems">
@ -609,9 +609,9 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The number of items on the toolbar.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="PopupContextMenu">
@ -622,8 +622,12 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the user right-clicks the toolbar or uses the
keybinding to display a popup menu.</summary>
<remarks>
Application developers should handle this signal if they want
to display a context menu on the toolbar.
</remarks>
</Docs>
</Member>
<Member MemberName="OnPopupContextMenu">
@ -657,10 +661,14 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Highlights the toolbar to give an idea of what it would look like
if <paramref name="tool_item"/> was added to the toolbar at the
position indicated by <paramref name="index"/>.
</summary>
<param name="tool_item">a <see cref="T:Gtk.ToolItem" /></param>
<param name="index">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="GetNthItem">
@ -673,10 +681,12 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Returns the <paramref name="n"/>th item on the toolbar,
or <see langword="null"/> if the toolbar does not contain an
<paramref name="n"/>th item.</summary>
<param name="n">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.ToolItem" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Insert">
@ -690,10 +700,18 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
<Parameter Name="pos" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Insert a <see cref="T:Gtk.ToolItem"/> into the toolbar at position
<paramref name="pos"/>.
</summary>
<param name="item">a <see cref="T:Gtk.ToolItem" /></param>
<param name="pos">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks>
If <paramref name="pos"/> is 0 the item is prepended to the start
of the toolbar.
If <paramref name="pos"/> is negative, the item is appended to the
end of the toolbar.
</remarks>
</Docs>
</Member>
<Member MemberName="GetItemIndex">
@ -706,10 +724,16 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
<Parameter Name="item" Type="Gtk.ToolItem" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Returns the position of <paramref name="item"/> on the toolbar,
starting from 0.
</summary>
<param name="item">a <see cref="T:Gtk.ToolItem" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>
It is an error if <paramref name="item"/> is not a child of
the toolbar.
</remarks>
</Docs>
</Member>
<Member MemberName="GetDropIndex">
@ -723,11 +747,19 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Returns the position corresponding to the indicated point on
the toolbar.
</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>
This is useful when dragging items to the toolbar:
this function returns the position a new item should be
inserted. <paramref name="x"/> and <paramref name="y"/> are in
toolbar coordinates.
</remarks>
</Docs>
</Member>
<Member MemberName="Item">
@ -747,4 +779,4 @@ If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the n
</Docs>
</Member>
</Members>
</Type>
</Type>