mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-08 07:53:17 +02:00
ActionGroup, UIManager, and UIManagerItemType docs
svn path=/trunk/gtk-sharp/; revision=35938
This commit is contained in:
parent
dce2f4f7b7
commit
acdaee5e08
@ -1,6 +1,9 @@
|
|||||||
2004-11-09 John Luke <john.luke@gmail.com>
|
2004-11-09 John Luke <john.luke@gmail.com>
|
||||||
|
|
||||||
* en/Gtk/Action.xml: doc
|
* en/Gtk/Action.xml:
|
||||||
|
* en/Gtk/ActionGroup.xml:
|
||||||
|
* en/Gtk/UIManagerItemType.xml:
|
||||||
|
* en/Gtk/UIManager.xml: doc
|
||||||
|
|
||||||
2004-11-09 Dan Winship <danw@novell.com>
|
2004-11-09 Dan Winship <danw@novell.com>
|
||||||
|
|
||||||
|
@ -9,8 +9,20 @@
|
|||||||
</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>A group of actions</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>
|
||||||
|
<para>
|
||||||
|
<para>
|
||||||
|
Actions are organised into groups. An action group is essentially a map from names to <see cref="T:Gtk.Action" /> objects.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
All actions that would make sense to use in a particular context should be in a single group. Multiple action groups may be used for a particular user interface. In fact, it is expected that most nontrivial applications will make use of multiple groups. For example, in an application that can edit multiple documents, one group holding global actions (e.g. quit, about, new), and one group per document holding actions that act on that document (eg. save, cut/copy/paste, etc). Each window's menus would be constructed from a combination of two action groups.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
Accelerators are handled by the Gtk accelerator map. All actions are assigned an accelerator path (which normally has the form <Actions>/group-name/action-name) and a shortcut is associated with this accelerator path. All menuitems and toolitems take on this accelerator path. The Gtk accelerator map code makes sure that the correct shortcut is displayed next to the menu item.
|
||||||
|
</para>
|
||||||
|
</para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
<Base>
|
<Base>
|
||||||
<BaseTypeName>GLib.Object</BaseTypeName>
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
||||||
@ -49,11 +61,11 @@
|
|||||||
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
|
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Sets a function to be used for translating the label and tooltip of GtkActionGroupEntrys added by <see cref="M:Gtk.ActionGroup.AddActions()" />.</summary>
|
||||||
<param name="func">a <see cref="T:Gtk.TranslateFunc" /></param>
|
<param name="func">a <see cref="T:Gtk.TranslateFunc" /></param>
|
||||||
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
||||||
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
|
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>If you are using gettext(), it is enough to set the translation domain with <see cref="P:Gtk.ActionGroup.TranslationDomain" />.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="Remove">
|
<Member MemberName="Remove">
|
||||||
@ -66,9 +78,9 @@
|
|||||||
<Parameter Name="action" Type="Gtk.Action" />
|
<Parameter Name="action" Type="Gtk.Action" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Removes an action object from the action group.</summary>
|
||||||
<param name="action">a <see cref="T:Gtk.Action" /></param>
|
<param name="action">a <see cref="T:Gtk.Action" /></param>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="Add">
|
<Member MemberName="Add">
|
||||||
@ -82,10 +94,19 @@
|
|||||||
<Parameter Name="accelerator" Type="System.String" />
|
<Parameter Name="accelerator" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Adds an action object to the action group and sets up the accelerator.</summary>
|
||||||
<param name="action">a <see cref="T:Gtk.Action" /></param>
|
<param name="action">a <see cref="T:Gtk.Action" /></param>
|
||||||
<param name="accelerator">a <see cref="T:System.String" /></param>
|
<param name="accelerator">a <see cref="T:System.String" />. The accelerator for the action, in the format understood by <see cref="M:Gtk.Accelerator.Parse()" />, or "" for no accelerator, or <see langword="null" /> to use the stock accelerator</param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>
|
||||||
|
<para>
|
||||||
|
<para>
|
||||||
|
If accelerator is <see langword="null" />, attempts to use the accelerator associated with the stock_id of the action.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
Accel paths are set to <Actions>/group-name/action-name.
|
||||||
|
</para>
|
||||||
|
</para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="GetAction">
|
<Member MemberName="GetAction">
|
||||||
@ -98,9 +119,9 @@
|
|||||||
<Parameter Name="action_name" Type="System.String" />
|
<Parameter Name="action_name" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Looks up an action in the action group by name.</summary>
|
||||||
<param name="action_name">a <see cref="T:System.String" /></param>
|
<param name="action_name">a <see cref="T:System.String" />, the name of the action</param>
|
||||||
<returns>a <see cref="T:Gtk.Action" /></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>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -114,9 +135,10 @@
|
|||||||
<Parameter Name="action" Type="Gtk.Action" />
|
<Parameter Name="action" Type="Gtk.Action" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Adds an action object to the action group.</summary>
|
||||||
<param name="action">a <see cref="T:Gtk.Action" /></param>
|
<param name="action">a <see cref="T:Gtk.Action" /></param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>Note that this function does not set up the accel path of the action, which can lead to problems if a user tries to modify the accelerator of a menuitem associated with the action.
|
||||||
|
Therefore you must either set the accel path yourself with <see cref="P:Gtk.Action.AccelPath" />, or use <see cref="M:Gtk.ActionGroup.Add(Gtk.Action,System.String)" />.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="ListActions">
|
<Member MemberName="ListActions">
|
||||||
@ -127,7 +149,7 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Lists the actions in the action group.</summary>
|
||||||
<returns>a <see cref="T:GLib.List" /></returns>
|
<returns>a <see cref="T:GLib.List" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
@ -140,10 +162,10 @@
|
|||||||
<Parameter Name="gtype" Type="GLib.GType" />
|
<Parameter Name="gtype" Type="GLib.GType" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Internal constructor</summary>
|
||||||
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
||||||
<returns>a <see cref="T:Gtk.ActionGroup" /></returns>
|
<returns>a <see cref="T:Gtk.ActionGroup" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName=".ctor">
|
<Member MemberName=".ctor">
|
||||||
@ -154,10 +176,10 @@
|
|||||||
<Parameter Name="raw" Type="System.IntPtr" />
|
<Parameter Name="raw" Type="System.IntPtr" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Internal constructor</summary>
|
||||||
<param name="raw">a <see cref="T:System.IntPtr" /></param>
|
<param name="raw">a <see cref="T:System.IntPtr" /></param>
|
||||||
<returns>a <see cref="T:Gtk.ActionGroup" /></returns>
|
<returns>a <see cref="T:Gtk.ActionGroup" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName=".ctor">
|
<Member MemberName=".ctor">
|
||||||
@ -168,10 +190,10 @@
|
|||||||
<Parameter Name="name" Type="System.String" />
|
<Parameter Name="name" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Creates a new <see cref="T:Gtk.ActionGroup" /> object.</summary>
|
||||||
<param name="name">a <see cref="T:System.String" /></param>
|
<param name="name">a <see cref="T:System.String" />, the name of the action group.</param>
|
||||||
<returns>a <see cref="T:Gtk.ActionGroup" /></returns>
|
<returns>a <see cref="T:Gtk.ActionGroup" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>The name of the action group is used when associating keybindings with the actions.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="GType">
|
<Member MemberName="GType">
|
||||||
@ -195,9 +217,9 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The visibility of the ActionGroup</summary>
|
||||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>The constituent actions can only be logically visible (see <see cref="P:Gtk.Action.IsVisible" />) if they are visible (see <see cref="P:Gtk.Action.Visible" />) and their group is visible.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="Sensitive">
|
<Member MemberName="Sensitive">
|
||||||
@ -208,9 +230,9 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The sensitivity of the ActionGroup</summary>
|
||||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>The constituent actions can only be logically sensitive (see <see cref="P:Gtk.Action.IsSensitive" />) if they are sensitive (see <see cref="P:Gtk.Action.Sensitive" />) and their group is sensitive.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="Name">
|
<Member MemberName="Name">
|
||||||
@ -221,9 +243,9 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Gets the name of the action group.</summary>
|
||||||
<returns>a <see cref="T:System.String" /></returns>
|
<returns>a <see cref="T:System.String" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="TranslationDomain">
|
<Member MemberName="TranslationDomain">
|
||||||
@ -233,7 +255,7 @@
|
|||||||
<ReturnType>System.String</ReturnType>
|
<ReturnType>System.String</ReturnType>
|
||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</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>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
|
@ -9,8 +9,42 @@
|
|||||||
</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>Constructs menus and toolbars from an XML description</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>
|
||||||
|
<para>
|
||||||
|
A <see cref="T:Gtk.UIManager" /> constructs a user interface (menus and toolbars) from one or more UI definitions, which reference actions from one or more action groups.
|
||||||
|
<para>
|
||||||
|
TODO: all the xml stuff
|
||||||
|
</para><para>
|
||||||
|
UI Merging</para><para>
|
||||||
|
The most remarkable feature of GtkUIManager is that it can overlay a set of menuitems and toolitems over another one, and demerge them later.
|
||||||
|
</para><para>
|
||||||
|
Merging is done based on the names of the XML elements. Each element is identified by a path which consists of the names of its anchestors, separated by slashes. For example, the menuitem named "Left" in the example above has the path /ui/menubar/JustifyMenu/Left and the toolitem with the same name has path /ui/toolbar1/JustifyToolItems/Left.
|
||||||
|
</para><para>
|
||||||
|
Accelerators
|
||||||
|
</para><para>
|
||||||
|
Every action has an accelerator path. Accelerators are installed together with menuitem proxies, but they can also be explicitly added with <accelerator> elements in the UI definition. This makes it possible to have accelerators for actions even if they have no visible proxies.
|
||||||
|
<para>
|
||||||
|
Smart Separators
|
||||||
|
</para></para><para>
|
||||||
|
The separators created by GtkUIManager are "smart", i.e. they do not show up in the UI unless they end up between two visible menu or tool items. Separators which are located at the very beginning or end of the menu or toolbar containing them, or multiple separators next to each other, are hidden. This is a useful feature, since the merging of UI elements from multiple sources can make it hard or impossible to determine in advance whether a separator will end up in such an unfortunate position.
|
||||||
|
</para><para>
|
||||||
|
Empty Menus
|
||||||
|
</para><para>
|
||||||
|
Submenus pose similar problems to separators inconnection with merging. It is impossible to know in advance whether they will end up empty after merging. GtkUIManager offers two ways to treat empty submenus:
|
||||||
|
|
||||||
|
<list type="bullet">
|
||||||
|
<item>
|
||||||
|
<term>make them disappear by hiding the menu item they're attached to</term>
|
||||||
|
</item>
|
||||||
|
<item>
|
||||||
|
<term>add an insensitive "Empty" item</term>
|
||||||
|
</item>
|
||||||
|
</list>
|
||||||
|
|
||||||
|
The behaviour is chosen based on the "is_important" property of the action to which the submenu is associated.
|
||||||
|
</para></para>
|
||||||
|
</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
<Base>
|
<Base>
|
||||||
<BaseTypeName>GLib.Object</BaseTypeName>
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
||||||
@ -138,7 +172,7 @@
|
|||||||
<Parameter Name="action_group" Type="Gtk.ActionGroup" />
|
<Parameter Name="action_group" Type="Gtk.ActionGroup" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>emoves an action group from the list of action groups</summary>
|
||||||
<param name="action_group">a <see cref="T:Gtk.ActionGroup" /></param>
|
<param name="action_group">a <see cref="T:Gtk.ActionGroup" /></param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
@ -153,10 +187,16 @@
|
|||||||
<Parameter Name="path" Type="System.String" />
|
<Parameter Name="path" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Looks up a widget by following a path.</summary>
|
||||||
<param name="path">a <see cref="T:System.String" /></param>
|
<param name="path">a <see cref="T:System.String" /></param>
|
||||||
<returns>a <see cref="T:Gtk.Widget" /></returns>
|
<returns>a <see cref="T:Gtk.Widget" /> found by following the path, or <see langword="null" /> if no widget was found.</returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>The path consists of the names specified in the XML description of the UI. separated by '/'. Elements which do not have a name or action attribute in the XML (e.g. <popup>) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path.
|
||||||
|
|
||||||
|
<block subset="none" type="note">
|
||||||
|
<para>
|
||||||
|
The widget found by following a path that ends in a <menu> element is the menuitem to which the menu is attached, not the menu itself.
|
||||||
|
</para>
|
||||||
|
</block></remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AddUiFromString">
|
<Member MemberName="AddUiFromString">
|
||||||
@ -169,10 +209,10 @@
|
|||||||
<Parameter Name="buffer" Type="System.String" />
|
<Parameter Name="buffer" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Parses a string containing a UI definition and merges it with the current contents.</summary>
|
||||||
<param name="buffer">a <see cref="T:System.String" /></param>
|
<param name="buffer">a <see cref="T:System.String" /> to parse</param>
|
||||||
<returns>a <see cref="T:System.UInt32" /></returns>
|
<returns>a <see cref="T:System.UInt32" />. The merge id for the merged UI. The merge id can be used to unmerge the UI with <see cref="M:Gtk.UIManager.RemoveUi()" />. If an error occurred, the return value is 0.</returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>An enclosing <ui> element is added if it is missing.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="GetToplevels">
|
<Member MemberName="GetToplevels">
|
||||||
@ -185,10 +225,10 @@
|
|||||||
<Parameter Name="types" Type="Gtk.UIManagerItemType" />
|
<Parameter Name="types" Type="Gtk.UIManagerItemType" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Obtains a list of all toplevel widgets of the requested types.</summary>
|
||||||
<param name="types">a <see cref="T:System.Int32" /></param>
|
<param name="types">a <see cref="T:System.Int32" /></param>
|
||||||
<returns>a <see cref="T:GLib.SList" /></returns>
|
<returns>a <see cref="T:GLib.SList" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>Allowed types are GTK_UI_MANAGER_MENUBAR, GTK_UI_MANAGER_TOOLBAR and GTK_UI_MANAGER_POPUP.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="EnsureUpdate">
|
<Member MemberName="EnsureUpdate">
|
||||||
@ -199,8 +239,8 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Makes sure that all pending updates to the UI have been completed.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>This may occasionally be necessary, since <see cref="T:Gtk.UIManager" /> updates the UI in an idle function.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AddUi">
|
<Member MemberName="AddUi">
|
||||||
@ -218,14 +258,14 @@
|
|||||||
<Parameter Name="top" Type="System.Boolean" />
|
<Parameter Name="top" Type="System.Boolean" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Adds a UI element to the current contents.</summary>
|
||||||
<param name="merge_id">a <see cref="T:System.UInt32" /></param>
|
<param name="merge_id">a <see cref="T:System.UInt32" />, the merge id for the merged UI</param>
|
||||||
<param name="path">a <see cref="T:System.String" /></param>
|
<param name="path">a <see cref="T:System.String" /></param>
|
||||||
<param name="name">a <see cref="T:System.String" /></param>
|
<param name="name">a <see cref="T:System.String" />, the name for the added UI element</param>
|
||||||
<param name="action">a <see cref="T:System.String" /></param>
|
<param name="action">a <see cref="T:System.String" />, the name of the action to be proxied, or <see langword="null" /> to add a separator</param>
|
||||||
<param name="type">a <see cref="T:System.Int32" /></param>
|
<param name="type">a <see cref="T:System.Int32" />. the type of UI element to add.</param>
|
||||||
<param name="top">a <see cref="T:System.Boolean" /></param>
|
<param name="top">a <see cref="T:System.Boolean" />. If <see langword="true" />, the UI element is added before its siblings, otherwise it is added after its siblings.</param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>If type is <see cref="F:Gtk.UIManager.Auto" />, Gtk inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by path. Otherwise type must indicate an element that can be inserted at the place determined by path.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="RemoveUi">
|
<Member MemberName="RemoveUi">
|
||||||
@ -238,9 +278,9 @@
|
|||||||
<Parameter Name="merge_id" Type="System.UInt32" />
|
<Parameter Name="merge_id" Type="System.UInt32" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Unmerges the content identified by <paramref name="merge_id" />.</summary>
|
||||||
<param name="merge_id">a <see cref="T:System.UInt32" /></param>
|
<param name="merge_id">a <see cref="T:System.UInt32" /> from when the ui was added.</param>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="InsertActionGroup">
|
<Member MemberName="InsertActionGroup">
|
||||||
@ -254,10 +294,10 @@
|
|||||||
<Parameter Name="pos" Type="System.Int32" />
|
<Parameter Name="pos" Type="System.Int32" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Inserts an action group into the list of action groups associated with this UIManager</summary>
|
||||||
<param name="action_group">a <see cref="T:Gtk.ActionGroup" /></param>
|
<param name="action_group">a <see cref="T:Gtk.ActionGroup" /> to be inserted</param>
|
||||||
<param name="pos">a <see cref="T:System.Int32" /></param>
|
<param name="pos">a <see cref="T:System.Int32" />, the position at which the group will be inserted.</param>
|
||||||
<remarks>To be added</remarks>
|
<remarks>Actions in earlier groups hide actions with the same name in later groups.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AddUiFromFile">
|
<Member MemberName="AddUiFromFile">
|
||||||
@ -270,9 +310,9 @@
|
|||||||
<Parameter Name="filename" Type="System.String" />
|
<Parameter Name="filename" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Parses a file containing a UI definition and merges it with the current contents.</summary>
|
||||||
<param name="filename">a <see cref="T:System.String" /></param>
|
<param name="filename">a <see cref="T:System.String" />, the name of the file to parse</param>
|
||||||
<returns>a <see cref="T:System.UInt32" /></returns>
|
<returns>a <see cref="T:System.UInt32" />. The merge id for the merged UI. The merge id can be used to unmerge the UI with <see cref="M:Gtk.UIManager.RemoveUi()" />. If an error occurred, the return value is 0.</returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -286,10 +326,10 @@
|
|||||||
<Parameter Name="path" Type="System.String" />
|
<Parameter Name="path" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Looks up an action by following a path.</summary>
|
||||||
<param name="path">a <see cref="T:System.String" /></param>
|
<param name="path">a <see cref="T:System.String" /></param>
|
||||||
<returns>a <see cref="T:Gtk.Action" /></returns>
|
<returns>a <see cref="T:Gtk.Action" /> whose proxy widget is found by following the path, or <see langword="null" /> if no widget was found.</returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>See <see cref="M:Gtk.UIManager.GetWidget()" /> for more information about paths.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AddUiFromResource">
|
<Member MemberName="AddUiFromResource">
|
||||||
@ -302,7 +342,7 @@
|
|||||||
<Parameter Name="resource" Type="System.String" />
|
<Parameter Name="resource" Type="System.String" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Adds a UI element to the current contents from an embedded resource.</summary>
|
||||||
<param name="resource">a <see cref="T:System.String" /></param>
|
<param name="resource">a <see cref="T:System.String" /></param>
|
||||||
<returns>a <see cref="T:System.UInt32" /></returns>
|
<returns>a <see cref="T:System.UInt32" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
@ -316,10 +356,10 @@
|
|||||||
<Parameter Name="gtype" Type="GLib.GType" />
|
<Parameter Name="gtype" Type="GLib.GType" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Internal constructor</summary>
|
||||||
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
||||||
<returns>a <see cref="T:Gtk.UIManager" /></returns>
|
<returns>a <see cref="T:Gtk.UIManager" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName=".ctor">
|
<Member MemberName=".ctor">
|
||||||
@ -330,10 +370,10 @@
|
|||||||
<Parameter Name="raw" Type="System.IntPtr" />
|
<Parameter Name="raw" Type="System.IntPtr" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Internal constructor</summary>
|
||||||
<param name="raw">a <see cref="T:System.IntPtr" /></param>
|
<param name="raw">a <see cref="T:System.IntPtr" /></param>
|
||||||
<returns>a <see cref="T:Gtk.UIManager" /></returns>
|
<returns>a <see cref="T:Gtk.UIManager" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName=".ctor">
|
<Member MemberName=".ctor">
|
||||||
@ -342,9 +382,9 @@
|
|||||||
<ReturnValue />
|
<ReturnValue />
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Default constructor</summary>
|
||||||
<returns>a <see cref="T:Gtk.UIManager" /></returns>
|
<returns>a <see cref="T:Gtk.UIManager" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName=".ctor">
|
<Member MemberName=".ctor">
|
||||||
@ -382,9 +422,9 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The UI represented in XML.</summary>
|
||||||
<returns>a <see cref="T:System.String" /></returns>
|
<returns>a <see cref="T:System.String" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AddTearoffs">
|
<Member MemberName="AddTearoffs">
|
||||||
@ -395,9 +435,9 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Sets the "add_tearoffs" property, which controls whether menus generated by this <see cref="T:Gtk.UIManager" /> will have tearoff menu items.</summary>
|
||||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
<returns>a <see cref="T:System.Boolean" />, whether tearoff menu items are added</returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>Note that this only affects regular menus. Generated popup menus never have tearoff menu items.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AccelGroup">
|
<Member MemberName="AccelGroup">
|
||||||
@ -408,9 +448,9 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The <see cref="T:Gtk.AccelGroup" /> associated with this UIManager</summary>
|
||||||
<returns>a <see cref="T:Gtk.AccelGroup" /></returns>
|
<returns>a <see cref="T:Gtk.AccelGroup" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="ActionGroups">
|
<Member MemberName="ActionGroups">
|
||||||
@ -421,9 +461,9 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The list of action groups associated with this UIManager.</summary>
|
||||||
<returns>a <see cref="T:GLib.List" /></returns>
|
<returns>a <see cref="T:GLib.List" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="ActionsChanged">
|
<Member MemberName="ActionsChanged">
|
||||||
@ -434,8 +474,8 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The "actions-changed" signal is emitted whenever the set of actions changes.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="PreActivate">
|
<Member MemberName="PreActivate">
|
||||||
@ -446,8 +486,8 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The PreActivate signal is emitted just before the action is activated.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>This is intended for applications to get notification just before any action is activated.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AddWidget">
|
<Member MemberName="AddWidget">
|
||||||
@ -458,8 +498,8 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The AddWidget signal is emitted for each generated menubar and toolbar.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>It is not emitted for generated popup menus, which can be obtained by <see cref="M:Gtk.UIManager.GetWidget()" />.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="ConnectProxy">
|
<Member MemberName="ConnectProxy">
|
||||||
@ -470,8 +510,8 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The ConnectProxy signal is emitted after connecting a proxy to an action in the group.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>This is intended for simple customizations for which a custom action class would be too clumsy, e.g. showing tooltips for menuitems in the statusbar.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="DisconnectProxy">
|
<Member MemberName="DisconnectProxy">
|
||||||
@ -482,8 +522,8 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The DisconnectProxy signal is emitted after disconnecting a proxy from an action in the group.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="PostActivate">
|
<Member MemberName="PostActivate">
|
||||||
@ -494,8 +534,8 @@
|
|||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>The PostActivate signal is emitted just after the action is activated.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>This is intended for applications to get notification just after any action is activated.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
</Members>
|
</Members>
|
||||||
|
@ -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>Used by <see cref="M:Gtk.UIManager.AddUI()" /> to determine what UI element to create.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks />
|
||||||
</Docs>
|
</Docs>
|
||||||
<Base>
|
<Base>
|
||||||
<BaseTypeName>System.Enum</BaseTypeName>
|
<BaseTypeName>System.Enum</BaseTypeName>
|
||||||
@ -41,7 +41,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Pick the type of the UI element according to context.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -54,7 +54,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Create a menubar.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -67,7 +67,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Create a menu.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -80,7 +80,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Create a toolbar.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -93,7 +93,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Insert a placeholder.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -106,7 +106,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Create a popup menu.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -119,7 +119,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Create a menuitem.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -132,7 +132,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Create a toolitem.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -145,7 +145,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Create a separator.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
@ -158,7 +158,7 @@
|
|||||||
<Parameters>
|
<Parameters>
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Install an accelerator.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks>To be added</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
|
Loading…
Reference in New Issue
Block a user