XfceTreeView

XfceTreeView — An improved version of GtkTreeView

Functions

GtkWidget * xfce_tree_view_new ()
gboolean xfce_tree_view_get_single_click ()
void xfce_tree_view_set_single_click ()
guint xfce_tree_view_get_single_click_timeout ()
void xfce_tree_view_set_single_click_timeout ()

Properties

gboolean single-click Read / Write
guint single-click-timeout Read / Write

Types and Values

  XfceTreeView

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkTreeView
                    ╰── XfceTreeView

Implemented Interfaces

XfceTreeView implements AtkImplementorIface, GtkBuildable and GtkScrollable.

Includes

#include <libxfce4ui/libxfce4ui.h>

Description

The XfceTreeView class derives from GtkTreeView and extends it with the ability to activate rows using single button clicks instead of the default double button clicks. It also works around a few shortcomings of GtkTreeView, i.e. XfceTreeView allows the user to drag around multiple selected rows.

Functions

xfce_tree_view_new ()

GtkWidget *
xfce_tree_view_new (void);

Allocates a new XfceTreeView instance.

Returns

the newly allocated XfceTreeView.

[transfer full]

Since: 4.21.0

xfce_tree_view_get_single_click ()

gboolean
xfce_tree_view_get_single_click (XfceTreeView *tree_view);

Returns TRUE if tree_view is in single-click mode, else FALSE.

Parameters

tree_view

an XfceTreeView.

  

Returns

whether tree_view is in single-click mode.

Since: 4.21.0

xfce_tree_view_set_single_click ()

void
xfce_tree_view_set_single_click (XfceTreeView *tree_view,
                                 gboolean single_click);

If single_click is TRUE, tree_view will use single-click mode, else the default double-click mode will be used.

Parameters

tree_view

an XfceTreeView.

  

single_click

TRUE to use single-click for tree_view , FALSE otherwise.

  

Since: 4.21.0

xfce_tree_view_get_single_click_timeout ()

guint
xfce_tree_view_get_single_click_timeout
                               (XfceTreeView *tree_view);

Returns the amount of time in milliseconds after which the item under the mouse cursor will be selected automatically in single click mode. A value of 0 means that the behavior is disabled and the user must alter the selection manually.

Parameters

tree_view

a XfceTreeView.

  

Returns

the single click autoselect timeout or 0 if the behavior is disabled.

Since: 4.21.0

xfce_tree_view_set_single_click_timeout ()

void
xfce_tree_view_set_single_click_timeout
                               (XfceTreeView *tree_view,
                                guint single_click_timeout);

If single_click_timeout is a value greater than zero, it specifies the amount of time in milliseconds after which the item under the mouse cursor will be selected automatically in single click mode. A value of 0 for single_click_timeout disables the autoselection for tree_view .

This setting does not have any effect unless the tree_view is in single-click mode, see xfce_tree_view_set_single_click().

Parameters

tree_view

a XfceTreeView.

  

single_click_timeout

the new timeout or 0 to disable.

  

Since: 4.21.0

Types and Values

XfceTreeView

typedef struct _XfceTreeView XfceTreeView;

The XfceTreeView struct contains only private fields and should not be directly accessed.

Property Details

The “single-click” property

  “single-click”             gboolean

TRUE to activate items using a single click instead of a double click.

Owner: XfceTreeView

Flags: Read / Write

Default value: FALSE

Since: 4.21.0

The “single-click-timeout” property

  “single-click-timeout”     guint

The amount of time in milliseconds after which the hover row (the row which is hovered by the mouse cursor) will be selected automatically in single-click mode. A value of 0 disables the automatic selection.

Owner: XfceTreeView

Flags: Read / Write

Default value: 0

Since: 4.21.0

Generated by GTK-Doc V1.34.0