diff --git a/ChangeLog b/ChangeLog index 7a697f840..c1a5c54f9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -83,6 +83,9 @@ 2003-03-15 Duncan Mak + * gtk/ColorSelectionDialog.custom: Rename the inner Button class + to be ColorSelectionButton to avoid a name clash in the doc generator. + * gtk/TextBuffer.custom: Fix the Text property. Patch from Mathias Hasselmann . diff --git a/doc/ChangeLog b/doc/ChangeLog index e1ed7ec02..e4a5de2a3 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-04-04 Duncan Mak + + * en/Gtk/Label.xml: Add first draft of Label docs. + 2003-03-28 Lee Mallabone * en/Gtk/Calendar.xml: Second draft. diff --git a/doc/en/Gtk/Label.xml b/doc/en/Gtk/Label.xml index 9bdf6d0e1..471954a8e 100644 --- a/doc/en/Gtk/Label.xml +++ b/doc/en/Gtk/Label.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,21 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A widget that displays a small to medium amount of text + + + This widget displays a small to medium amount of text, it is + the widget used by other widgets, such as and for + displaying text. + + + Labels may contain mnemonics; mnemonics are underlined + characters in the label, used for keyboard navigation. To + provide the mnemonic, put an underscore before the mnemonic + character, such as "_File". + + Gtk.Misc @@ -39,10 +52,29 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Label' - To be added + Creates a new label widget, containing the text in + . + The text of the label, with an optional underscore to mark the mnemonic character + a new widget + + + If characters in str are preceded by an underscore, they + are underlined. If you need a literal underscore character + in a label, use '__' (two underscores). The first + underlined character represents a keyboard accelerator + called a mnemonic. The mnemonic key can be used to + activate another widget, chosen automatically, or + explicitly using . + + + If is not set, then the + first activatable ancestor of the will be chosen + as the mnemonic widget. For instance, if the label is + inside a button or menu item, the button or menu item will + automatically become the mnemonic widget and be activated + by the mnemonic. + + @@ -133,10 +165,20 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Label' - To be added + + Creates a new label with the given text inside it. You can + pass to get an empty label + widget. + + The text of the label + the new label widget + + + Creates a new label with the given text inside it. You can + pass to get an empty label + widget. + + @@ -175,7 +217,17 @@ To be added To be added: an object of type 'string' To be added: an object of type 'string' - To be added + + + 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 + . + + @@ -188,10 +240,16 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + 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 + Pango text markup language, setting the label's text and + attribute list based on the parse results. + + @@ -204,10 +262,14 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Toggles line wrapping within the GtkLabel widget. + + makes it + break lines if text exceeds the widget's size. lets the text get cut off by the edge + of the widget if it exceeds the widget size. + + if the lines of the label are automatically wrapped. + @@ -220,10 +282,14 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The text within the GtkLabel widget. + The text you want to set. + a GtkLabel + + + When setting the text within the GtkLabel widget, it overwrites any text that was there before. + + @@ -233,9 +299,17 @@ Pango.Layout - To be added - To be added: an object of type 'Pango.Layout' - To be added + Gets the PangoLayout used to display the label. + the PangoLayout for this label + + + Gets the PangoLayout 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. + + @@ -248,10 +322,28 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + + Parses which is marked up with the + Pango text markup language, setting the label's text and + attribute list based on the parse results. + + a markup string (see Pango markup format) + a new label widget + + + 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 + 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 . + + @@ -264,10 +356,16 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Toggle whether or not the label allow the user to select text from the label, for copy-and-paste. + + to allow selecting text in the + label, and to disallow. + + + if the label is selectable, and + if not. + + @@ -280,10 +378,21 @@ - To be added - To be added: an object of type 'Gtk.Justification' - To be added: an object of type 'Gtk.Justification' - To be added + The alignment of the lines in the text of the label relative to each other + a + The justification of the label + + + Sets the alignment of the lines in the text of the label + relative to each other. is the default value + when the widget is first created with . If you instead want to set the + alignment of the label as a whole, set instead. This has no effect + on labels containing only a single line. + + @@ -412,10 +521,11 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the label's text is interpreted as marked up with the Pango text markup language. + to parse the + text as Pango markup, as plain-text + +