forked from AuroraMiddleware/gtk
treeview: Update the description format
This commit is contained in:
parent
cf707cbfaa
commit
35e438a62e
@ -80,20 +80,19 @@
|
|||||||
* #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf,
|
* #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf,
|
||||||
* #GtkCellRendererText, #GtkCellRendererToggle
|
* #GtkCellRendererText, #GtkCellRendererToggle
|
||||||
*
|
*
|
||||||
* Widget that displays any object that implements the #GtkTreeModel interface.
|
* Widget that displays any object that implements the [iface@Gtk.TreeModel] interface.
|
||||||
*
|
*
|
||||||
* Please refer to the
|
* Please refer to the [tree widget conceptual overview](section-tree-widget.html)
|
||||||
* [tree widget conceptual overview][TreeWidget]
|
* for an overview of all the objects and data types related to the tree
|
||||||
* for an overview of all the objects and data types related
|
* widget and how they work together.
|
||||||
* to the tree widget and how they work together.
|
|
||||||
*
|
*
|
||||||
* Several different coordinate systems are exposed in the GtkTreeView API.
|
* ## Coordinate systems in GtkTreeView API
|
||||||
|
*
|
||||||
|
* Several different coordinate systems are exposed in the `GtkTreeView` API.
|
||||||
* These are:
|
* These are:
|
||||||
*
|
*
|
||||||
* ![](tree-view-coordinates.png)
|
* ![](tree-view-coordinates.png)
|
||||||
*
|
*
|
||||||
* Coordinate systems in GtkTreeView API:
|
|
||||||
*
|
|
||||||
* - Widget coordinates: Coordinates relative to the widget (usually `widget->window`).
|
* - Widget coordinates: Coordinates relative to the widget (usually `widget->window`).
|
||||||
*
|
*
|
||||||
* - Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to.
|
* - Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to.
|
||||||
@ -104,18 +103,19 @@
|
|||||||
* Several functions are available for converting between the different
|
* Several functions are available for converting between the different
|
||||||
* coordinate systems. The most common translations are between widget and bin
|
* coordinate systems. The most common translations are between widget and bin
|
||||||
* window coordinates and between bin window and tree coordinates. For the
|
* window coordinates and between bin window and tree coordinates. For the
|
||||||
* former you can use gtk_tree_view_convert_widget_to_bin_window_coords()
|
* former you can use [method@Gtk.TreeView.convert_widget_to_bin_window_coords]
|
||||||
* (and vice versa), for the latter gtk_tree_view_convert_bin_window_to_tree_coords()
|
* (and vice versa), for the latter [method@Gtk.TreeView.convert_bin_window_to_tree_coords]
|
||||||
* (and vice versa).
|
* (and vice versa).
|
||||||
*
|
*
|
||||||
* # GtkTreeView as GtkBuildable
|
* ## `GtkTreeView` as `GtkBuildable`
|
||||||
*
|
*
|
||||||
* The GtkTreeView implementation of the GtkBuildable interface accepts
|
* The `GtkTreeView` implementation of the `GtkBuildable` interface accepts
|
||||||
* #GtkTreeViewColumn objects as <child> elements and exposes the internal
|
* [class@Gtk.TreeViewColumn] objects as `<child>` elements and exposes the
|
||||||
* #GtkTreeSelection in UI definitions.
|
* internal [class@Gtk.TreeSelection] in UI definitions.
|
||||||
*
|
*
|
||||||
* An example of a UI definition fragment with GtkTreeView:
|
* An example of a UI definition fragment with `GtkTreeView`:
|
||||||
* |[
|
*
|
||||||
|
* ```xml
|
||||||
* <object class="GtkTreeView" id="treeview">
|
* <object class="GtkTreeView" id="treeview">
|
||||||
* <property name="model">liststore1</property>
|
* <property name="model">liststore1</property>
|
||||||
* <child>
|
* <child>
|
||||||
@ -135,11 +135,11 @@
|
|||||||
* </object>
|
* </object>
|
||||||
* </child>
|
* </child>
|
||||||
* </object>
|
* </object>
|
||||||
* ]|
|
* ```
|
||||||
*
|
*
|
||||||
* # CSS nodes
|
* ## CSS nodes
|
||||||
*
|
*
|
||||||
* |[<!-- language="plain" -->
|
* ```
|
||||||
* treeview.view
|
* treeview.view
|
||||||
* ├── header
|
* ├── header
|
||||||
* │ ├── button
|
* │ ├── button
|
||||||
@ -150,20 +150,20 @@
|
|||||||
* │
|
* │
|
||||||
* ├── [rubberband]
|
* ├── [rubberband]
|
||||||
* ╰── [dndtarget]
|
* ╰── [dndtarget]
|
||||||
* ]|
|
* ```
|
||||||
*
|
*
|
||||||
* GtkTreeView has a main CSS node with name treeview and style class .view.
|
* `GtkTreeView` has a main CSS node with name `treeview` and style class `.view`.
|
||||||
* It has a subnode with name header, which is the parent for all the column
|
* It has a subnode with name `header`, which is the parent for all the column
|
||||||
* header widgets' CSS nodes.
|
* header widgets' CSS nodes.
|
||||||
*
|
*
|
||||||
* Each column header consists of a button, which among other content, has a
|
* Each column header consists of a `button`, which among other content, has a
|
||||||
* child with name sort-indicator, which carries the .ascending or .descending
|
* child with name `sort-indicator`, which carries the `.ascending` or `.descending`
|
||||||
* style classes when the column header should show a sort indicator. The CSS
|
* style classes when the column header should show a sort indicator. The CSS
|
||||||
* is expected to provide a suitable image using the -gtk-icon-source property.
|
* is expected to provide a suitable image using the `-gtk-icon-source` property.
|
||||||
*
|
*
|
||||||
* For rubberband selection, a subnode with name rubberband is used.
|
* For rubberband selection, a subnode with name `rubberband` is used.
|
||||||
*
|
*
|
||||||
* For the drop target location during DND, a subnode with name dndtarget is used.
|
* For the drop target location during DND, a subnode with name `dndtarget` is used.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
enum
|
enum
|
||||||
|
Loading…
Reference in New Issue
Block a user