diff --git a/ChangeLog b/ChangeLog index bd638efca..5b3b75f4a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2003-07-29 Duncan Mak + + * sources/Gtk.metadata: + * api/gtk-api.xml: Marked the arguments to GetSelectionBounds and + GetLayoutOffsets as out params. + 2003-07-28 Duncan Mak * glade/XML.custom: Added new convenience factory methods, diff --git a/api/gtk-api.xml b/api/gtk-api.xml index 72bba6a17..fe9516488 100644 --- a/api/gtk-api.xml +++ b/api/gtk-api.xml @@ -4101,8 +4101,8 @@ - - + + @@ -4120,8 +4120,8 @@ - - + + diff --git a/doc/ChangeLog b/doc/ChangeLog index edcd4c6ad..493e43e60 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-07-29 Duncan Mak + + * en/Gtk/Label.xml: Finished documentation for the Gtk.Label + class. + 2003-07-28 Duncan Mak * en/Glade/XML.xml: Added some documentation. diff --git a/doc/en/Gtk/Label.xml b/doc/en/Gtk/Label.xml index 94f5ca0a7..6e592fc78 100644 --- a/doc/en/Gtk/Label.xml +++ b/doc/en/Gtk/Label.xml @@ -48,8 +48,8 @@ Gtk.Label - - + + Creates a new label widget, containing the text in . @@ -77,21 +77,21 @@ - + Method System.Boolean - - - + + + - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Gets the selected range of characters in the label. + return location for start of selection, as a character offset + return location for end of selection, as a character offset + returns if there's a selection. + @@ -101,31 +101,59 @@ System.Void - - - + + + - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Selects a range of characters in the label, if the label is selectable. + start offset (in characters not bytes) + end offset (in characters not bytes) + + + Selects a range of characters in the label, if the label + is selectable. See . If the + label is not selectable, this function has no effect. If + or + are -1, then the end of the + label will be substituted. + + - + Method System.Void - - - + + + - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + + Obtains the coordinates where the label will draw the + representing the text in the label + + + location to store X offset of layout, or + + location to store Y offset of layout, or + + + Obtains the coordinates where the label will draw the + representing the text in the label; useful to + convert mouse events into coordinates inside the + , e.g. to take some action if some part of the + label is clicked. Of course you will need to create a + to receive the events, and pack the label + inside it, since labels are a + widget. Remember when using the + functions you + need to convert to and from pixels using PANGO_PIXELS() or + PANGO_SCALE. + + @@ -145,8 +173,8 @@ Constructor - - + + Internal constructor Pointer to the C object. @@ -161,8 +189,8 @@ Constructor - - + + Creates a new label with the given text inside it. You can @@ -186,9 +214,9 @@ - To be added - To be added: an object of type 'Gtk.Label' - To be added + Constructor used to extending this class + the newly created + @@ -209,20 +237,18 @@ System.String - - + - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' + Sets the label's text + the text for this label - Sets the label's text from the string . If characters in are preceded by an - underscore, they are underlined indicating that they - represent a keyboard accelerator called a mnemonic. The - mnemonic key can be used to activate another widget, - chosen automatically, or explicitly using - . + Sets the label's text. If characters in + are preceded by an underscore, they are + underlined indicating that they represent a keyboard + accelerator called a mnemonic. The mnemonic key can be + used to activate another widget, chosen automatically, or + explicitly using . @@ -233,15 +259,14 @@ System.String - - + Parses str which is marked up with the Pango text markup language a markup string (see Pango markup format) a GtkLabel - Parses which is marked up with the + Parses which is marked up with the Pango text markup language, setting the label's text and attribute list based on the parse results. @@ -254,8 +279,7 @@ System.Boolean - - + Toggles line wrapping within the GtkLabel widget. @@ -273,8 +297,7 @@ System.String - - + The text within the GtkLabel widget. The text you want to set. @@ -293,11 +316,11 @@ Pango.Layout - Gets the PangoLayout used to display the label. - the PangoLayout for this label + Gets the used to display the label. + the for this label - Gets the PangoLayout used to display the label. The layout + Gets the used to display the label. The layout is useful to e.g. convert text positions to pixel positions, in combination with . The returned layout is owned by the label so need not be freed by the caller. @@ -311,11 +334,10 @@ System.String - - + - Parses which is marked up with the + Parses which is marked up with the Pango text markup language, setting the label's text and attribute list based on the parse results. @@ -323,7 +345,7 @@ a new label widget - Parses which is marked up with the + Parses which is marked up with the Pango text markup language, setting the label's text and attribute list based on the parse results. If characters in str are preceded by an underscore, they are underlined @@ -343,8 +365,7 @@ System.Boolean - - + Toggle whether or not the label allow the user to select text from the label, for copy-and-paste. @@ -364,8 +385,7 @@ Gtk.Justification - - + The alignment of the lines in the text of the label relative to each other a @@ -388,9 +408,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The current position of the insertion cursor in characters. + The current position of the insertion cursor in characters + @@ -400,9 +420,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The position of the opposite end of the selection from the cursor in characters. + The position of the opposite end of the selection from the cursor in characters. + @@ -411,13 +431,12 @@ Gtk.Widget - - + - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + The widget to be activated when the label's mnemonic key is pressed. + The widget to be activated when the label's mnemonic key is pressed. + The widget to be activated when the label's mnemonic key is pressed. + @@ -426,13 +445,12 @@ System.String - - + - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + Thee text from a label widget including any embedded underlines indicating mnemonics and Pango markup. + The text of the label widget + The text of the label widget. + @@ -441,13 +459,11 @@ System.String - - + - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + A string with _ characters in positions correspond to characters in the text to underline. + A string with _ characters in positions correspond to characters in the text to underline. + @@ -457,9 +473,9 @@ System.UInt32 - To be added - To be added: an object of type 'uint' - To be added + The mnemonic accelerator key for this label. + The mnemonic accelerator key for this label. + @@ -468,13 +484,13 @@ System.Boolean - - + - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether lines should be wrapped if the text becomes too wide. + + to wrap lines + whether lines should be wrapped + @@ -483,13 +499,19 @@ System.Boolean - - + - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + + Whether an underline in the text indicates the next + character should be used for the mnemonic accelerator key. + + + to use underline + + Whether an underline in the text indicates the next + character should be used for the mnemonic accelerator key. + + @@ -498,8 +520,7 @@ System.Boolean - - + Whether the label's text is interpreted as marked up with the Pango text markup language. @@ -515,43 +536,57 @@ Pango.AttrList - - + - To be added - To be added: an object of type 'Pango.AttrList' - To be added: an object of type 'Pango.AttrList' - To be added + The attribute list set on the label. + a + the attribute list set on the label + + + This function does not reflect attributes that come from + the labels markup (see ). If you + want to get the effective attributes for the label, use + on the label's + property. + + + Event - GtkSharp.MoveCursorHandler + + GtkSharp.MoveCursorHandler + - To be added - To be added + Emitted when the cursor is moved. + Event - GtkSharp.PopulatePopupHandler + + GtkSharp.PopulatePopupHandler + - To be added - To be added + Emitted when a right-click pop-up menu is displayed + Event - System.EventHandler + + System.EventHandler + - To be added - To be added + Emitted when text is copied to the clipboard. + @@ -559,8 +594,8 @@ Constructor - - + + Internal constructor GLib type for the type @@ -571,4 +606,4 @@ - + \ No newline at end of file diff --git a/sources/Gtk.metadata b/sources/Gtk.metadata index 6e7696213..be647834a 100644 --- a/sources/Gtk.metadata +++ b/sources/Gtk.metadata @@ -283,6 +283,10 @@ GetSelectionBounds GetLayoutOffsets + + GetSelectionBounds + GetLayoutOffsets + gint*