libergtk/include/erGtkSelectionGroup.h File Reference

ereader gtk library - control a group of GtkToggleButton objects, similar to a radiobutton. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_erGtkSelectionGroup
struct	_erGtkSelectionGroupClass
Defines
#define	ERGTK_SELECTION_GROUP_TYPE   (ergtk_selection_group_get_type())
#define	ERGTK_SELECTION_GROUP(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj), ERGTK_SELECTION_GROUP_TYPE, erGtkSelectionGroup))
#define	ERGTK_IS_SELECTION_GROUP(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj), ERGTK_SELECTION_GROUP_TYPE))
#define	ERGTK_SELECTION_GROUP_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), ERGTK_SELECTION_GROUP_TYPE, erGtkSelectionGroupClass))
#define	ERGTK_SELECTION_GROUP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), ERGTK_SELECTION_GROUP_TYPE, erGtkSelectionGroupClass))
#define	ERGTK_IS_SELECTION_GROUP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), ERGTK_SELECTION_GROUP_TYPE))
Typedefs
typedef struct _erGtkSelectionGroup	erGtkSelectionGroup
typedef struct _erGtkSelectionGroupClass	erGtkSelectionGroupClass
Functions
GtkWidget *	ergtk_selection_group_new (GtkToggleButton **button_tbl)
gboolean	ergtk_selection_group_set_details (erGtkSelectionGroup *item, const guint min_selected, const guint max_selected)
void	ergtk_selection_group_freeze_buttons (erGtkSelectionGroup *item, const gboolean freeze)
GtkToggleButton *	ergtk_selection_group_get_button (erGtkSelectionGroup *item, const guint button_id)
void	ergtk_selection_group_get_selected_buttons (erGtkSelectionGroup *item, gint *button_ids, const guint len)
gint	ergtk_selection_group_get_length (erGtkSelectionGroup *item)
GType	ergtk_selection_group_get_type (void)

---

Detailed Description

ereader gtk library - control a group of GtkToggleButton objects, similar to a radiobutton.

Ensure only the allowed number of buttons is selected at any time. Note: no relation with the standard GTK class erGtkSelection.

Copyright (C) 2007 iRex Technologies B.V. All rights reserved.

Definition in file erGtkSelectionGroup.h.

---

Define Documentation

#define ERGTK_IS_SELECTION_GROUP

(

obj

)

(G_TYPE_CHECK_INSTANCE_TYPE((obj), ERGTK_SELECTION_GROUP_TYPE))

Definition at line 38 of file erGtkSelectionGroup.h.

#define ERGTK_IS_SELECTION_GROUP_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_TYPE((klass), ERGTK_SELECTION_GROUP_TYPE))

Definition at line 42 of file erGtkSelectionGroup.h.

#define ERGTK_SELECTION_GROUP

(

obj

)

(G_TYPE_CHECK_INSTANCE_CAST((obj), ERGTK_SELECTION_GROUP_TYPE, erGtkSelectionGroup))

Definition at line 37 of file erGtkSelectionGroup.h.

#define ERGTK_SELECTION_GROUP_CLASS

(

klass

)

(G_TYPE_CHECK_CLASS_CAST((klass), ERGTK_SELECTION_GROUP_TYPE, erGtkSelectionGroupClass))

Definition at line 40 of file erGtkSelectionGroup.h.

#define ERGTK_SELECTION_GROUP_GET_CLASS

(

obj

)

(G_TYPE_INSTANCE_GET_CLASS ((obj), ERGTK_SELECTION_GROUP_TYPE, erGtkSelectionGroupClass))

Definition at line 41 of file erGtkSelectionGroup.h.

#define ERGTK_SELECTION_GROUP_TYPE   (ergtk_selection_group_get_type())

Definition at line 36 of file erGtkSelectionGroup.h.

---

Typedef Documentation

typedef struct _erGtkSelectionGroup erGtkSelectionGroup

Definition at line 45 of file erGtkSelectionGroup.h.

typedef struct _erGtkSelectionGroupClass erGtkSelectionGroupClass

Definition at line 46 of file erGtkSelectionGroup.h.

---

Function Documentation

void ergtk_selection_group_freeze_buttons	(	erGtkSelectionGroup *	item,
		const gboolean	freeze
	)

force buttons to stay in their current state, even when user changes them

Parameters:

	item	- the erGtkSelectionGroup object
	freeze	- TRUE force buttons in current state, FALSE allow user to change buttons

Returns:

--

Definition at line 319 of file erGtkSelectionGroup.c.

{
    LOGPRINTF("entry: item [%p] freeze [%d]", item, freeze);
    g_return_if_fail(ERGTK_IS_SELECTION_GROUP(item));
    g_return_if_fail((item->dispose_has_run == FALSE));

    erGtkSelectionGroupClass* klass = ERGTK_SELECTION_GROUP_GET_CLASS(item);

    // chain to real method, which may be overloaded
    if (klass->freeze_buttons)
    {
        klass->freeze_buttons(item, freeze);
    }
}

GtkToggleButton* ergtk_selection_group_get_button	(	erGtkSelectionGroup *	item,
		const guint	button_id
	)

get button by index

Parameters:

	item	- the erGtkSelectionGroup object
	button_id	- id of the requested button as an index (0 ..) in button_tbl on .._new()

Returns:

ptr to the requested button, or NULL

Definition at line 346 of file erGtkSelectionGroup.c.

{
    LOGPRINTF("entry: item [%p] button_id [%d]", item, button_id);
    g_return_val_if_fail(ERGTK_IS_SELECTION_GROUP(item),   NULL);
    g_return_val_if_fail((item->dispose_has_run == FALSE), NULL);

    erGtkSelectionGroupClass* klass = ERGTK_SELECTION_GROUP_GET_CLASS(item);

    // chain to real method, which may be overloaded
    if (klass->get_button)
    {
        return klass->get_button(item, button_id);
    }
    else
    {
        return NULL;
    }
}

gint ergtk_selection_group_get_length

(

erGtkSelectionGroup *

item

)

get the number of how many buttons in erGtkSelectionGroup

Parameters:

item

- the erGtkSelectionGroup object

Returns:

the number of buttons

Definition at line 545 of file erGtkSelectionGroup.c.

{
    LOGPRINTF("entry: item [%p]", item);

    gint num_buttons = 0;
    
    g_return_val_if_fail(ERGTK_IS_SELECTION_GROUP(item), 0);
    g_return_val_if_fail(item->buttons, 0);
 
    num_buttons = g_slist_length(item->buttons);

    LOGPRINTF("%d buttons cotrolled by erGtkSelectionGroup [%p]",num_buttons, item);

    return num_buttons;
}

void ergtk_selection_group_get_selected_buttons	(	erGtkSelectionGroup *	item,
		gint *	button_ids,
		const guint	len
	)

get index of currently selected buttons

Parameters:

	item	- the erGtkSelectionGroup object
	button_ids	(out) - array selected buttons id (0 ..), latest selected first, unused items set to -1
	len	- number of elements in array button_ids

Returns:

--

Definition at line 377 of file erGtkSelectionGroup.c.

{
    LOGPRINTF("entry: item [%p]", item);
    g_return_if_fail(ERGTK_IS_SELECTION_GROUP(item));
    g_return_if_fail((item->dispose_has_run == FALSE));

    erGtkSelectionGroupClass* klass = ERGTK_SELECTION_GROUP_GET_CLASS(item);

    // chain to real method, which may be overloaded
    if (klass->get_selected_buttons)
    {
        klass->get_selected_buttons(item, button_ids, len);
    }
}

GType ergtk_selection_group_get_type

(

void

)

Definition at line 120 of file erGtkSelectionGroup.c.

{
    static GType class_type = 0;

    if (class_type == 0)
    {
        static const GTypeInfo class_info =
        {
            sizeof(erGtkSelectionGroupClass),
            NULL,               /* base_init */
            NULL,               /* base_finalize */
            (GClassInitFunc) ergtk_selection_group_class_init,
            NULL,               /* class_finalize */
            NULL,               /* class_data */
            sizeof(erGtkSelectionGroup),
            0,                  /* n_preallocs */
            (GInstanceInitFunc) ergtk_selection_group_init,
        };

        class_type = g_type_register_static(GTK_TYPE_EVENT_BOX, "erGtkSelectionGroup", &class_info, 0);
    }
    return class_type;
}

Here is the call graph for this function:

GtkWidget* ergtk_selection_group_new

(

GtkToggleButton **

button_tbl

)

create a new erGtkSelectionGroup object

Parameters:

button_tbl

- NULL-terminated array of ptrs to the buttons that must be controlled

Returns:

reference to created widget

Definition at line 76 of file erGtkSelectionGroup.c.

{
    GtkToggleButton** p_button;

    // check input
    for (p_button = button_tbl ; *p_button ; p_button++)
    {
        g_return_val_if_fail(GTK_IS_TOGGLE_BUTTON(*p_button), FALSE);
    }

    // create new object
    erGtkSelectionGroup* item = (erGtkSelectionGroup*) g_object_new(ERGTK_SELECTION_GROUP_TYPE, NULL);

    // add buttons to new object
    add_buttons(item, button_tbl);
    
    return GTK_WIDGET(item);
}

Here is the call graph for this function:

gboolean ergtk_selection_group_set_details	(	erGtkSelectionGroup *	item,
		const guint	min_selected,
		const guint	max_selected
	)

set selection details for the buttons controlled by the erGtkSelectionGroup object

Parameters:

	item	- the erGtkSelectionGroup object
	min_selected	- the minimum number of buttons that must be selected
	max_selected	- the maximum number of buttons that must be selected
	enforce_min	- enforce that at least min_selected buttons are selected
	enforce_max	- enforce that at most max_selected buttons are selected

Returns:

TRUE ok, FALSE error

Definition at line 238 of file erGtkSelectionGroup.c.

{
    LOGPRINTF("entry: item [%p] min [%u] max [%u]", item, min_selected, max_selected);
    g_return_val_if_fail(ERGTK_IS_SELECTION_GROUP(item),   FALSE);
    g_return_val_if_fail((item->dispose_has_run == FALSE), FALSE);

    erGtkSelectionGroupClass* klass = ERGTK_SELECTION_GROUP_GET_CLASS(item);

    // chain to real method, which may be overloaded
    if (klass->set_details)
    {
        return klass->set_details(item, min_selected, max_selected);
    }
    else
    {
        return FALSE;  // not ok
    }
}