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

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

Browse source 
* en/Gtk/FileSystem.xml: Wording tweak.
	* en/Gtk/ActionGroup.xml
	* en/Gtk/Action.xml
	* en/Gtk/ActionEntry.xml
	* en/Gtk/AccelGroup.xml
	* en/Gtk/AccelMap.xml: Added docs.

svn path=/trunk/gtk-sharp/; revision=38218
This commit is contained in:
Shane Landrum 2004-12-31 19:36:13 +00:00
parent 1108edce1f
commit 382369538c
7 changed files with 168 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/ChangeLog
View file

@ -1,3 +1,12 @@
2004-12-31 Shane Landrum <epicene@pobox.com>
* en/Gtk/FileSystem.xml: Wording tweak.
* en/Gtk/ActionGroup.xml
* en/Gtk/Action.xml
* en/Gtk/ActionEntry.xml
* en/Gtk/AccelGroup.xml
* en/Gtk/AccelMap.xml: Added docs.
2004-12-31 Shane Landrum <epicene@pobox.com> 2004-12-31 Shane Landrum <epicene@pobox.com>
* en/Gtk/FileSystem.xml * en/Gtk/FileSystem.xml

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

@ -321,13 +321,13 @@
<Parameter Name="accel_mods" Type="Gdk.ModifierType" /> <Parameter Name="accel_mods" Type="Gdk.ModifierType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Activates the accelerator.</summary>
<param name="accel_quark">a <see cref="T:System.Int32" /></param> <param name="accel_quark">a <see cref="T:System.Int32" /></param>
<param name="acceleratable">a <see cref="T:GLib.Object" /></param> <param name="acceleratable">a <see cref="T:GLib.Object" /></param>
<param name="accel_key">a <see cref="T:System.UInt32" /></param> <param name="accel_key">a <see cref="T:System.UInt32" /></param>
<param name="accel_mods">a <see cref="T:System.Int32" /></param> <param name="accel_mods">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

170
doc/en/Gtk/AccelMap.xml
View file

@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Global accelerator map for an entire application.</summary>
<remarks>To be added</remarks> <remarks>This class is a singleton; only one can exist at a time.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Object</BaseTypeName> <BaseTypeName>GLib.Object</BaseTypeName>
@ -36,11 +36,11 @@
<Parameter Name="key" Type="Gtk.AccelKey" /> <Parameter Name="key" Type="Gtk.AccelKey" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Looks up the accelerator entry for <paramref name="accel_path"/> and fills in <paramref name="key"/>.</summary>
<param name="accel_path">a <see cref="T:System.String" /></param> <param name="accel_path">a <see cref="T:System.String" />, a valid accelerator path</param>
<param name="key">a <see cref="T:Gtk.AccelKey" /></param> <param name="key">a <see cref="T:Gtk.AccelKey" />, the accelerator key to be filled in (optional)</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, <see langword="true"/> if <paramref name="accel_path"/> is known, <see langword="false"/> otherwise.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LockPath"> <Member MemberName="LockPath">
@ -53,9 +53,32 @@
<Parameter Name="accel_path" Type="System.String" /> <Parameter Name="accel_path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Locks the given accelerator path. If the accelerator map doesn't yet contain
an entry for <paramref name="accel_path"/>, a new one is created.
</summary>
<param name="accel_path">a <see cref="T:System.String" /></param> <param name="accel_path">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks> <remarks>
<para>
Locking an accelerator path prevents its accelerator from being changed
during runtime. A locked accelerator path can be unlocked by
<see cref="M:Gtk.AccelMap.UnlockPath"/>.
Refer to <see cref="M:Gtk.AccelMap.ChangeEntry"/>
for information about runtime accelerator changes.
</para>
<para>
If called more than once, <paramref name="accel_path"/> remains locked until
<see cref="M:Gtk.AccelMap.UnlockPath"/>
has been called an equivalent number of times.
</para>
<para>
Note that locking of individual accelerator paths is independent from
locking the <see cref="T:Gtk.AccelGroup"/> containing them. For runtime accelerator
changes to be possible both the accelerator path and its
<see cref="T:Gtk.AccelGroup"/> have to be unlocked.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UnlockPath"> <Member MemberName="UnlockPath">
@ -68,9 +91,14 @@
<Parameter Name="accel_path" Type="System.String" /> <Parameter Name="accel_path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="accel_path">a <see cref="T:System.String" /></param> Undoes the last call to <see cref="M:Gtk.AccelMap.LockPath"/>
<remarks>To be added</remarks> on this <paramref name="accel_path"/>.
</summary>
<param name="accel_path">a <see cref="T:System.String" />, a valid accelerator path</param>
<remarks>
Refer to <see cref="M:Gtk.AccelMap.LockPath"/> for information
about accelerator path locking.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ChangeEntry"> <Member MemberName="ChangeEntry">
@ -86,13 +114,21 @@
<Parameter Name="replace" Type="System.Boolean" /> <Parameter Name="replace" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Changes the <paramref name="accel_key"/> and <paramref name="accel_mods"/> currently associated with
<paramref name="accel_path"/>.
</summary>
<param name="accel_path">a <see cref="T:System.String" /></param> <param name="accel_path">a <see cref="T:System.String" /></param>
<param name="accel_key">a <see cref="T:System.UInt32" /></param> <param name="accel_key">a <see cref="T:System.UInt32" /></param>
<param name="accel_mods">a <see cref="T:System.Int32" /></param> <param name="accel_mods">a <see cref="T:System.Int32" /></param>
<param name="replace">a <see cref="T:System.Boolean" /></param> <param name="replace">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>
Due to conflicts with other accelerators, a change may not always be possible. The
<paramref name="replace"/> parameter indicates whether other accelerators may be deleted to resolve such
conflicts. A change will only occur if all conflicts could be resolved (which might not be the case if conflicting accelerators are locked). Successful
changes are indicated by a <see langword="true"/> return value.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Load"> <Member MemberName="Load">
@ -105,9 +141,12 @@
<Parameter Name="file_name" Type="System.String" /> <Parameter Name="file_name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Parses a file previously saved with <see cref="M:Gtk.AccelMap.Save"/>
for accelerator specifications, and propagates them accordingly.
</summary>
<param name="file_name">a <see cref="T:System.String" /></param> <param name="file_name">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SaveFd"> <Member MemberName="SaveFd">
@ -120,9 +159,11 @@
<Parameter Name="fd" Type="System.Int32" /> <Parameter Name="fd" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="fd">a <see cref="T:System.Int32" /></param> File descriptor variant of <see cref="M:Gtk.AccelMap.Save"/>.
<remarks>To be added</remarks> </summary>
<param name="fd">a <see cref="T:System.Int32" />, a valid writeable file descriptor</param>
<remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Save"> <Member MemberName="Save">
@ -135,9 +176,14 @@
<Parameter Name="file_name" Type="System.String" /> <Parameter Name="file_name" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="file_name">a <see cref="T:System.String" /></param> Saves current accelerator specifications (accelerator path, key
<remarks>To be added</remarks> and modifiers) to <paramref name="file_name"/>.
The file is written in a format suitable to be read back in by
<see cref="M:Gtk.AccelMap.Load"/>.
</summary>
<param name="file_name">a <see cref="T:System.String" />, a file to contain accelerator specifications</param>
<remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LoadFd"> <Member MemberName="LoadFd">
@ -150,9 +196,11 @@
<Parameter Name="fd" Type="System.Int32" /> <Parameter Name="fd" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="fd">a <see cref="T:System.Int32" /></param> File descriptor variant of <see cref="M:Gtk.AccelMap.Load"/>.
<remarks>To be added</remarks> </summary>
<param name="fd">a <see cref="T:System.Int32" />, a valid readable file descriptor.</param>
<remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddEntry"> <Member MemberName="AddEntry">
@ -167,11 +215,27 @@
<Parameter Name="accel_mods" Type="Gdk.ModifierType" /> <Parameter Name="accel_mods" Type="Gdk.ModifierType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Registers a new accelerator with the global accelerator map.
</summary>
<param name="accel_path">a <see cref="T:System.String" /></param> <param name="accel_path">a <see cref="T:System.String" /></param>
<param name="accel_key">a <see cref="T:System.UInt32" /></param> <param name="accel_key">a <see cref="T:System.UInt32" /></param>
<param name="accel_mods">a <see cref="T:System.Int32" /></param> <param name="accel_mods">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks>
This function should only be called once per <paramref name="accel_path"/>
with the canonical <paramref name="accel_key"/> and <paramref name="accel_mods"/> for this path.
To change the accelerator during runtime programatically, use
<see cref="M:Gtk.AccelMap.ChangeEntry"/>.
The accelerator path must consist of "&lt;WINDOWTYPE&gt;/Category1/Category2/.../Action",
where &lt;WINDOWTYPE&gt; should be a unique application-specific identifier, that
corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image",
"Abiword-Document" or "Gnumeric-Settings".
The Category1/.../Action portion is most appropriately chosen by the action the
accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path,
e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All".
So a full valid accelerator path may look like:
"&lt;Gimp-Toolbox&gt;/File/Dialogs/Tool Options...".
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddFilter"> <Member MemberName="AddFilter">
@ -184,9 +248,21 @@
<Parameter Name="filter_pattern" Type="System.String" /> <Parameter Name="filter_pattern" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Adds a filter to the global list of accel path filters.
</summary>
<param name="filter_pattern">a <see cref="T:System.String" /></param> <param name="filter_pattern">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks> <remarks>
<para>
Accel map entries whose accel path matches one of the filters
are skipped by <see cref="M:Gtk.AccelMap.Foreach"/>.
</para>
<para>
This function is intended for Gtk# modules that create their own
menus but don't want them to be saved into the applications
accelerator map dump.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Get"> <Member MemberName="Get">
@ -197,9 +273,14 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
Gets the singleton global<see cref="T:Gtk.AccelMap"/>. object. This object
is useful only for notification of changes to the accelerator
map via the internal "changed" signal; it isn't a parameter to the
other accelerator map functions.
</summary>
<returns>a <see cref="T:Gtk.AccelMap" /></returns> <returns>a <see cref="T:Gtk.AccelMap" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Foreach"> <Member MemberName="Foreach">
@ -213,10 +294,18 @@
<Parameter Name="foreach_func" Type="Gtk.AccelMapForeach" /> <Parameter Name="foreach_func" Type="Gtk.AccelMapForeach" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="data">a <see cref="T:System.IntPtr" /></param> Loops over the entries in the accelerator map whose accel path
<param name="foreach_func">a <see cref="T:Gtk.AccelMapForeach" /></param> doesn't match any of the filters added with
<remarks>To be added</remarks> <see cref="M:Gtk.AccelMap.AddFilter"/>
and executes <paramref name="foreach_func"/> on each.
</summary>
<param name="data">a <see cref="T:System.IntPtr" />, data to pass to <paramref name="foreach_func"/></param>
<param name="foreach_func">a <see cref="T:Gtk.AccelMapForeach" />, function to execute on each accel map entrey</param>
<remarks>
See also <see cref="M:Gtk.AccelMap.ForeachUnfiltered"/>.
XXX: See http://bugzilla.ximian.com/show_bug.cgi?id=70912.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ForeachUnfiltered"> <Member MemberName="ForeachUnfiltered">
@ -230,10 +319,13 @@
<Parameter Name="foreach_func" Type="Gtk.AccelMapForeach" /> <Parameter Name="foreach_func" Type="Gtk.AccelMapForeach" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Loops over all entries in the accelerator map and executes
* <paramref name="foreach_func"/> on each.</summary>
<param name="data">a <see cref="T:System.IntPtr" /></param> <param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="foreach_func">a <see cref="T:Gtk.AccelMapForeach" /></param> <param name="foreach_func">a <see cref="T:Gtk.AccelMapForeach" /></param>
<remarks>To be added</remarks> <remarks>
See also <see cref="M:Gtk.AccelMap.Foreach"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -283,9 +375,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.AccelMap" /></returns> <returns>a <see cref="T:Gtk.AccelMap" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">

6
doc/en/Gtk/Action.xml
View file

@ -411,9 +411,9 @@ Default value: <see langword="false" /></remarks>
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The GtkActionGroup this GtkAction is associated with.</summary>
<returns>a <see cref="T:Gtk.ActionGroup" /></returns> <returns>a <see cref="T:Gtk.ActionGroup" /></returns>
<remarks>To be added</remarks> <remarks>Can be set to <see langword="null"/> for internal use.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Label"> <Member MemberName="Label">
@ -541,7 +541,7 @@ This does not necessarily mean effective visibility. See <see cref="P:Gtk.Action
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Proxies"> <Member MemberName="Proxies">

34
doc/en/Gtk/ActionEntry.xml
View file

@ -108,11 +108,11 @@
<Parameter Name="stock_id" Type="System.String" /> <Parameter Name="stock_id" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, a stock icon</param>
<returns>a <see cref="T:Gtk.ActionEntry" /></returns> <returns>a <see cref="T:Gtk.ActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -125,12 +125,12 @@
<Parameter Name="activated" Type="System.EventHandler" /> <Parameter Name="activated" Type="System.EventHandler" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, a stock icon</param>
<param name="activated">a <see cref="T:System.EventHandler" /></param> <param name="activated">a <see cref="T:System.EventHandler" />, a handler to run when the action is activated</param>
<returns>a <see cref="T:Gtk.ActionEntry" /></returns> <returns>a <see cref="T:Gtk.ActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -146,15 +146,15 @@
<Parameter Name="activated" Type="System.EventHandler" /> <Parameter Name="activated" Type="System.EventHandler" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="name">a <see cref="T:System.String" /></param> <param name="name">a <see cref="T:System.String" />, a unique name</param>
<param name="stock_id">a <see cref="T:System.String" /></param> <param name="stock_id">a <see cref="T:System.String" />, a stock icon</param>
<param name="label">a <see cref="T:System.String" /></param> <param name="label">a <see cref="T:System.String" />, label text</param>
<param name="accelerator">a <see cref="T:System.String" /></param> <param name="accelerator">a <see cref="T:System.String" />, an accelerator sequence</param>
<param name="tooltip">a <see cref="T:System.String" /></param> <param name="tooltip">a <see cref="T:System.String" />, tooltip text</param>
<param name="activated">a <see cref="T:System.EventHandler" /></param> <param name="activated">a <see cref="T:System.EventHandler" />, a handler to run when the action is activated</param>
<returns>a <see cref="T:Gtk.ActionEntry" /></returns> <returns>a <see cref="T:Gtk.ActionEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

4
doc/en/Gtk/ActionGroup.xml
View file

@ -123,7 +123,7 @@ Accel paths are set to &lt;Actions&gt;/group-name/action-name.
<summary>Looks up an action in the action group by name.</summary> <summary>Looks up an action in the action group by name.</summary>
<param name="action_name">a <see cref="T:System.String" />, the name of the action</param> <param name="action_name">a <see cref="T:System.String" />, the name of the action</param>
<returns>a <see cref="T:Gtk.Action" />, or <see langword="null" /> if no action by that name exists</returns> <returns>a <see cref="T:Gtk.Action" />, or <see langword="null" /> if no action by that name exists</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Add"> <Member MemberName="Add">
@ -245,7 +245,7 @@ Therefore you must either set the accel path yourself with <see cref="P:Gtk.Acti
<Docs> <Docs>
<summary>Sets the translation domain and uses dgettext() for translating the label and tooltip of <see cref="T:Gtk.ActionEntry" />s added by <see cref="M:Gtk.ActionGroup.AddActions()" />.</summary> <summary>Sets the translation domain and uses dgettext() for translating the label and tooltip of <see cref="T:Gtk.ActionEntry" />s added by <see cref="M:Gtk.ActionGroup.AddActions()" />.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Add"> <Member MemberName="Add">

2
doc/en/Gtk/FileSystem.xml
View file

@ -10,7 +10,7 @@
<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> <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> <Docs>
<summary>Interface class for representing filesystems.</summary> <summary>Interface class for representing filesystems.</summary>
<remarks>For concrete implementations, see <remarks>For more concrete implementations, see
<see cref="T:Gtk.FileSystem.Win32"/> and <see cref="T:Gtk.FileSystem.Win32"/> and
<see cref="T:Gtk.FileSystem.Unix"/>.</remarks> <see cref="T:Gtk.FileSystem.Unix"/>.</remarks>
</Docs> </Docs>