Xorn
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Functions
selection.cc File Reference
#include "internal.h"
#include "key_iterator.h"
#include <algorithm>

Go to the source code of this file.

Functions

xorn_selection_t xorn_select_none ()
 Create an empty selection. More...
 
xorn_selection_t xorn_select_object (xorn_object_t ob)
 Create a selection containing a single object. More...
 
xorn_selection_t xorn_select_attached_to (xorn_revision_t rev, xorn_object_t ob)
 Create a selection containing all objects in a revision attached to a given object. More...
 
xorn_selection_t xorn_select_all (xorn_revision_t rev)
 Create a selection containing all objects in a revision. More...
 
xorn_selection_t xorn_select_all_except (xorn_revision_t rev, xorn_selection_t sel)
 Create a selection containing all objects in a revision except those in a given selection. More...
 
xorn_selection_t xorn_select_including (xorn_selection_t sel, xorn_object_t ob)
 Create a selection which contains all the objects in an existing selection plus a given object. More...
 
xorn_selection_t xorn_select_excluding (xorn_selection_t sel, xorn_object_t ob)
 Create a selection which contains all the objects in an existing selection minus a given object. More...
 
xorn_selection_t xorn_select_union (xorn_selection_t sel0, xorn_selection_t sel1)
 Create a selection containing the objects in either given selection. More...
 
xorn_selection_t xorn_select_intersection (xorn_selection_t sel0, xorn_selection_t sel1)
 Create a selection containing the objects in both given selections. More...
 
xorn_selection_t xorn_select_difference (xorn_selection_t sel0, xorn_selection_t sel1)
 Create a selection containing the objects contained in one given selection, but not the other. More...
 
bool xorn_selection_is_empty (xorn_revision_t rev, xorn_selection_t sel)
 Return whether a selection is empty in a given revision. More...
 
bool xorn_object_is_selected (xorn_revision_t rev, xorn_selection_t sel, xorn_object_t ob)
 Return whether an object exists in a revision and is selected in a selection. More...
 
void xorn_free_selection (xorn_selection_t sel)
 Free the memory used for storing a selection. More...
 

Function Documentation

void xorn_free_selection ( xorn_selection_t  sel)

Free the memory used for storing a selection.

Warning
sel must not be passed to any Xorn function again.

Definition at line 277 of file selection.cc.

bool xorn_object_is_selected ( xorn_revision_t  rev,
xorn_selection_t  sel,
xorn_object_t  ob 
)

Return whether an object exists in a revision and is selected in a selection.

Definition at line 266 of file selection.cc.

xorn_selection_t xorn_select_all ( xorn_revision_t  rev)

Create a selection containing all objects in a revision.

Definition at line 90 of file selection.cc.

xorn_selection_t xorn_select_all_except ( xorn_revision_t  rev,
xorn_selection_t  sel 
)

Create a selection containing all objects in a revision except those in a given selection.

Definition at line 112 of file selection.cc.

xorn_selection_t xorn_select_attached_to ( xorn_revision_t  rev,
xorn_object_t  ob 
)

Create a selection containing all objects in a revision attached to a given object.

The object may be NULL, in which case the selection contains all objects which are not attached.

Returns
Returns the new selection, or NULL if ob does not exist in rev or there is not enough memory.

Definition at line 61 of file selection.cc.

xorn_selection_t xorn_select_difference ( xorn_selection_t  sel0,
xorn_selection_t  sel1 
)

Create a selection containing the objects contained in one given selection, but not the other.

Definition at line 224 of file selection.cc.

xorn_selection_t xorn_select_excluding ( xorn_selection_t  sel,
xorn_object_t  ob 
)

Create a selection which contains all the objects in an existing selection minus a given object.

Definition at line 156 of file selection.cc.

xorn_selection_t xorn_select_including ( xorn_selection_t  sel,
xorn_object_t  ob 
)

Create a selection which contains all the objects in an existing selection plus a given object.

Definition at line 136 of file selection.cc.

xorn_selection_t xorn_select_intersection ( xorn_selection_t  sel0,
xorn_selection_t  sel1 
)

Create a selection containing the objects in both given selections.

Definition at line 201 of file selection.cc.

xorn_selection_t xorn_select_none ( )

Create an empty selection.

Definition at line 24 of file selection.cc.

xorn_selection_t xorn_select_object ( xorn_object_t  ob)

Create a selection containing a single object.

Definition at line 35 of file selection.cc.

xorn_selection_t xorn_select_union ( xorn_selection_t  sel0,
xorn_selection_t  sel1 
)

Create a selection containing the objects in either given selection.

Definition at line 178 of file selection.cc.

bool xorn_selection_is_empty ( xorn_revision_t  rev,
xorn_selection_t  sel 
)

Return whether a selection is empty in a given revision.

Definition at line 246 of file selection.cc.