diff --git a/doc/ChangeLog b/doc/ChangeLog index 133038612..724f25cd8 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -2,6 +2,7 @@ * en/Gtk/CellRendererMode.xml: documented * en/Gtk/CellRendererState.xml: documented + * en/Gtk/CellRenderer.xml: documented 2003-07-17 Duncan Mak diff --git a/doc/en/Gtk/CellRenderer.xml b/doc/en/Gtk/CellRenderer.xml index b43ceaa49..900c86c03 100644 --- a/doc/en/Gtk/CellRenderer.xml +++ b/doc/en/Gtk/CellRenderer.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,27 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An object for rendering a single cell on a + + + The is a base class of a set of objects used for rendering a cell to a . + These objects are used primarily by the widget, though they are not tied to them in any specific way. + It is worth noting that is not a and cannot be treated as such. + + + The primary use of a is for drawing a certain graphical elements on a . + Typically, one is used to draw many cells on the screen. + To this extent, it is not expected that a keep any permanent state around. + Instead, any state is set just prior to use. + Then, the cell is measured using . + Finally, the cell is rendered in the correct location using . + + + There are a number of rules that must be followed when writing a new . + First and foremost, it is important that a certain set of properties will always yield a of the same size, barring a change. + The also has a number of generic properties that are expected to be honored by all children. + + Gtk.Object @@ -38,14 +57,19 @@ - To be added - To be added: an object of type 'Gdk.Window' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gtk.CellRendererState' - To be added + Invokes the virtual render function of the . + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + + The three passed-in rectangles are areas of . + Most renderers will draw within ; + includes the blank space around the cell, and also the area containing the tree expander; so the rectangles for all cells tile to cover the entire window. + is a clip rectangle. + @@ -57,20 +81,24 @@ - - - - + + + + - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added + Obtains the and needed to render the cell. + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + + Used by view widgets to determine the appropriate size for the passed to gtk_cell_renderer_render(). + If is not , fills in the x and y offsets (if set) of the cell relative to this location. + Please note that the values set in and , as well as those in and are inclusive of the xpad and ypad properties. + @@ -84,9 +112,9 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' + Sets the renderer size to be explicit, independent of the properties set. + an object of type + an object of type To be added @@ -97,13 +125,13 @@ System.Void - - + + To be added - To be added: an object of type 'int&' - To be added: an object of type 'int&' + an object of type + an object of type To be added @@ -122,14 +150,14 @@ - To be added - To be added: an object of type 'Gdk.Event' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gtk.CellRendererState' - To be added: an object of type 'Gtk.CellEditable' + Passes an activate event to the for possible processing. + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type To be added @@ -148,15 +176,15 @@ - To be added - To be added: an object of type 'Gdk.Event' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gtk.CellRendererState' - To be added: an object of type 'bool' - To be added + Passes an activate event to the for possible processing. + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + an object of type + Some s may use events; for example, toggles when it gets a mouse click. @@ -193,9 +221,9 @@ - To be added - To be added: an object of type 'Gtk.CellRenderer' - To be added + Internal constructor + an object of type + This is an internal constructor, and should not be used by user code. Normally this would be called by an inherited class. @@ -205,8 +233,8 @@ System.UInt32 - The GLib Type for Gtk.CellRenderer - The GLib Type for the Gtk.CellRenderer class. + The for + The for the class. @@ -220,10 +248,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The fixed height. + an object of type + an object of type + @@ -236,10 +264,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Display the cell. + an object of type + an object of type + @@ -252,10 +280,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + The x-align. + an object of type + an object of type + @@ -268,10 +296,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The fixed width. + an object of type + an object of type + @@ -284,10 +312,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + The y-align. + an object of type + an object of type + @@ -300,10 +328,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Row has children. + an object of type + an object of type + @@ -316,10 +344,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + The ypad. + an object of type + an object of type + @@ -332,10 +360,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + The xpad. + an object of type + an object of type + @@ -348,10 +376,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Row is an expander row, and is expanded. + an object of type + an object of type + @@ -364,10 +392,10 @@ - To be added - To be added: an object of type 'Gtk.CellRendererMode' - To be added: an object of type 'Gtk.CellRendererMode' - To be added + Editable mode of the CellRenderer. + an object of type + an object of type + @@ -396,10 +424,10 @@ - To be added + Cell background color as a . a a - To be added + @@ -412,11 +440,11 @@ - To be added + Cell background color as a . a a - To be added + - \ No newline at end of file +