summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/reference/endless/endless-sections.txt12
-rw-r--r--endless/eosenums.h11
-rw-r--r--endless/eosflexygrid.c2
-rw-r--r--endless/eosflexygrid.h33
4 files changed, 56 insertions, 2 deletions
diff --git a/docs/reference/endless/endless-sections.txt b/docs/reference/endless/endless-sections.txt
index a9c70f0..de69f31 100644
--- a/docs/reference/endless/endless-sections.txt
+++ b/docs/reference/endless/endless-sections.txt
@@ -3,6 +3,8 @@
eos_hello_sample_function
<SUBSECTION Private>
EOS_SDK_ALL_API_VERSIONS
+EOS_DEFINE_ENUM_TYPE
+EOS_ENUM_VALUE
</SECTION>
<SECTION>
@@ -154,11 +156,15 @@ eos_flexy_grid_get_cell_at_coords
eos_flexy_grid_cell_new
eos_flexy_grid_cell_set_shape
eos_flexy_grid_cell_get_shape
+EosFlexyShape
+<SUBSECTION>
+EOS_STYLE_CLASS_FLEXY_GRID
+EOS_STYLE_CLASS_FLEXY_GRID_CELL
<SUBSECTION Standard>
EOS_TYPE_FLEXY_GRID
EOS_FLEXY_GRID
EOS_FLEXY_GRID_CLASS
-EOS_FLEXY_GRID_GET_CLAS
+EOS_FLEXY_GRID_GET_CLASS
EOS_IS_FLEXY_GRID
EOS_IS_FLEXY_GRID_CLASS
EOS_TYPE_FLEXY_GRID_CELL
@@ -167,7 +173,11 @@ EOS_FLEXY_GRID_CELL_CLASS
EOS_FLEXY_GRID_CELL_GET_CLASS
EOS_IS_FLEXY_GRID_CELL
EOS_IS_FLEXY_GRID_CELL_CLASS
+EOS_TYPE_FLEXY_SHAPE
<SUBSECTION Private>
+EosFlexyGridClass
+EosFlexyGridCellClass
eos_flexy_grid_get_type
eos_flexy_grid_cell_get_type
+eos_flexy_shape_get_type
</SECTION>
diff --git a/endless/eosenums.h b/endless/eosenums.h
index 8d50f1b..d9b396a 100644
--- a/endless/eosenums.h
+++ b/endless/eosenums.h
@@ -42,6 +42,17 @@ typedef enum
#define EOS_TYPE_FLEXY_SHAPE (eos_flexy_shape_get_type ())
+/**
+ * EosFlexyShape:
+ * @EOS_FLEXY_SHAPE_SMALL: 1x1 shape for small cells
+ * @EOS_FLEXY_SHAPE_MEDIUM_HORIZONTAL: 2x1 <quote>landscape</quote> shape for
+ * medium cells
+ * @EOS_FLEXY_SHAPE_MEDIUM_VERTICAL: 1x2 <quote>portrait</quote> shape for
+ * medium cells
+ * @EOS_FLEXY_SHAPE_LARGE: 2x2 shape for large cells
+ *
+ * Sizes for flexible-layout cells in `EosFlexyGrid`.
+ */
typedef enum
{
EOS_FLEXY_SHAPE_SMALL,
diff --git a/endless/eosflexygrid.c b/endless/eosflexygrid.c
index b695cc1..7e1d35e 100644
--- a/endless/eosflexygrid.c
+++ b/endless/eosflexygrid.c
@@ -2,7 +2,7 @@
/**
* SECTION:flexy-grid
- * @Title: EosFlexyGrid
+ * @Title: Flexible Grid
* @Short_Description: A flexible grid layout manager
*
* The #EosFlexyGrid widget provides a grid of cells in a layout controlled
diff --git a/endless/eosflexygrid.h b/endless/eosflexygrid.h
index f1d9516..43ceca7 100644
--- a/endless/eosflexygrid.h
+++ b/endless/eosflexygrid.h
@@ -23,15 +23,48 @@ G_BEGIN_DECLS
#define EOS_IS_FLEXY_GRID_CELL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EOS_TYPE_FLEXY_GRID_CELL))
#define EOS_FLEXY_GRID_CELL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EOS_TYPE_FLEXY_GRID_CELL, EosFlexyGridCellClass))
+/**
+ * EOS_STYLE_CLASS_FLEXY_GRID:
+ *
+ * A CSS class to match a grid with flexible layout, used by #EosFlexyGrid.
+ */
#define EOS_STYLE_CLASS_FLEXY_GRID "flexy-grid"
+/**
+ * EOS_STYLE_CLASS_FLEXY_GRID_CELL:
+ *
+ * A CSS class to match a cell inside a grid with flexible layout, used by
+ * #EosFlexyGrid.
+ */
#define EOS_STYLE_CLASS_FLEXY_GRID_CELL "flexy-grid-cell"
+/**
+ * EosFlexyGrid:
+ *
+ * This structure contains no public members.
+ */
typedef struct _EosFlexyGrid EosFlexyGrid;
typedef struct _EosFlexyGridClass EosFlexyGridClass;
+/**
+ * EosFlexyGridCell:
+ *
+ * This structure contains no public members.
+ */
typedef struct _EosFlexyGridCell EosFlexyGridCell;
typedef struct _EosFlexyGridCellClass EosFlexyGridCellClass;
+/**
+ * EosFlexyGridSortFunc:
+ * @cell_a: first cell to compare
+ * @cell_b: second cell to compare
+ * @user_data: data passed to eos_flexy_grid_set_sort_func()
+ *
+ * Type for functions that determine the sort order of two cells inside the
+ * grid.
+ *
+ * Returns: -1 if @cell_a should come before @cell_b, 1 if @cell_a should come
+ * after @cell_b, or 0 if @cell_a and @cell_b are identical.
+ */
typedef gint (* EosFlexyGridSortFunc) (EosFlexyGridCell *cell_a,
EosFlexyGridCell *cell_b,
gpointer user_data);