diff --git a/doc/ChangeLog b/doc/ChangeLog index 542c33b1d..ec4a4aae4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,24 @@ +2004-12-02 Shane Landrum + + * 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 * en/Gtk/FileChooserAction.xml: diff --git a/doc/en/Gtk/CellLayout.xml b/doc/en/Gtk/CellLayout.xml index 2f3747b9a..b95f81d94 100644 --- a/doc/en/Gtk/CellLayout.xml +++ b/doc/en/Gtk/CellLayout.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Manages layout for table cells. + @@ -31,10 +31,13 @@ - To be added + Re-inserts at . a a - To be added + + Note that has already to be packed + into the cell layout for this to function properly. + @@ -48,10 +51,17 @@ - To be added + + Adds the to the end of the cell layout. + a - a - To be added + a , TRUE if is to be given extra space allocated to this cell layout. + + If is FALSE, then the + cell is allocated no more space than it needs. Any unused space is + divided evenly between cells for which is + TRUE. + @@ -65,10 +75,17 @@ - To be added + + Packs into the beginning of the cell layout. + a - a - To be added + a , TRUE if is to be given extra space allocated to this cell layout. + + If is FALSE, then the + cell is allocated no more space than it needs. Any unused space is + divided evenly between cells for which is + TRUE. + @@ -83,11 +100,19 @@ - To be added + + Adds an attribute mapping to the list for this cell layout. + a a a - To be added + + The is the + column of the model to get a value from, and the is the + parameter on 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 + get its values from column 2. + @@ -100,9 +125,10 @@ - To be added + Clears all existing attributes previously set with + . a - To be added + @@ -113,8 +139,8 @@ - To be added - To be added + Unsets all the mappings on all renderers for this cell layout. + @@ -130,13 +156,17 @@ - To be added + Sets up a data function for this layout. a a - a - a - To be added + a , the user data (FIXME: is this necessary in the Gtk# API?) + a , the destroy notification (FIXME: is this necessary in the Gtk# API?) + + 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. may be to remove an older one. + - \ No newline at end of file + diff --git a/doc/en/Gtk/CellLayoutDataFunc.xml b/doc/en/Gtk/CellLayoutDataFunc.xml index a1a6fe6de..8a5dd5fae 100644 --- a/doc/en/Gtk/CellLayoutDataFunc.xml +++ b/doc/en/Gtk/CellLayoutDataFunc.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + Delegate class used as an argument for ; see that method's documentation for usage details. + + System.Delegate @@ -34,4 +36,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Clipboard.xml b/doc/en/Gtk/Clipboard.xml index ce4febad9..dae7f5b33 100644 --- a/doc/en/Gtk/Clipboard.xml +++ b/doc/en/Gtk/Clipboard.xml @@ -320,11 +320,20 @@ - To be added + + Returns a list of targets that are present on the clipboard, or + if there aren't any targets available. + a a - a - To be added + a ,TRUE if any + targets are present on the clipboard, otherwise FALSE. + + + This function waits for the data to be received using the main + loop, so events, timeouts, etc, may be dispatched during the wait. + + @@ -337,10 +346,16 @@ - To be added + + Requests the contents of the clipboard as list of supported targets. + When the list is later received, will be called. + a - To be added + + The "targets" parameter to will contain the resulting targets if + the request succeeded, or if it failed. Added in GTK 2.4. + - \ No newline at end of file + diff --git a/doc/en/Gtk/ClipboardTargetsReceivedFunc.xml b/doc/en/Gtk/ClipboardTargetsReceivedFunc.xml index f332af1cd..48e3d1673 100644 --- a/doc/en/Gtk/ClipboardTargetsReceivedFunc.xml +++ b/doc/en/Gtk/ClipboardTargetsReceivedFunc.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate class for ; called with a list of possible targets for clipboard data. See that method's documentation for more details. + System.Delegate @@ -33,4 +33,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/EntryCompletion.xml b/doc/en/Gtk/EntryCompletion.xml index 95dd053b4..2a8104b4a 100644 --- a/doc/en/Gtk/EntryCompletion.xml +++ b/doc/en/Gtk/EntryCompletion.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + This object allows a widget to suggest possible completions of a string which has been partially entered. + + + The partially-entered string is also referred to as a "key". + GLib.Object @@ -36,8 +40,8 @@ - To be added - To be added + Override this method to run operations before object destruction. + @@ -50,9 +54,9 @@ - To be added + This method is called whenever an action is activated. a - To be added + @@ -66,11 +70,11 @@ - To be added - a - a + This method is called whenever the user selects one of the suggested matches. + a , the model the match was selected from + a , the row the user picked a - To be added + @@ -84,10 +88,14 @@ - To be added + + Inserts an action in the completion's action item list at + position with markup + . + a a - To be added + @@ -101,10 +109,16 @@ - To be added + + Inserts an action in the completion's action item list at + position with text + . + a a - To be added + + If you want the item to have markup, use . + @@ -115,8 +129,12 @@ - To be added - To be added + + 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. + + @@ -129,9 +147,12 @@ - To be added + + Deletes the action at + from the action list for this completion. + a - To be added + @@ -145,10 +166,13 @@ - To be added + + Reinserts into the completion list + at . + a a - To be added + @@ -165,7 +189,7 @@ To be added a a - To be added + @@ -182,7 +206,7 @@ To be added a a - To be added + @@ -201,7 +225,7 @@ a a a - To be added + @@ -216,7 +240,7 @@ To be added a - To be added + @@ -228,7 +252,7 @@ To be added - To be added + @@ -239,10 +263,10 @@ - To be added + Protected constructor. a a - To be added + @@ -253,10 +277,10 @@ - To be added + Constructor for internal use only. a a - To be added + @@ -265,9 +289,9 @@ - To be added + Constructor for general use. a - To be added + @@ -280,7 +304,7 @@ To be added a - To be added + @@ -291,9 +315,14 @@ - To be added + Minimum string length for enabling completion. a - To be added + + 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). + @@ -303,9 +332,14 @@ System.Int32 - To be added + Setting this property generates acompletion list with just strings. + a - To be added + + 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. + @@ -316,9 +350,11 @@ - To be added + + Returns the entry widget this completion object has been attached to. + a - To be added + @@ -329,8 +365,10 @@ - To be added - To be added + + Event triggered when a particular action is activated. + + @@ -341,8 +379,8 @@ - To be added - To be added + Event triggered when the user selects a match. + @@ -357,11 +395,16 @@ - To be added + + Sets the match function for this entry completion to be . + a a a - To be added + + The match function is used to determine if a row should or + should not be in the completion list. + @@ -377,13 +420,17 @@ - To be added + Sets up a data function for this layout. a a - a - a - To be added + a , the user data (FIXME: is this necessary in the Gtk# API?) + a , the destroy notification (FIXME: is this necessary in the Gtk# API?) + + 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. may be to remove an older one. + - \ No newline at end of file + diff --git a/doc/en/Gtk/EntryCompletionMatchFunc.xml b/doc/en/Gtk/EntryCompletionMatchFunc.xml index c83275330..18e01602c 100644 --- a/doc/en/Gtk/EntryCompletionMatchFunc.xml +++ b/doc/en/Gtk/EntryCompletionMatchFunc.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate class for callback methods; used by . See that method's documentation for details. + System.Delegate @@ -33,4 +33,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileFilter.xml b/doc/en/Gtk/FileFilter.xml index d04947fa5..76a0d9093 100644 --- a/doc/en/Gtk/FileFilter.xml +++ b/doc/en/Gtk/FileFilter.xml @@ -9,8 +9,9 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + This class sets up a filter to include or exclude particular + kinds of files; useful in file selection dialogs. + Gtk.Object @@ -33,8 +34,8 @@ - To be added - To be added + Override this method to accomplish certain tasks before object destruction. + @@ -47,9 +48,9 @@ - To be added + Adds a rule allowing a given MIME type to a filter. a - To be added + @@ -62,9 +63,9 @@ - To be added + Adds a rule allowing a shell style glob to a filter. a - To be added + @@ -77,10 +78,17 @@ - To be added + Tests whether a file should be displayed according to this filter. a - a - To be added + a , TRUE if the file should be displayed. + + The structure + should include + the fields returned from . + This function will not typically be used by applications; it + is intended principally for use in the implementation of + . + @@ -91,10 +99,10 @@ - To be added + Protected constructor. a a - To be added + @@ -105,10 +113,10 @@ - To be added + Constructor for internal use only. a a - To be added + @@ -117,9 +125,15 @@ - To be added + Creates a new file filter with no rules attached to it. a - To be added + + A newly-created filter doesn't accept any files, so is not + particularly useful until you add rules with + , + , or + . + @@ -132,7 +146,7 @@ To be added a - To be added + @@ -143,9 +157,12 @@ - To be added + The human-readable name of the filter. a - To be added + + This is the string that will be displayed in the file selector + user interface if there is a selectable list of filters. + @@ -156,9 +173,16 @@ - To be added - a - To be added + + Gets the fields that need to be filled in for the structure + passed to . + + a , flags that list the needed fields when calling . + + This function will not typically be used by applications; it + is intended principally for use in the implementation of + . + @@ -174,13 +198,20 @@ - To be added + + Adds a rule to a filter that allows files based on a custom callback function. + a a a a - To be added + + The bitfield 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. + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileFilterFlags.xml b/doc/en/Gtk/FileFilterFlags.xml index 73847bcbd..9e84c0e35 100644 --- a/doc/en/Gtk/FileFilterFlags.xml +++ b/doc/en/Gtk/FileFilterFlags.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + This object represents a bitfield of flags that list the needed fields when calling . + System.Enum @@ -42,7 +42,7 @@ To be added - To be added + @@ -55,7 +55,7 @@ To be added - To be added + @@ -68,7 +68,7 @@ To be added - To be added + @@ -81,7 +81,7 @@ To be added - To be added + @@ -98,4 +98,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileFilterFunc.xml b/doc/en/Gtk/FileFilterFunc.xml index acf207fee..b69bcbd6c 100644 --- a/doc/en/Gtk/FileFilterFunc.xml +++ b/doc/en/Gtk/FileFilterFunc.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate class for ; see that method's documentation for more details. + System.Delegate @@ -31,4 +31,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/IconThemeFileLineFunc.xml b/doc/en/Gtk/IconThemeFileLineFunc.xml index 561228ce7..384482843 100644 --- a/doc/en/Gtk/IconThemeFileLineFunc.xml +++ b/doc/en/Gtk/IconThemeFileLineFunc.xml @@ -34,4 +34,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/RBTreeTraverseFunc.xml b/doc/en/Gtk/RBTreeTraverseFunc.xml index 2a3659ea0..5309d14a4 100644 --- a/doc/en/Gtk/RBTreeTraverseFunc.xml +++ b/doc/en/Gtk/RBTreeTraverseFunc.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. A delegate class for traversing a red-black tree. - To be added + System.Delegate @@ -30,4 +30,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/TextSegCheckFunc.xml b/doc/en/Gtk/TextSegCheckFunc.xml index c9c98431c..8574829f1 100644 --- a/doc/en/Gtk/TextSegCheckFunc.xml +++ b/doc/en/Gtk/TextSegCheckFunc.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Do not use. - To be added + System.Delegate @@ -28,4 +28,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/TextSegCleanupFunc.xml b/doc/en/Gtk/TextSegCleanupFunc.xml index 89666fe18..53bf45204 100644 --- a/doc/en/Gtk/TextSegCleanupFunc.xml +++ b/doc/en/Gtk/TextSegCleanupFunc.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Do not use. - To be added + System.Delegate @@ -28,4 +28,4 @@ Gtk.TextLineSegment - \ No newline at end of file + diff --git a/doc/en/Gtk/TextSegDeleteFunc.xml b/doc/en/Gtk/TextSegDeleteFunc.xml index b42c48ede..459a8519c 100644 --- a/doc/en/Gtk/TextSegDeleteFunc.xml +++ b/doc/en/Gtk/TextSegDeleteFunc.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Do not use. - To be added + System.Delegate @@ -28,4 +28,4 @@ System.Boolean - \ No newline at end of file + diff --git a/doc/en/Gtk/TextSegLineChangeFunc.xml b/doc/en/Gtk/TextSegLineChangeFunc.xml index 455763a4a..dcb63e438 100644 --- a/doc/en/Gtk/TextSegLineChangeFunc.xml +++ b/doc/en/Gtk/TextSegLineChangeFunc.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Do not use. - To be added + System.Delegate @@ -28,4 +28,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/TextSegSplitFunc.xml b/doc/en/Gtk/TextSegSplitFunc.xml index 841dd9594..3413d5299 100644 --- a/doc/en/Gtk/TextSegSplitFunc.xml +++ b/doc/en/Gtk/TextSegSplitFunc.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Do not use. - To be added + System.Delegate @@ -30,4 +30,4 @@ Gtk.TextLineSegment - \ No newline at end of file + diff --git a/doc/en/Gtk/TextUtilCharChosenFunc.xml b/doc/en/Gtk/TextUtilCharChosenFunc.xml index 749cc9cb2..630977ef3 100644 --- a/doc/en/Gtk/TextUtilCharChosenFunc.xml +++ b/doc/en/Gtk/TextUtilCharChosenFunc.xml @@ -8,7 +8,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Do not use. - To be added + System.Delegate @@ -29,4 +29,4 @@ System.Void - \ No newline at end of file +