diff --git a/doc/ChangeLog b/doc/ChangeLog index d59641585..8e60277d6 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,14 @@ +2005-01-04 Shane Landrum + + * en/Gtk/Image.xml + * en/Gtk/RetrieveSurroundingArgs.xml + * en/Gtk/IMMulticontext.xml + * en/Gtk/FileInfo.xml + * en/Gtk/FileInfoType.xml + * en/Gtk/IMStatusStyle.xml + * en/Gtk/RetrieveSurroundingHandler.xml + * en/Gtk/IMPreeditStyle.xml: Added docs. + 2005-01-03 Shane Landrum * en/Gtk/IMContextSimple.xml diff --git a/doc/en/Gtk/FileInfo.xml b/doc/en/Gtk/FileInfo.xml index c3e5e87fc..e35d75515 100644 --- a/doc/en/Gtk/FileInfo.xml +++ b/doc/en/Gtk/FileInfo.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - + + A class for handling information about files. + + + For use with classes. + GLib.Opaque @@ -30,8 +34,8 @@ - To be added - + Frees memory associated with this data structure. + Subject to change in the future. @@ -42,7 +46,7 @@ - To be added + Returns a new object that's a copy of this object. a @@ -55,8 +59,8 @@ - To be added - a + Public constructor for internal use only. + a , the underlying C object. a @@ -67,7 +71,7 @@ - To be added + Public constructor. a @@ -80,7 +84,8 @@ - To be added + When making a derived class, override this method to change + that class's . a @@ -93,7 +98,7 @@ - To be added + The file's name. a @@ -106,7 +111,7 @@ - To be added + The file's MIME type. a @@ -119,7 +124,7 @@ - To be added + The file's last-modified time. a @@ -132,7 +137,7 @@ - To be added + The file's size. a @@ -145,7 +150,7 @@ - To be added + Whether the file is hidden or not. a @@ -158,9 +163,16 @@ - To be added - a - + Generates a collation key on the display name for faster sorting. + a , + the collate key for the display name, or + if the display name hasn't been set. + + The collate key is a string that can be usefully compared with + others using the C method strcmp(). + This is useful when sorting a bunch of + objects since the collate key will be only computed once. + @@ -171,7 +183,7 @@ - To be added + Whether the file is actually a folder or not. a diff --git a/doc/en/Gtk/FileInfoType.xml b/doc/en/Gtk/FileInfoType.xml index 8244f8ec2..999e6aa70 100644 --- a/doc/en/Gtk/FileInfoType.xml +++ b/doc/en/Gtk/FileInfoType.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - Enumeration to represent information about a file. - + + Mask of information about a file for use with + . + + + System.Enum @@ -41,7 +45,7 @@ - To be added + A file's display name. @@ -54,7 +58,7 @@ - To be added + Whether a file is actually a folder. @@ -67,7 +71,7 @@ - To be added + Whether a file is hidden. @@ -80,7 +84,7 @@ - To be added + A file's MIME type. @@ -93,7 +97,7 @@ - To be added + A file's modification time. @@ -106,7 +110,7 @@ - To be added + A file's size. @@ -119,7 +123,7 @@ - To be added + All the information about a file. diff --git a/doc/en/Gtk/IMContext.xml b/doc/en/Gtk/IMContext.xml index 201b88757..5da65a605 100644 --- a/doc/en/Gtk/IMContext.xml +++ b/doc/en/Gtk/IMContext.xml @@ -240,7 +240,7 @@ - To be added + Event fired when pre-editing is started. @@ -252,7 +252,7 @@ - To be added + Event fired when the input method needs to delete the context text. @@ -276,7 +276,9 @@ - To be added + + Event fired when the input method requires the context surrounding the cursor. + @@ -288,7 +290,7 @@ - To be added + Event fired when pre-editing is completed. @@ -303,10 +305,16 @@ - To be added + + Sets surrounding context around the insertion point and preedit string. + a a - + + This function is expected to be called in response to the + event, + and it will likely have no effect if called at other times. + @@ -324,7 +332,26 @@ a a a - + + + Input methods typically want context in order to constrain + input text based on existing text; this is important for + languages such as Thai where only some sequences of + characters are allowed. + + + This function is implemented by emitting the event on the + input method; in response to this signal, a widget should + provide as much context as is available, up to an entire + paragraph, by calling . Note that there + is no obligation for a widget to respond to the signal, so + input methods must be prepared to function without + context. + + @@ -448,11 +475,17 @@ - To be added - a - a - a - To be added + + Retrieve the current preedit string for the input context + and a list of attributes to apply to the string. + + a , a location to store , the retrieved string. + a , location to store the retrieved attribute list. + a , the position of the cursor (in bytes) within the preedit string. + + This string should be displayed inserted at the insertion + point. + diff --git a/doc/en/Gtk/IMMulticontext.xml b/doc/en/Gtk/IMMulticontext.xml index 9a94ad133..1477bafad 100644 --- a/doc/en/Gtk/IMMulticontext.xml +++ b/doc/en/Gtk/IMMulticontext.xml @@ -10,7 +10,9 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + + An input method context object that manages the use of multiple input method contexts for a widget + @@ -36,7 +38,7 @@ - Add menuitems for various available input methods to a menu; + Add menu items for various available input methods to a menu; the menuitems, when selected, will switch the input method for the context and the global default input method. a @@ -110,4 +112,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/IMPreeditStyle.xml b/doc/en/Gtk/IMPreeditStyle.xml index 9993e9464..088b7a903 100644 --- a/doc/en/Gtk/IMPreeditStyle.xml +++ b/doc/en/Gtk/IMPreeditStyle.xml @@ -80,7 +80,7 @@ To be added - To be added + diff --git a/doc/en/Gtk/IMStatusStyle.xml b/doc/en/Gtk/IMStatusStyle.xml index f51e8c59e..6138f9c5f 100644 --- a/doc/en/Gtk/IMStatusStyle.xml +++ b/doc/en/Gtk/IMStatusStyle.xml @@ -80,7 +80,7 @@ To be added - To be added + diff --git a/doc/en/Gtk/Image.xml b/doc/en/Gtk/Image.xml index cc94ebe4a..91064a1c1 100644 --- a/doc/en/Gtk/Image.xml +++ b/doc/en/Gtk/Image.xml @@ -173,8 +173,9 @@ This constructor is used to create an instance of containing the passed to it. - - to be displayed by the Image. + + to be displayed by the Image. + An instance of type . @@ -443,9 +444,11 @@ masked by the given . Gtk.ImageType - The type of representation being used by the #GtkImage + The type of representation being used by the + to store image data. If the Image has no image data, - the return value will be . + the return value will be . + an object of type @@ -577,10 +580,10 @@ masked by the given . - To be added + Same functionality as . a a - To be added + @@ -594,10 +597,18 @@ masked by the given . - To be added + + Gets the and mask being + displayed by the . + a a - To be added + + The storage type of the image must be + . + or . + (see ). + @@ -614,7 +625,9 @@ masked by the given . Get the stock item name and size, if this is a stock image the stock item name the stock item size, a - If the is displaying a stock image, this method can be used to retrieve the stock item name and the size. + + If the is displaying a stock image, this method can be used to retrieve the stock item name and the size. + @@ -671,4 +684,4 @@ masked by the given . - \ No newline at end of file + diff --git a/doc/en/Gtk/RetrieveSurroundingArgs.xml b/doc/en/Gtk/RetrieveSurroundingArgs.xml index d151ecfae..70aa10d40 100644 --- a/doc/en/Gtk/RetrieveSurroundingArgs.xml +++ b/doc/en/Gtk/RetrieveSurroundingArgs.xml @@ -33,4 +33,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/RetrieveSurroundingHandler.xml b/doc/en/Gtk/RetrieveSurroundingHandler.xml index cb4841671..0b293e063 100644 --- a/doc/en/Gtk/RetrieveSurroundingHandler.xml +++ b/doc/en/Gtk/RetrieveSurroundingHandler.xml @@ -12,6 +12,10 @@ The event utilizes this delegate: Event data is passed via the parameter. To attach a to an event, add the RetrieveSurroundingHandler instance to the event. The methods referenced by the RetrieveSurroundingHandler instance are invoked whenever the event is raised, until the RetrieveSurroundingHandler is removed from the event. + + Handlers of this class should set the input method surrounding context by calling . The method returns %TRUE if the signal was handled by the callback. + + @@ -34,4 +38,4 @@ System.Void - \ No newline at end of file +