ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* en/Gtk/AccelGroup.xml: revert parts of my last patch, as some of

Browse source 
the links do not resolve due to bug #38538.

* en/Gtk/Button.xml (NewFromLabel):
(NewFromStock): documented.

* en/Gtk/Frame.xml (GetLabelAlign): documented.

* en/Gtk/IconFactory.xml:
* en/Gtk/IconSet.xml:
* en/Gtk/IconSize.xml:
* en/Gtk/IconSource.xml: documented.

* en/Gtk/Paned.xml: added documentation for the events.

* en/Gtk/ResponseType.xml: documented.

svn path=/trunk/gtk-sharp/; revision=15916
This commit is contained in:
Duncan Mak 2003-07-04 07:49:31 +00:00
parent 55683e5118
commit fd57533e7d
10 changed files with 627 additions and 189 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/ChangeLog
View file

@ -1,3 +1,22 @@
2003-07-04 Duncan Mak <duncan@ximian.com>
* en/Gtk/AccelGroup.xml: revert parts of my last patch, as some of
the links do not resolve due to bug #38538.
* en/Gtk/Button.xml (NewFromLabel):
(NewFromStock): documented.
* en/Gtk/Frame.xml (GetLabelAlign): documented.
* en/Gtk/IconFactory.xml:
* en/Gtk/IconSet.xml:
* en/Gtk/IconSize.xml:
* en/Gtk/IconSource.xml: documented.
* en/Gtk/Paned.xml: added documentation for the events.
* en/Gtk/ResponseType.xml: documented.
2003-07-02 John Luke <jluke@cfl.rr.com>
* en/Gtk/Container.xml: add first draft

59
doc/en/Gtk/AccelGroup.xml
View file

@ -12,11 +12,11 @@
<para>
A GtkAccelGroup represents a group of keyboard accelerators,
typically attached to a toplevel GtkWindow (with <see
cref="M:Gtk.Window.AddAccelGroup (Gtk.AccelGroup)" />). Usually
you won't need to create a Gtk.AccelGroup directly; instead,
when using <see cref="T:Gtk.ItemFactory" />, Gtk#
automatically sets up the accelerators for your menus in the
item factory's <see cref="T:Gtk.AccelGroup" />.
cref="M:Gtk.Window.AddAccelGroup(Gtk.AccelGroup)" />). Usually
you won't need to create a <see cref="T:Gtk.AccelGroup" />
directly; instead, when using <see cref="T:Gtk.ItemFactory"
/>, Gtk# automatically sets up the accelerators for your menus
in the item factory's <see cref="T:Gtk.AccelGroup" />.
</para>
<para>
Note that accelerators are different from
@ -25,8 +25,9 @@
for. For example "Ctrl+Q" might appear alongside the "Quit"
menu item. Mnemonics are shortcuts for GUI elements such as
text entries or buttons; they appear as underlined
characters. See <see cref="M:Gtk.Label.NewWithMnemonic()" />. Menu items can
have both accelerators and mnemonics, of course.
characters. <see
cref="M:Gtk.Label.NewWithMnemonic(System.String)" />. Menu
items can have both accelerators and mnemonics, of course.
</para>
</remarks>
</Docs>
@ -55,7 +56,8 @@
<Docs>
<summary>Finds the <see cref="T:Gtk.AccelGroup" /> to which closure is connected.</summary>
<param name="closure">A GClosure (<see cref="T:System.IntPtr" />)</param>
<returns>The <see cref="T:Gtk.AccelGroup" /> to which <see paramref="closure" /> is connected, or <see langword="null" />.</returns>
<returns>The <see cref="T:Gtk.AccelGroup" /> to which <see
paramref="closure" /> is connected, or <see langword="null" />.</returns>
<remarks />
</Docs>
</Member>
@ -67,7 +69,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Undoes the last call to <see cref="M:Gtk.AccelGroup.Lock ()" /> on its object.</summary>
<summary>Undoes the last call to <see cref="M:Gtk.AccelGroup.Lock" /> on its object.</summary>
<remarks />
</Docs>
</Member>
@ -81,7 +83,8 @@
<Parameter Name="closure" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Removes an accelerator previously installed through <see cref="M:Gtk.AccelGroup.Connect ()" />.</summary>
<summary>Removes an accelerator previously installed through
<see cref="M:Gtk.AccelGroup.Connect(System.UInt32,Gdk.ModifierType,Gtk.AccelFlags,System.IntPtr)" />.</summary>
<param name="closure">The closure to remove from this accelerator group.</param>
<returns>
<see langword="true" /> if the closure was found and got disconnected</returns>
@ -99,15 +102,14 @@
<Parameter Name="closure" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>
Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers
(see <see cref="M:Gtk.AccelMap.AddEntry ()" />)). When the
<summary>Installs an accelerator in this group, using an
accelerator path to look up the appropriate key and modifiers
(see 'gtk_accel_map_add_entry'). When the
group is being activated in response to a call to <see
cref="M:Gtk.AccelGroup.Activate ()" />, <see
paramref="closure" /> will be invoked if the accel_key and
accel_mods from <see cref="M:Gtk.AccelGroup.Activate ()" />
match the key and modifiers for the path.
</summary>
cref="M:Gtk.AccelGroup.Activate" />, <see
parmaref="closure" /> will be invoked if the accel_key and
accel_mods from <see cref="M:Gtk.AccelGroup.Activate" />
match the key and modifiers for the path.</summary>
<param name="accel_path">Path used for determining key and modifiers.</param>
<param name="closure">Closure to be executed upon accelerator activation</param>
</Docs>
@ -139,7 +141,7 @@
<Parameter Name="accel_mods" Type="Gdk.ModifierType" />
</Parameters>
<Docs>
<summary>Removes an accelerator previously installed through <see cref="M:Gtk.AccelGroup.Connect (uint, Gdk.ModifierType, Gtk.AccelFlags, System.IntPt)" />.</summary>
<summary>Removes an accelerator previously installed through <see cref="M:Gtk.AccelGroup.Connect(System.UInt32,Gdk.ModifierType,Gtk.AccelFlags,System.IntPtr)" />.</summary>
<param name="accel_key">Key value of the accelerator.</param>
<param name="accel_mods">Modifier combination of the accelerator.</param>
<returns>
@ -162,7 +164,7 @@
<param name="accel_key">Key value of the accelerator.</param>
<param name="accel_mods">Modifier combination of the accelerator.</param>
<param name="n_entries">Location to return the number of entries found, or <see langword="null" />.</param>
<returns>An array of n_entries <see cref="T:Gtk.AccelGroupEntry" /> elements, or <see langword="null" />.</returns>
<returns>An array of <see paramref="n_entries" /> <see cref="T:Gtk.AccelGroupEntry" /> elements, or <see langword="null" />.</returns>
</Docs>
</Member>
<Member MemberName="Lock">
@ -174,7 +176,12 @@
<Parameters />
<Docs>
<summary>Locks the given accelerator group.</summary>
<remarks>Locking an accelerator group prevents the accelerators contained within it to be changed during runtime. Refer to <see cref="M:Gtk.AccelMap.ChangeEntry ()" /> about runtime accelerator changes. If called more than once, accel_group remains locked until <see cref="M:Gtk.AccelGroup.Unlock ()" /> has been called an equivalent number of times.
<remarks>Locking an accelerator group prevents the
accelerators contained within it to be changed duringb
runtime. Refer to 'gtk_accel_map_change_entry ()' about
runtime accelerator changes. If called more than once, it
remains locked until <see cref="M:Gtk.AccelGroup.Unlock" />
has been called an equivalent number of times.
</remarks>
</Docs>
</Member>
@ -191,7 +198,15 @@
<Parameter Name="closure" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Installs an accelerator in this group. When accel_group is being activated in response to a call to <see cref="M:Gtk.AccelGroup.Activate ()" />, closure will be invoked if the accel_key and accel_mods from <see cref="M:Gtk.AccelGroup.Activate ()" /> match those of this connection. The signature used for the closure is that of <see cref="M:Gtk.AccelGroup.Activate ()" />.</summary>
<summary>
Installs an accelerator in this group. When accel_group is
being activated in response to a call to <see
cref="M:Gtk.AccelGroup.Activate" />, closure will be
invoked if the accel_key and accel_mods from <see
cref="M:Gtk.AccelGroup.Activate" /> match those of this
connection. The signature used for the closure is that of
<see cref="M:Gtk.AccelGroup.Activate" />.
</summary>
<param name="accel_key">Key value of the accelerator.</param>
<param name="accel_mods">Modifier combination of the accelerator.</param>
<param name="accel_flags">A flag mask to configure this accelerator.</param>

22
doc/en/Gtk/Button.xml
View file

@ -244,10 +244,13 @@ public class ButtonApp {
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="label">an object of type <see cref="T:System.String"/></param>
<returns>an object of type <see cref="T:Gtk.Button"/></returns>
<remarks>To be added</remarks>
<summary>Creates a <see cref="T:Gtk.Button" /> widget with a <see
cref="T:Gtk.Label" /> child containing the given text.</summary>
<param name="label">
The text you want the <see cref="T:Gtk.Label" /> to hold.
</param>
<returns>The newly created <see cref="T:Gtk.Button" /> widget.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="NewFromStock">
@ -260,10 +263,13 @@ public class ButtonApp {
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">an object of type <see cref="System.String"/></param>
<returns>an object of type <see cref="T:Gtk.Button"/></returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gtk.Button" /> containing the image and text from a stock item.</summary>
<param name="stock_id">The name of the stock item</param>
<returns>a new <see cref="T:Gtk.Button" /></returns>
<remarks>
The valid names of Stock items can be found in the <see
cref="T:Gtk.Stock" /> class.
</remarks>
</Docs>
</Member>
<Member MemberName="Leave">

8
doc/en/Gtk/Frame.xml
View file

@ -243,10 +243,10 @@
<Parameter Name="yalign" Type="System.Single&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="xalign">To be added: an object of type 'float&amp;'</param>
<param name="yalign">To be added: an object of type 'float&amp;'</param>
<remarks>To be added</remarks>
<summary>Retrieves the X and Y alignment of the frame's label.</summary>
<param name="xalign">Location to store X alignment of frame's label</param>
<param name="yalign">Location to store Y alignment of frame's label</param>
<remarks />
</Docs>
</Member>
</Members>

136
doc/en/Gtk/IconFactory.xml
View file

@ -1,5 +1,5 @@
<Type Name="IconFactory" FullName="Gtk.IconFactory">
<TypeSignature Language="C#" Value="public class IconFactory : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class IconFactory : GLib.Object, IWrapper, IDisposable" Maintainer="duncan" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,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>An icon factory manages a collection of Gtk.IconSet</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -33,10 +33,19 @@
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
<summary>Looks for an icon in the list of default icon factories.</summary>
<param name="stock_id">an icon name</param>
<returns>
a <see cref="T:Gtk.IconSet" />, or <see langword="null" />.
</returns>
<remarks>
Looks for an icon in the list of default icon factories. For
display to the user, you should use
<see cref="M:Gtk.Style.LookupIconSet(System.String)" /> on the <see
cref="T:Gtk.Style" /> for the widget
that will display the icon, instead of using this function
directly, so that themes are taken into account.
</remarks>
</Docs>
</Member>
<Member MemberName="AddDefault">
@ -47,8 +56,20 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Adds an icon factory to the list of icon factories searched
by <see cref="M:Gtk.Style.LookupIconSet" />.
</summary>
<remarks>
Adds an icon factory to the list of icon factories searched
by <see cref="M:Gtk.Style.LookupIconSet(System.String)"
/>. This means that, for example, <see
cref="C:Gtk.Image(System.String,Gtk.IconSize)" /> will be
able to find icons in factory. There will normally be an
icon factory added for each library or application that
comes with icons. The default icon factories can be
overridden by themes.
</remarks>
</Docs>
</Member>
<Member MemberName="Add">
@ -62,10 +83,27 @@
<Parameter Name="icon_set" Type="Gtk.IconSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<param name="icon_set">To be added: an object of type 'Gtk.IconSet'</param>
<remarks>To be added</remarks>
<summary>
Adds the given <see paramref="icon_set" /> to the icon factory, under the name
<see paramref="stock_id" />.
</summary>
<param name="stock_id">The icon's name</param>
<param name="icon_set"> The icon set</param>
<remarks>
Adds the given <see paramref="icon_set" /> to the icon factory, under the name
<see paramref="stock_id" />. <see paramref="stock_id" /> should be namespaced for your
application, e.g. "myapp-name-of-icon". Normally
applications create a <see cref="T:Gtk.IconFactory" />, then add it to the
list of default factories with
<see cref="M:Gtk.IconFactory.AddDefault" />. They pass the
<see paramref="stock_id" /> to widgets such as <see
cref="T:Gtk.Image" /> to display the icon. Themes can
provide an icon with the same name (such as
"myapp-name-of-icon") to override your application's
default icons. If an icon already existed in factory for
<see paramref="stock_id" />, it is unreferenced and replaced with the new
<see paramref="icon_set" />.
</remarks>
</Docs>
</Member>
<Member MemberName="Lookup">
@ -78,10 +116,21 @@
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
<summary>
Looks up a Stock ID in the icon factory.
</summary>
<param name="stock_id">an icon name</param>
<returns>
a <see cref="T:Gtk.IconSet" />, or <see langword="null" />.
</returns>
<remarks>
Looks up <see paramref="stock_id" /> in the icon factory, returning an icon set
if found, otherwise <see langword="null" />. For display to the user, you
should use <see cref="M:Gtk.Style.LookupIconSet(System.String)" /> on the
<see cref="T:Gtk.Style" /> for
the widget that will display the icon, instead of using this
function directly, so that themes are taken into account.
</remarks>
</Docs>
</Member>
<Member MemberName="RemoveDefault">
@ -92,8 +141,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Removes an icon factory from the list of default icon factories.
</summary>
<remarks>
Removes an icon factory from the list of default icon
factories. Not normally used; you might use it for a library
that can be unloaded or shut down.
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -130,9 +185,25 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.IconFactory'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gtk.IconFactory" />.</summary>
<returns>A new <see cref="T:Gtk.IconFactory" />.</returns>
<remarks>
Creates a new <see cref="T:Gtk.IconFactory" />. An icon factory manages a
collection of <see cref="T:Gtk.IconSet" />s; a <see
cref="T:Gtk.IconSet" /> manages a set of
variants of a particular icon (i.e. a GtkIconSet contains
variants for different sizes and widget states). Icons in an
icon factory are named by a stock ID, which is a simple
string identifying the icon. Each <see cref="T:Gtk.Style" /> has a list of
GtkIconFactorys derived from the current theme; those icon
factories are consulted first when searching for an icon. If
the theme doesn't set a particular icon, GTK+ looks for the
icon in a list of default icon factories, maintained by
<see cref="M:Gtk.IconFactory.AddDefault" /> and
<see cref="M:Gtk.IconFactory.RemoveDefault" />. Applications with icons
should add a default icon factory with their icons, which
will allow themes to override the icons for the application.
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -173,10 +244,13 @@
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<returns>To be added: an object of type 'Drawing.Size'</returns>
<remarks>To be added</remarks>
<summary>Obtains the pixel size of a semantic icon size.</summary>
<param name="size">a <see cref="T:Gtk.IconSize" /></param>
<returns>
the size of the <see cref="T:Gtk.IconSize" /> parameter,
<see paramref="size" /> as a <see cref="T:System.Drawing.Size" />.
</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="LookupIconSize">
@ -191,11 +265,11 @@
<Parameter Name="height" Type="System.Int32&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<param name="width">To be added: an object of type 'int&amp;'</param>
<param name="height">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
<summary>Obtains the pixel size of a semantic icon size</summary>
<param name="size">an icon size</param>
<param name="width">an integer to store the icon's width</param>
<param name="height">an integer to store the icon's height</param>
<remarks />
</Docs>
</Member>
</Members>

144
doc/en/Gtk/IconSet.xml
View file

@ -1,5 +1,5 @@
<Type Name="IconSet" FullName="Gtk.IconSet">
<TypeSignature Language="C#" Value="public class IconSet : GLib.Opaque, IWrapper" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class IconSet : GLib.Opaque, IWrapper" Maintainer="duncan" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,15 @@
</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 <see cref="T:Gtk.IconSet" /> represents a single icon in various sizes and widget states.
</summary>
<remarks>
A <see cref="T:Gtk.IconSet" /> represents a single icon in
various sizes and widget states. It can provide a <see
cref="T:Gdk.Pixbuf" /> for a given size and state on request,
and automatically caches some of the rendered GdkPixbuf objects.
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -35,15 +42,35 @@
<Parameter Name="detail" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="style">To be added: an object of type 'Gtk.Style'</param>
<param name="direction">To be added: an object of type 'Gtk.TextDirection'</param>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
<param name="detail">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>
Renders an icon using <see cref="M:Gtk.Style.RenderIcon(Gtk.IconSource,Gtk.TextDirection,Gtk.StateType,Gtk.IconSize,Gtk.Widget,System.String)"/>
</summary>
<param name="style">
a <see cref="T:Gtk.Style" /> associated with widget, or <see langword="null"/>
</param>
<param name="direction">The text direction</param>
<param name="state">The widget state</param>
<param name="size">The size of the icon</param>
<param name="widget">
widget that will display the icon, or <see langword="null"/>
</param>
<param name="detail">
detail to pass to the theme engine, or <see
langword="null"/>
</param>
<returns>a <see cref="T:Gdk.Pixbuf" /> to be displayed</returns>
<remarks>
Renders an icon using <see
cref="M:Gtk.Style.RenderIcon(Gtk.IconSource,Gtk.TextDirection,Gtk.StateType,Gtk.IconSize,Gtk.Widget,System.String)"/>. In
most cases, <see
cref="M:Gtk.Widget.RenderIcon(System.String,Gtk.IconSize,System.String)"
/> is better, since it automatically provides most of the arguments from the
current widget settings. This function never returns <see
langword="null" />;
if the icon can't be rendered (perhaps because an image file
fails to load), a default "missing image" icon will be
returned instead.
</remarks>
</Docs>
</Member>
<Member MemberName="GetSizes">
@ -57,7 +84,7 @@
<Parameter Name="n_sizes" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>This method needs fixing, the signature is incorrect</summary>
<param name="sizes">To be added: an object of type 'Gtk.IconSize'</param>
<param name="n_sizes">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
@ -71,9 +98,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
<summary>
Copy the IconSet by value.
</summary>
<returns>a copy of the current IconSet</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AddSource">
@ -86,9 +115,50 @@
<Parameter Name="source" Type="Gtk.IconSource" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Adds an IconSource to the current IconSet.
</summary>
<param name="source">To be added: an object of type 'Gtk.IconSource'</param>
<remarks>To be added</remarks>
<remarks>
<para>
Icon sets have a list of <see cref="T:Gtk.IconSource" />,
which they use as base icons for rendering icons in
different states and sizes. Icons are scaled, made to look
insensitive, etc. in <see
cref="M:Gtk.Style.RenderIcon(Gtk.IconSource,Gtk.TextDirection,Gtk.StateType,Gtk.IconSize,Gtk.Widget,System.String)"/>,
but <see cref="T:Gtk.IconSet" /> needs base images to work
with. The base images and when to use them are described
by a <see cref="T:Gtk.IconSource" />.
</para>
<para>
This function copies <see paramref="source" />, so you can reuse the same
source immediately without affecting the icon set.
</para>
<para>
An example of when you'd use this function: a web
browser's "Back to Previous Page" icon might point in a
different direction in Hebrew and in English; it might
look different when insensitive; and it might change size
depending on toolbar mode (small/large icons). So a single
icon set would contain all those variants of the icon, and
you might add a separate source for each one.
</para>
<para>
You should nearly always add a "default" icon source with
all fields wildcarded, which will be used as a fallback if
no more specific source matches. <see cref="T:Gtk.IconSet"
/>always prefers more specific icon sources to more
generic icon sources. The order in which you add the
sources to the icon set does not matter.
</para>
<para>
This <see cref="C:Gtk.IconSet(Gdk.Pixbuf)" /> constructor
creates a new icon set with a default icon source based on
the given pixbuf.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Ref">
@ -99,9 +169,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
<summary>Increments the reference count.</summary>
<returns>the IconSet with the incremented reference count</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Unref">
@ -112,8 +182,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Decrements the reference count</summary>
<remarks>
Decrements the reference count, and frees memory
if the reference count reaches 0.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -138,9 +211,16 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
<summary>
Creates a new <see cref="T:Gtk.IconSet" />. A <see
cref="T:Gtk.IconSet" /> represents a single
icon in various sizes and widget states. It can provide a
<see cref="T:Gdk.Pixbuf" /> for a given size and state on request, and
automatically caches some of the rendered <see
cref="T:Gdk.Pixbuf" /> objects.
</summary>
<returns>a new IconSet</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -151,10 +231,14 @@
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixbuf">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
<summary>
Creates a new <see cref="T:Gtk.IconSet" /> with <see paramref="pixbuf" /> as the default/fallback source image.
</summary>
<param name="pixbuf">
a <see cref="T:Gdk.Pixbuf" />
</param>
<returns>an <see cref="T:Gtk.IconSet" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">

37
doc/en/Gtk/IconSize.xml
View file

@ -7,8 +7,13 @@
</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>The possible icon sizes</summary>
<remarks>
<para>
This class contains all the valid icon sizes that is supported
by Gtk.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +39,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>This signifies an unsupported icon size.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Menu">
@ -46,8 +51,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The icon size for a <see cref="T:Gtk.MenuItem" />.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="SmallToolbar">
@ -58,8 +63,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The icon size for a small <see cref="T:Gtk.Toolbar" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="LargeToolbar">
@ -70,8 +75,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The icon size for a large <see cref="T:Gtk.Toolbar" />.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Button">
@ -82,8 +87,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The icon size for a <see cref="T:Gtk.Button" />.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Dnd">
@ -94,8 +99,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The icon size used during a drag-n-drop operation.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Dialog">
@ -106,8 +111,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The icon size used in a <see cref="T:Gtk.Dialog" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="value__">

270
doc/en/Gtk/IconSource.xml
View file

@ -1,5 +1,5 @@
<Type Name="IconSource" FullName="Gtk.IconSource">
<TypeSignature Language="C#" Value="public class IconSource : GLib.Opaque, IWrapper" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class IconSource : GLib.Opaque, IWrapper" Maintainer="duncan" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,56 @@
</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 GtkIconSource contains a <see cref="T:Gdk.Pixbuf" /> (or image
filename) that serves as the base image for one or more of the
icons in a <see cref="T:Gtk.IconSet" />, along with a
specification for which icons in the icon set will be based on
that pixbuf or image file. An icon set contains a set of icons
that represent the same logical concept in different states,
different global text directions, and different sizes.
</summary>
<remarks>
<para>
A GtkIconSource contains a <see cref="T:Gdk.Pixbuf" /> (or image
filename) that serves as the base image for one or more of the
icons in a <see cref="T:Gtk.IconSet" />, along with a
specification for which icons in the icon set will be based on
that pixbuf or image file. An icon set contains a set of icons
that represent the same logical concept in different states,
different global text directions, and different sizes.
</para>
<para>
So for example a web browser's "Back to Previous Page" icon
might point in a different direction in Hebrew and in English;
it might look different when insensitive; and it might change
size depending on toolbar mode (small/large icons). So a
single icon set would contain all those variants of the
icon. <see cref="T:Gtk.IconSet" /> contains a list of <see
cref="T:Gtk.IconSource" /> from which
it can derive specific icon variants in the set.
</para>
<para>
In the simplest case, <see cref="T:Gtk.IconSet" /> contains
one source pixbuf from which it derives all variants. The
<see cref="C:Gtk.IconSet(Gdk.Pixbuf)" /> constructor handles
this case; if you only have one source pixbuf, just use that
function.
</para>
<para>
If you want to use a different base pixbuf for different icon
variants, you create multiple icon sources, mark which
variants they'll be used to create, and add them to the icon
set with <see
cref="M:Gtk.IconSet.AddSource(Gtk.IconSource)" />.
</para>
<para>
By default, the icon source has all parameters
wildcarded. That is, the icon source will be used as the base
icon for any desired text direction, widget state, or icon
size.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -28,9 +76,15 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.IconSource'</returns>
<remarks>To be added</remarks>
<summary>
Creates a copy of the current <see
cref="T:Gtk.IconSource"/>; mostly useful for language
bindings.
</summary>
<returns>
a new GtkIconSource that is a copy of the current one
</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Free">
@ -41,8 +95,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Frees a dynamically-allocated icon source, along with its filename, size, and pixbuf fields.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -67,9 +121,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.IconSource'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gtk.IconSource" />.</summary>
<returns>a new <see cref="T:Gtk.IconSource" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -94,10 +148,38 @@
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
If the widget state is wildcarded, this source can be used
as the base image for an icon in any <see
cref="T:Gtk.StateType" />.
</summary>
<returns>
Whether or not the widget is wildcarded.
</returns>
<remarks>
<para>
If the widget state is wildcarded, this source can be used
as the base image for an icon in any <see
cref="T:Gtk.StateType" />. If the
widget state is not wildcarded, then the state the source
applies to should be set with <see
cref="P:Gtk.IconSource.State" />
and the icon source will only be used with that specific
state.
</para>
<para>
<see cref="T:Gtk.IconSet" /> prefers non-wildcarded
sources (exact matches) over wildcarded sources, and will
use an exact match when possible.
</para>
<para>
<see cref="T:Gtk.IconSet" /> will normally transform
wildcarded source images to produce an appropriate icon
for a given state, for example lightening an image on
prelight, but will not modify source images that match
exactly.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SizeWildcarded">
@ -110,10 +192,38 @@
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
If the icon size is wildcarded, this source can be used as
the base image for an icon of any size. If the size is not
wildcarded, then the size the source applies to should be
set with <see cref="P:Gtk.IconSource.Size" /> and the icon
source will only be used with that specific size.
</summary>
<param name="value">
<see langword="true" /> if the size is wildcarded,
<see langword="false" /> otherwise.
</param>
<returns>Whether the size is wildcarded or not</returns>
<remarks>
<para>
If the icon size is wildcarded, this source can be used as
the base image for an icon of any size. If the size is not
wildcarded, then the size the source applies to should be
set with <see cref="P:Gtk.IconSource.Size" /> and the icon
source will only be used with that specific size.
</para>
<para>
<see cref="T:Gtk.IconSet" /> prefers non-wildcarded
sources (exact matches) over wildcarded sources, and will
use an exact match when possible.
</para>
<para>
<see cref="T:Gtk.IconSet" /> will normally scale
wildcarded source images to produce an appropriate icon at
a given size, but will not change the size of source
images that match exactly.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Pixbuf">
@ -126,10 +236,18 @@
<Parameter Name="value" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
The base image used when creating icon variants of a <see
cref="T:Gtk.IconSet" />
</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<returns>the source pixbuf, or <see langword="null" /> if none is set.</returns>
<remarks>
<para>
If an icon source has both a filename and a pixbuf set, the
pixbuf will take priority.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Direction">
@ -142,10 +260,22 @@
<Parameter Name="value" Type="Gtk.TextDirection" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.TextDirection'</param>
<returns>To be added: an object of type 'Gtk.TextDirection'</returns>
<remarks>To be added</remarks>
<summary>
The text direction this icon source applies to.
</summary>
<param name="value">The text direction this source applies to</param>
<returns>
Obtains the text direction this icon source applies to. The
return value is only useful/meaningful if the text direction
is not wildcarded.
</returns>
<remarks>
Setting the text direction on an icon source makes no
difference if the text direction is wildcarded. Therefore,
you should usually set the <see
cref="P:Gtk.IconSource.DirectionWildcarded" /> property to
un-wildcard it in addition to calling this function.
</remarks>
</Docs>
</Member>
<Member MemberName="Size">
@ -158,10 +288,21 @@
<Parameter Name="value" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.IconSize'</param>
<returns>To be added: an object of type 'Gtk.IconSize'</returns>
<remarks>To be added</remarks>
<summary>
The icon size this icon source is intended to be used with.
</summary>
<param name="value">The icon size this source applies to</param>
<returns>
Obtains the icon size this source applies to. The return
value is only useful/meaningful if the icon size is not
wildcarded.
</returns>
<remarks>
Setting the icon size on an icon source makes no difference
if the size is wildcarded. Therefore, you should usually set
the <see cref="P:Gtk.IconSource.SizeWildcarded" /> property
to un-wildcard it in addition to calling this function.
</remarks>
</Docs>
</Member>
<Member MemberName="State">
@ -174,10 +315,22 @@
<Parameter Name="value" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gtk.StateType'</returns>
<remarks>To be added</remarks>
<summary>
The widget state this icon source applies to.
</summary>
<param name="value">The widget state this icon source applies to.</param>
<returns>
Obtains the widget state this icon source applies to. The
return value is only useful/meaningful if the widget state
is not wildcarded.
</returns>
<remarks>
Setting the widget state on an icon source makes no
difference if the state is wildcarded. Therefore, you should
usually set the <see cref="P:Gtk.IconSource.StateWildcarded"
/> propertyto un-wildcard it in addition to calling this
function.
</remarks>
</Docs>
</Member>
<Member MemberName="DirectionWildcarded">
@ -190,10 +343,32 @@
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
If the text direction is wildcarded, this source can be used
as the base image for an icon in any <see
cref="T:Gtk.TextDirection" />.
</summary>
<param name="value">
<see langword="true" /> if the text direction is wildcarded,
<see langword="false" /> otherwise.
</param>
<returns>Whether the text direction is wildcarded or not</returns>
<remarks>
<para>
If the text direction is wildcarded, this source can be
used as the base image for an icon in any <see
cref="T:Gtk.TextDirection" />. If the text direction is
not wildcarded, then the text direction the icon source
applies to should be set with <see
cref="P:Gtk.IconSource.Direction" />, and the icon source
will only be used with that text direction.
</para>
<para>
<see cref="T:Gtk.IconSet" /> prefers non-wildcarded
sources (exact matches) over wildcarded sources, and will
use an exact match when possible.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Filename">
@ -206,10 +381,21 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>
Retrieves the source filename, or <see langword="null" /> if none is set.
</summary>
<param name="value">
Sets the name of an image file to use as a base image when
creating icon variants for <see cref="T:Gtk.IconSet" />. The filename must be
absolute.
</param>
<returns>
Retrieves the source filename, or <see langword="null" /> if
none is set. The filename is not a copy, and should not be
modified or expected to persist beyond the lifetime of the
icon source.
</returns>
<remarks />
</Docs>
</Member>
</Members>

43
doc/en/Gtk/Paned.xml
View file

@ -258,8 +258,17 @@ public Widget GetExampleFrame()
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Emitted when paned has the focus and one of the tab key
combinations are pressed.
</summary>
<remarks>
This signal is emitted when paned has the focus and any of
the Tab, Ctrl-Tab, Shift-Tab or Ctrl-Shift-Tab keys
combinations are pressed. Tab and Ctrl-Tab set reversed to
<see langword="false" /> while Shift-Tab and Ctrl-Shift-Tab
set reversed to <see langword="true" />.
</remarks>
</Docs>
</Member>
<Member MemberName="MoveHandle">
@ -268,8 +277,10 @@ public Widget GetExampleFrame()
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Emitted when paned has the focus and the separator is moved.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="CancelPosition">
@ -278,8 +289,10 @@ public Widget GetExampleFrame()
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Emitted when the Esc key is pressed while paned has the focus.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AcceptPosition">
@ -288,8 +301,12 @@ public Widget GetExampleFrame()
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the paned has focus</summary>
<remarks>
This signal is emitted when paned has the focus and any of
the Return, Enter, Space keys are pressed. This will also
cause the child widget with the focus to be activated.
</remarks>
</Docs>
</Member>
<Member MemberName="ToggleHandleFocus">
@ -298,8 +315,10 @@ public Widget GetExampleFrame()
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Emitted when paned has the focus and F8 is pressed to give the focus to or take the focus from the separator handle.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="CycleChildFocus">
@ -308,8 +327,8 @@ public Widget GetExampleFrame()
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when F6 or Shift-F6 is pressed while paned has the focus.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">

78
doc/en/Gtk/ResponseType.xml
View file

@ -7,8 +7,17 @@
</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>
This enumeration contains the response signals that are emitted by a <see cref="T:Gtk.Dialog" />.
</summary>
<remarks>
When a button in a <see cref="T:Gtk.Dialog" /> is pressed, a
response signal is emitted with a response ID. While positive
responses are entirely user-defined, the <see
cref="T:Gtk.ResponseType" /> enumeration (all the members have
values less than zero) could be also be used instead for
convience.
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +43,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
This is returned if a response widget has no response ID, or
has been programmatically hidden or destroyed.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Reject">
@ -46,8 +58,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Accept">
@ -58,8 +72,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="DeleteEvent">
@ -70,8 +86,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>This is returned when the dialog is deleted.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Ok">
@ -82,8 +98,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Cancel">
@ -94,8 +112,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Close">
@ -106,8 +126,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Yes">
@ -118,8 +140,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="No">
@ -130,8 +154,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Apply">
@ -142,8 +168,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Help">
@ -154,8 +182,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Convenience response type to be used in the constructors of the <see cref="T:Gtk.Dialog" /> class.
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="value__">