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

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

Browse source 
* en/Gtk/EntryCompletionMatchFunc.xml
	* en/Gtk/EntryCompletion.xml
	* en/Gtk/CellLayout.xml
	* en/Gtk/CellLayoutDataFunc.xml
	* en/Gtk/Clipboard.xml
	* en/Gtk/ClipboardTargetsReceivedFunc.xml
	* en/Gtk/FileFilter.xml
	* en/Gtk/FileFilterFlags.xml
	* en/Gtk/FileFilterFunc.xml: Doc some delegate classes and the
	methods that use them; mostly functionality new to 2.4.
	* en/Gtk/RBTreeTraverseFunc.xml
	* en/Gtk/TextSegLineChangeFunc.xml
	* en/Gtk/TextSegSplitFunc.xml
	* en/Gtk/TextSegCheckFunc.xml
	* en/Gtk/TextUtilCharChosenFunc.xml
	* en/Gtk/TextSegCleanupFunc.xml
	* en/Gtk/TextSegDeleteFunc.xml
	* en/Gtk/IconThemeFileLineFunc.xml: Removed extraneous TBAs.
	

svn path=/trunk/gtk-sharp/; revision=36921
This commit is contained in:
Shane Landrum 2004-12-02 06:33:01 +00:00
parent 6d9785c7f7
commit fe1260b924
18 changed files with 282 additions and 136 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/ChangeLog
View file

@ -1,3 +1,24 @@
2004-12-02 Shane Landrum <epicene@pobox.com>
* en/Gtk/EntryCompletionMatchFunc.xml
* en/Gtk/EntryCompletion.xml
* en/Gtk/CellLayout.xml
* en/Gtk/CellLayoutDataFunc.xml
* en/Gtk/Clipboard.xml
* en/Gtk/ClipboardTargetsReceivedFunc.xml
* en/Gtk/FileFilter.xml
* en/Gtk/FileFilterFlags.xml
* en/Gtk/FileFilterFunc.xml: Doc some delegate classes and the
methods that use them; mostly functionality new to 2.4.
* en/Gtk/RBTreeTraverseFunc.xml
* en/Gtk/TextSegLineChangeFunc.xml
* en/Gtk/TextSegSplitFunc.xml
* en/Gtk/TextSegCheckFunc.xml
* en/Gtk/TextUtilCharChosenFunc.xml
* en/Gtk/TextSegCleanupFunc.xml
* en/Gtk/TextSegDeleteFunc.xml
* en/Gtk/IconThemeFileLineFunc.xml: Removed extraneous TBAs.
2004-11-30 John Luke <john.luke@gmail.com>
* en/Gtk/FileChooserAction.xml:

72
doc/en/Gtk/CellLayout.xml
View file

@ -9,8 +9,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Manages layout for table cells.</summary>
<remarks/>
</Docs>
<Base />
<Interfaces>
@ -31,10 +31,13 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Re-inserts <paramref name="cell"/> at <paramref name="position"/>.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks>
Note that <paramref name="cell"/> has already to be packed
into the cell layout for this to function properly.
</remarks>
</Docs>
</Member>
<Member MemberName="PackEnd">
@ -48,10 +51,17 @@
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Adds the <paramref name="cell"/> to the end of the cell layout.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<param name="expand">a <see cref="T:System.Boolean" />, TRUE if <paramref name="cell"/> is to be given extra space allocated to this cell layout.</param>
<remarks>
If <paramref name="expand"/> is FALSE, then the
cell is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="expand"/> is
TRUE.
</remarks>
</Docs>
</Member>
<Member MemberName="PackStart">
@ -65,10 +75,17 @@
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Packs <paramref name="cell"/> into the beginning of the cell layout.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<param name="expand">a <see cref="T:System.Boolean" />, TRUE if <paramref name="cell"/> is to be given extra space allocated to this cell layout.</param>
<remarks>
If <paramref name="expand"/> is FALSE, then the
cell is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="expand"/> is
TRUE.
</remarks>
</Docs>
</Member>
<Member MemberName="AddAttribute">
@ -83,11 +100,19 @@
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Adds an attribute mapping to the list for this cell layout.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attribute">a <see cref="T:System.String" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks>
The <paramref name="column"/> is the
column of the model to get a value from, and the <paramref name="attribute"/> is the
parameter on <paramref name="cell"/> to be set from the value. So for example if column 2
of the model contains strings, you could have the "text" attribute of a
<see cref="T:Gtk.CellRendererText"/> get its values from column 2.
</remarks>
</Docs>
</Member>
<Member MemberName="ClearAttributes">
@ -100,9 +125,10 @@
<Parameter Name="cell" Type="Gtk.CellRenderer" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Clears all existing attributes previously set with
<see cref="M:Gtk.CellLayout.SetAttributes"/>.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Clear">
@ -113,8 +139,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Unsets all the mappings on all renderers for this cell layout.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="SetCellDataFunc">
@ -130,13 +156,17 @@
<Parameter Name="destroy" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets up a data function for this layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<param name="func_data">a <see cref="T:System.IntPtr" />, the user data (FIXME: is this necessary in the Gtk# API?)</param>
<param name="destroy">a <see cref="T:System.IntPtr" />, the destroy notification (FIXME: is this necessary in the Gtk# API?)</param>
<remarks>
The data function is used instead of the standard attributes mapping for setting the
column value, and should set the value of the layout's cell renderer(s)
as appropriate. <paramref name="func"/> may be <see langword="null"/> to remove an older one.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -9,8 +9,10 @@
</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>
Delegate class used as an argument for <see cref="M:Gtk.CellLayout.SetCellDataFunc"/>; see that method's documentation for usage details.
</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -34,4 +36,4 @@
<Parameter Name="tree_model" Type="Gtk.TreeModel" />
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
</Type>
</Type>

27
doc/en/Gtk/Clipboard.xml
View file

@ -320,11 +320,20 @@
<Parameter Name="n_targets" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Returns a list of targets that are present on the clipboard, or
<see langword="null"/> if there aren't any targets available.
</summary>
<param name="targets">a <see cref="T:Gdk.Atom" /></param>
<param name="n_targets">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />,TRUE if any
targets are present on the clipboard, otherwise FALSE.</returns>
<remarks>
<para>
This function waits for the data to be received using the main
loop, so events, timeouts, etc, may be dispatched during the wait.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="RequestTargets">
@ -337,10 +346,16 @@
<Parameter Name="cb" Type="Gtk.ClipboardTargetsReceivedFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Requests the contents of the clipboard as list of supported targets.
When the list is later received, <paramref name="cb"/> will be called.
</summary>
<param name="cb">a <see cref="T:Gtk.ClipboardTargetsReceivedFunc" /></param>
<remarks>To be added</remarks>
<remarks>
The "targets" parameter to <paramref name="cb"/> will contain the resulting targets if
the request succeeded, or <see langword="null"/> if it failed. Added in GTK 2.4.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -9,8 +9,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Delegate class for <see cref="M:Gtk.Clipboard.RequestTargets"/>; called with a list of possible targets for clipboard data. See that method's documentation for more details.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -33,4 +33,4 @@
<Parameter Name="atoms" Type="Gdk.Atom" />
<Parameter Name="n_atoms" Type="System.Int32" />
</Parameters>
</Type>
</Type>

145
doc/en/Gtk/EntryCompletion.xml
View file

@ -9,8 +9,12 @@
</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 object allows a widget to suggest possible completions of a string which has been partially entered.
</summary>
<remarks>
The partially-entered string is also referred to as a "key".
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -36,8 +40,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Override this method to run operations before object destruction.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="OnActionActivated">
@ -50,9 +54,9 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>This method is called whenever an action is activated.</summary>
<param name="index">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="OnMatchSelected">
@ -66,11 +70,11 @@
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="model">a <see cref="T:Gtk.TreeModel" /></param>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
<summary>This method is called whenever the user selects one of the suggested matches.</summary>
<param name="model">a <see cref="T:Gtk.TreeModel" />, the model the match was selected from</param>
<param name="iter">a <see cref="T:Gtk.TreeIter" />, the row the user picked</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="InsertActionMarkup">
@ -84,10 +88,14 @@
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Inserts an action in the completion's action item list at
position <paramref name="index_"/> with markup
<paramref name="markup"/>.
</summary>
<param name="index">a <see cref="T:System.Int32" /></param>
<param name="markup">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="InsertActionText">
@ -101,10 +109,16 @@
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Inserts an action in the completion's action item list at
position <paramref name="index_"/> with text
<paramref name="text"/>.
</summary>
<param name="index">a <see cref="T:System.Int32" /></param>
<param name="text">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks>
If you want the item to have markup, use <see cref="M:Gtk.EntryCompletion.InsertActionMarkup"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="Complete">
@ -115,8 +129,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Requests a completion operation, or in other words a refiltering
of the current list with completions, using the current key. The
completion list view will be updated accordingly.
</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="DeleteAction">
@ -129,9 +147,12 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Deletes the action at <paramref name="index_"/>
from the action list for this completion.
</summary>
<param name="index">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Reorder">
@ -145,10 +166,13 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Reinserts <paramref name="cell"/> into the completion list
at <paramref name="position"/>.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="PackEnd">
@ -165,7 +189,7 @@
<summary>To be added</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="PackStart">
@ -182,7 +206,7 @@
<summary>To be added</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="AddAttribute">
@ -201,7 +225,7 @@
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attribute">a <see cref="T:System.String" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="ClearAttributes">
@ -216,7 +240,7 @@
<Docs>
<summary>To be added</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Clear">
@ -228,7 +252,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -239,10 +263,10 @@
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.EntryCompletion" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -253,10 +277,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Constructor for internal use only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.EntryCompletion" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -265,9 +289,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Constructor for general use.</summary>
<returns>a <see cref="T:Gtk.EntryCompletion" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="GType">
@ -280,7 +304,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="MinimumKeyLength">
@ -291,9 +315,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Minimum string length for enabling completion.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>
Requires the length of the search key for this completion to be at least
a certain length. This is useful for long lists, where completing using a small
key takes a lot of time and will come up with meaningless results anyway
(ie, a too large dataset).
</remarks>
</Docs>
</Member>
<Member MemberName="TextColumn">
@ -303,9 +332,14 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Setting this property generates acompletion list with just strings.
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks>
Setting this convenience property will set up the completion
to have a list displaying all (and just) strings in the completion list,
and to get those strings from a particular column number in the model of the completion object.
</remarks>
</Docs>
</Member>
<Member MemberName="Entry">
@ -316,9 +350,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
Returns the entry widget this completion object has been attached to.
</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="ActionActivated">
@ -329,8 +365,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Event triggered when a particular action is activated.
</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="MatchSelected">
@ -341,8 +379,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Event triggered when the user selects a match.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="SetMatchFunc">
@ -357,11 +395,16 @@
<Parameter Name="func_notify" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Sets the match function for this entry completion to be <paramref name="func"/>.
</summary>
<param name="func">a <see cref="T:Gtk.EntryCompletionMatchFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param>
<param name="func_notify">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<remarks>
The match function is used to determine if a row should or
should not be in the completion list.
</remarks>
</Docs>
</Member>
<Member MemberName="SetCellDataFunc">
@ -377,13 +420,17 @@
<Parameter Name="destroy" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets up a data function for this layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<param name="func_data">a <see cref="T:System.IntPtr" />, the user data (FIXME: is this necessary in the Gtk# API?)</param>
<param name="destroy">a <see cref="T:System.IntPtr" />, the destroy notification (FIXME: is this necessary in the Gtk# API?)</param>
<remarks>
The data function is used instead of the standard attributes mapping for setting the
column value, and should set the value of the layout's cell renderer(s)
as appropriate. <paramref name="func"/> may be <see langword="null"/> to remove an older one.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -9,8 +9,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Delegate class for callback methods; used by <see cref="M:Gtk.EntryCompletion.SetMatchFunc"/>. See that method's documentation for details.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -33,4 +33,4 @@
<Parameter Name="key" Type="System.String" />
<Parameter Name="iter" Type="Gtk.TreeIter" />
</Parameters>
</Type>
</Type>

83
doc/en/Gtk/FileFilter.xml
View file

@ -9,8 +9,9 @@
</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 class sets up a filter to include or exclude particular
kinds of files; useful in file selection dialogs.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>Gtk.Object</BaseTypeName>
@ -33,8 +34,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Override this method to accomplish certain tasks before object destruction.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="AddMimeType">
@ -47,9 +48,9 @@
<Parameter Name="mime_type" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Adds a rule allowing a given MIME type to a filter.</summary>
<param name="mime_type">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="AddPattern">
@ -62,9 +63,9 @@
<Parameter Name="pattern" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Adds a rule allowing a shell style glob to a filter.</summary>
<param name="pattern">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Filter">
@ -77,10 +78,17 @@
<Parameter Name="filter_info" Type="Gtk.FileFilterInfo" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Tests whether a file should be displayed according to this filter.</summary>
<param name="filter_info">a <see cref="T:Gtk.FileFilterInfo" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, TRUE if the file should be displayed.</returns>
<remarks>
The <see cref="T:Gtk.FileFilterInfo" /> structure
<paramref name="filter_info"/> should include
the fields returned from <see cref="M:Gtk.FileFilter.GetNeeded"/>.
This function will not typically be used by applications; it
is intended principally for use in the implementation of
<see cref="T:Gtk.FileChooser"/>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -91,10 +99,10 @@
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.FileFilter" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -105,10 +113,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Constructor for internal use only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.FileFilter" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -117,9 +125,15 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Creates a new file filter with no rules attached to it.</summary>
<returns>a <see cref="T:Gtk.FileFilter" /></returns>
<remarks>To be added</remarks>
<remarks>
A newly-created filter doesn't accept any files, so is not
particularly useful until you add rules with
<see cref="M:Gtk.FileFilter.AddMimeType"/>,
<see cref="M:Gtk.FileFilter.AddPattern"/>, or
<see cref="M:Gtk.FileFilter.AddCustom"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -132,7 +146,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Name">
@ -143,9 +157,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The human-readable name of the filter.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks>
This is the string that will be displayed in the file selector
user interface if there is a selectable list of filters.
</remarks>
</Docs>
</Member>
<Member MemberName="Needed">
@ -156,9 +173,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.FileFilterFlags" /></returns>
<remarks>To be added</remarks>
<summary>
Gets the fields that need to be filled in for the structure
passed to <see cref="M:Gtk.FileFilter.Filter"/>.
</summary>
<returns>a <see cref="T:Gtk.FileFilterFlags" />, flags that list the needed fields when calling <see cref="M:Gtk.FileFilter.Filter"/>.</returns>
<remarks>
This function will not typically be used by applications; it
is intended principally for use in the implementation of
<see cref="T:Gtk.FileChooser"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="AddCustom">
@ -174,13 +198,20 @@
<Parameter Name="notify" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Adds a rule to a filter that allows files based on a custom callback function.
</summary>
<param name="needed">a <see cref="T:System.Int32" /></param>
<param name="func">a <see cref="T:Gtk.FileFilterFunc" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="notify">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<remarks>
The bitfield <paramref name="needed"/> which is passed in provides information
about what sorts of information that the filter function needs;
this allows GTK+ to avoid retrieving expensive information when
it isn't needed by the filter.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

14
doc/en/Gtk/FileFilterFlags.xml
View file

@ -9,8 +9,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>This object represents a bitfield of flags that list the needed fields when calling <see cref="M:Gtk.FileFilter.Filter"/>.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -42,7 +42,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Uri">
@ -55,7 +55,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="DisplayName">
@ -68,7 +68,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="MimeType">
@ -81,7 +81,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="value__">
@ -98,4 +98,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -9,8 +9,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Delegate class for <see cref="M:Gtk.FileFilter.SetCustom"/>; see that method's documentation for more details.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -31,4 +31,4 @@
<Parameters>
<Parameter Name="filter_info" Type="Gtk.FileFilterInfo" />
</Parameters>
</Type>
</Type>

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

@ -34,4 +34,4 @@
<Parameter Name="locale" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
</Type>
</Type>

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

@ -8,7 +8,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>
<Docs>
<summary>A delegate class for traversing a red-black tree.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -30,4 +30,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -8,7 +8,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>
<Docs>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +28,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -8,7 +8,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>
<Docs>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +28,4 @@
<ReturnValue>
<ReturnType>Gtk.TextLineSegment</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -8,7 +8,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>
<Docs>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +28,4 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -8,7 +8,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>
<Docs>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +28,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -8,7 +8,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>
<Docs>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -30,4 +30,4 @@
<ReturnValue>
<ReturnType>Gtk.TextLineSegment</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -8,7 +8,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>
<Docs>
<summary>Do not use.</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +29,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>