CaribouIScannableGroup

CaribouIScannableGroup — Interface implemented by containers of selectable items in scanning mode.

Functions

CaribouIScannableItem * caribou_iscannable_group_child_select ()
void caribou_iscannable_group_scan_reset ()
CaribouIScannableItem ** caribou_iscannable_group_get_scan_children ()
CaribouIScannableItem * caribou_iscannable_group_child_step ()
CaribouIScannableItem ** caribou_iscannable_group_get_step_path ()
CaribouIScannableItem ** caribou_iscannable_group_get_selected_path ()
CaribouScanGrouping caribou_iscannable_group_get_scan_grouping ()
void caribou_iscannable_group_set_scan_grouping ()

Properties

CaribouScanGrouping scan-grouping Read / Write

Signals

void scan-cleared Run Last
void selected-item-changed Run Last
void step-item-changed Run Last

Types and Values

enum CaribouScanGrouping
  CaribouIScannableGroup
struct CaribouIScannableGroupIface

Object Hierarchy

    GEnum
    ╰── CaribouScanGrouping
    GInterface
    ╰── CaribouIScannableGroup

Prerequisites

CaribouIScannableGroup requires GObject.

Known Implementations

CaribouIScannableGroup is implemented by CaribouColumnModel, CaribouLevelModel, CaribouRowModel and CaribouScannableGroup.

Description

Functions

caribou_iscannable_group_child_select ()

CaribouIScannableItem *
caribou_iscannable_group_child_select (CaribouIScannableGroup *self);

Parameters

self

the CaribouIScannableGroup instance

  

caribou_iscannable_group_scan_reset ()

void
caribou_iscannable_group_scan_reset (CaribouIScannableGroup *self);

Parameters

self

the CaribouIScannableGroup instance

  

caribou_iscannable_group_get_scan_children ()

CaribouIScannableItem **
caribou_iscannable_group_get_scan_children
                               (CaribouIScannableGroup *self,
                                int *result_length1);

Parameters

self

the CaribouIScannableGroup instance

  

Returns

.

[array length=result_length1]

caribou_iscannable_group_child_step ()

CaribouIScannableItem *
caribou_iscannable_group_child_step (CaribouIScannableGroup *self,
                                     gint cycles);

Parameters

self

the CaribouIScannableGroup instance

  

cycles

 

  

caribou_iscannable_group_get_step_path ()

CaribouIScannableItem **
caribou_iscannable_group_get_step_path
                               (CaribouIScannableGroup *self,
                                int *result_length1);

Parameters

self

the CaribouIScannableGroup instance

  

Returns

.

[array length=result_length1]

caribou_iscannable_group_get_selected_path ()

CaribouIScannableItem **
caribou_iscannable_group_get_selected_path
                               (CaribouIScannableGroup *self,
                                int *result_length1);

Parameters

self

the CaribouIScannableGroup instance

  

Returns

.

[array length=result_length1]

caribou_iscannable_group_get_scan_grouping ()

CaribouScanGrouping
caribou_iscannable_group_get_scan_grouping
                               (CaribouIScannableGroup *self);

Get and return the current value of the "scan-grouping" property.

Parameters

self

the CaribouIScannableGroup instance to query

  

Returns

the value of the "scan-grouping" property

caribou_iscannable_group_set_scan_grouping ()

void
caribou_iscannable_group_set_scan_grouping
                               (CaribouIScannableGroup *self,
                                CaribouScanGrouping value);

Set the value of the "scan-grouping" property to value .

Parameters

self

the CaribouIScannableGroup instance to modify

  

value

the new value of the "scan-grouping" property

  

Types and Values

enum CaribouScanGrouping

Members

CARIBOU_SCAN_GROUPING_NONE

    

CARIBOU_SCAN_GROUPING_SUBGROUPS

    

CARIBOU_SCAN_GROUPING_ROWS

    

CARIBOU_SCAN_GROUPING_LINEAR

    

CaribouIScannableGroup

typedef struct _CaribouIScannableGroup CaribouIScannableGroup;

Interface implemented by containers of selectable items in scanning mode.

struct CaribouIScannableGroupIface

struct CaribouIScannableGroupIface {
	GTypeInterface parent_iface;
	CaribouIScannableItem* (*child_select) (CaribouIScannableGroup* self);
	void (*scan_reset) (CaribouIScannableGroup* self);
	CaribouIScannableItem** (*get_scan_children) (CaribouIScannableGroup* self, int* result_length1);
	CaribouIScannableItem* (*child_step) (CaribouIScannableGroup* self, gint cycles);
	CaribouIScannableItem** (*get_step_path) (CaribouIScannableGroup* self, int* result_length1);
	CaribouIScannableItem** (*get_selected_path) (CaribouIScannableGroup* self, int* result_length1);
	CaribouScanGrouping (*get_scan_grouping) (CaribouIScannableGroup* self);
	void (*set_scan_grouping) (CaribouIScannableGroup* self, CaribouScanGrouping value);
};

Interface for creating CaribouIScannableGroup implementations.

Members

GTypeInterface parent_iface;

the parent interface structure

  

child_select ()

virtual method called by caribou_iscannable_group_child_select()

  

scan_reset ()

virtual method called by caribou_iscannable_group_scan_reset()

  

get_scan_children ()

virtual method called by caribou_iscannable_group_get_scan_children()

  

child_step ()

virtual method called by caribou_iscannable_group_child_step()

  

get_step_path ()

virtual method called by caribou_iscannable_group_get_step_path()

  

get_selected_path ()

virtual method called by caribou_iscannable_group_get_selected_path()

  

get_scan_grouping ()

getter method for the abstract property "scan-grouping"

  

set_scan_grouping ()

setter method for the abstract property "scan-grouping"

  

Property Details

The “scan-grouping” property

  “scan-grouping”            CaribouScanGrouping

scan-grouping.

Flags: Read / Write

Default value: CARIBOU_SCAN_GROUPING_NONE

Signal Details

The “scan-cleared” signal

void
user_function (CaribouIScannableGroup *iscannable_group,
               gpointer                user_data)

Parameters

iscannable_group

the CaribouIScannableGroup instance that received the signal

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

The “selected-item-changed” signal

void
user_function (CaribouIScannableGroup *iscannable_group,
               CaribouIScannableItem  *selected_item,
               gpointer                user_data)

Parameters

iscannable_group

the CaribouIScannableGroup instance that received the signal

  

selected_item

 

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

The “step-item-changed” signal

void
user_function (CaribouIScannableGroup *iscannable_group,
               CaribouIScannableItem  *step_item,
               gpointer                user_data)

Parameters

iscannable_group

the CaribouIScannableGroup instance that received the signal

  

step_item

 

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Generated by GTK-Doc V1.25