irreco/src/core/irreco_listbox.c

   1 /*
   2  * irreco - Ir Remote Control
   3  * Copyright (C) 2007  Arto Karppinen (arto.karppinen@iki.fi)
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #include "irreco_listbox.h"
  21
  22 /**
  23  * @addtogroup IrrecoListbox
  24  * @ingroup Irreco
  25  *
  26  * A base class for Irreco listbox classes.
  27  *
  28  * The basic structure is to have a GtkTreview widget inside a
  29  * GtkScrolledWindow, and provide convenience frappers for so you dont have
  30  * to deal with GtkTreview directly.
  31  *
  32  * That is, IrrecoListbox classes provide a simple listboxes, without all
  33  * that tree nonsense.
  34  *
  35  * Subclasses must set these variables, or this class will not work:
  36  *      IRRECO_LISTBOX(self)->list_store
  37  *      IRRECO_LISTBOX(self)->tree_view
  38  *      IRRECO_LISTBOX(self)->tree_selection
  39  *      IRRECO_LISTBOX(self)->data_col_id
  40  *      IRRECO_LISTBOX(self)->text_col_id
  41  *
  42  * @{ @file
  43  * Source file of @ref IrrecoListbox.
  44  */
  45
  46
  47
  48 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  49 /* Prototypes.                                                                */
  50 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  51 #if 0
  52 static void irreco_listbox_scrolled_size_request(GtkWidget *widget,
  53                                                  GtkRequisition *requisition,
  54                                                  IrrecoListbox *self);
  55 #endif
  56
  57
  58 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  59 /* Construction & Destruction                                                 */
  60 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  61
  62 /**
  63  * @name Construction & Destruction
  64  * @{
  65  */
  66
  67 G_DEFINE_TYPE(IrrecoListbox, irreco_listbox, GTK_TYPE_HBOX)
  68
  69 static void irreco_listbox_class_init(IrrecoListboxClass *klass)
  70 {
  71 }
  72
  73 static void irreco_listbox_init(IrrecoListbox *self)
  74 {
  75         IRRECO_ENTER
  76
  77         self->select_new_rows = TRUE;
  78         gtk_box_set_spacing(GTK_BOX(self), 1);
  79 #if 0
  80         /* Connect signals. */
  81         g_signal_connect(G_OBJECT(self), "size-request",
  82                          G_CALLBACK(irreco_listbox_scrolled_size_request),
  83                          self);
  84 #endif
  85         IRRECO_RETURN
  86 }
  87
  88 /** @} */
  89
  90
  91
  92 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  93 /* Public Functions                                                           */
  94 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  95
  96 /**
  97  * @name Public Functions
  98  * @{
  99  */
 100
 101 /**
 102  * Set if new rows added to the listbox will automatically be selected.
 103  */
 104 void irreco_listbox_set_select_new_rows(IrrecoListbox *self,
 105                                         gboolean select_new_rows)
 106 {
 107         IRRECO_ENTER
 108         self->select_new_rows = select_new_rows;
 109         IRRECO_RETURN
 110 }
 111
 112 void irreco_listbox_set_autosize(IrrecoListbox *self,
 113                                  gint min_width,
 114                                  gint max_width,
 115                                  gint min_height,
 116                                  gint max_height)
 117 {
 118         IRRECO_ENTER
 119         if ((self->min_width  = min_width)  < 0) self->min_width  = 0;
 120         if ((self->max_width  = max_width)  < 0) self->max_width  = 0;
 121         if ((self->min_height = min_height) < 0) self->min_height = 0;
 122         if ((self->max_height = max_height) < 0) self->max_height = 0;
 123         IRRECO_RETURN
 124 }
 125
 126 void irreco_listbox_clear(IrrecoListbox *self)
 127 {
 128         IRRECO_ENTER
 129         gtk_list_store_clear(self->list_store);
 130         IRRECO_RETURN
 131 }
 132
 133 /**
 134  * Get GtkTreeIter for some index in the listbox.
 135  */
 136 gboolean irreco_listbox_get_iter(IrrecoListbox *self,
 137                                  gint index, GtkTreeIter * iter)
 138 {
 139         gboolean rvalue;
 140         GtkTreeModel *model;
 141         GtkTreePath *path;
 142         IRRECO_ENTER
 143
 144         IRRECO_DEBUG("Index \"%i\".\n", index);
 145         model = gtk_tree_view_get_model(GTK_TREE_VIEW(
 146                                         self->tree_view));
 147         path = gtk_tree_path_new_from_indices(index, -1);
 148         rvalue = gtk_tree_model_get_iter(model, iter, path);
 149         gtk_tree_path_free(path);
 150         IRRECO_RETURN_INT(rvalue);
 151 }
 152
 153 /**
 154  * Select a row.
 155  */
 156 gboolean irreco_listbox_set_selection(IrrecoListbox *self, gint index)
 157 {
 158         GtkTreeIter iter;
 159         IRRECO_ENTER
 160
 161         IRRECO_DEBUG("Selecting row \"%i\".\n", index);
 162         if (irreco_listbox_get_iter(self, index, &iter)) {
 163                 gtk_tree_selection_select_iter(self->tree_selection, &iter);
 164                 IRRECO_RETURN_BOOL(TRUE);
 165         }
 166         IRRECO_RETURN_BOOL(FALSE);
 167 }
 168
 169 /**
 170  * Get currect selection of listbox.
 171  *
 172  * @par Example
 173  * @code
 174  * gint sel_index = -1;
 175  * gchar *sel_label = NULL;
 176  * gpointer sel_user_data = NULL;
 177  * irreco_listbox_get_selection(IRRECO_LISTBOX(listbox),
 178  *                              &sel_index, &sel_label, &sel_user_data);
 179  * @endcode
 180  */
 181 gboolean irreco_listbox_get_selection(IrrecoListbox  *self,
 182                                       gint           *index,
 183                                       gchar         **label,
 184                                       gpointer       *user_data)
 185 {
 186         gboolean          rvalue        = FALSE;
 187         GtkTreeIter       iter;
 188         GtkTreeModel     *model         = NULL;
 189         GtkTreePath      *path          = NULL;
 190         gint             *path_indices  = NULL;
 191         GtkTreeSelection *selection     = NULL;
 192         gint              sel_index     = -1;
 193         gchar            *sel_label     = NULL;
 194         gpointer          sel_user_data = NULL;
 195         IRRECO_ENTER
 196
 197         /* Get currect selection, if set. */
 198         selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(self->tree_view));
 199         if (gtk_tree_selection_get_selected(self->tree_selection,
 200                                             &model, &iter)) {
 201                 path = gtk_tree_model_get_path(model, &iter);
 202                 path_indices = gtk_tree_path_get_indices(path);
 203                 sel_index = path_indices[0];
 204                 gtk_tree_path_free(path);
 205                 gtk_tree_model_get(GTK_TREE_MODEL(model), &iter,
 206                                    self->text_col_id, &sel_label,
 207                                    self->data_col_id, &sel_user_data,
 208                                    -1);
 209                 rvalue = TRUE;
 210         }
 211
 212         IRRECO_DEBUG("Selection \"%i\" \"%s\" \"%p\"\n",
 213                      sel_index, sel_label, sel_user_data);
 214
 215         /* Store values to pointers. */
 216         if (index) *index = sel_index;
 217         if (user_data) *user_data = sel_user_data;
 218         if (label) {
 219                 *label = sel_label;
 220         } else {
 221                 g_free(label);
 222         }
 223
 224         IRRECO_RETURN_BOOL(rvalue);
 225 }
 226
 227 gint irreco_listbox_get_selection_index(IrrecoListbox *self)
 228 {
 229         gint sel_index = -1;
 230         IRRECO_ENTER;
 231
 232         irreco_listbox_get_selection(self, &sel_index, NULL, NULL);
 233         IRRECO_RETURN_INT(sel_index);
 234 }
 235
 236 gchar *irreco_listbox_get_selection_label(IrrecoListbox *self)
 237 {
 238         gchar *sel_label = NULL;
 239         IRRECO_ENTER;
 240
 241         irreco_listbox_get_selection(self, NULL, &sel_label, NULL);
 242         IRRECO_RETURN_STR(sel_label);
 243 }
 244
 245 gpointer irreco_listbox_get_selection_data(IrrecoListbox *self)
 246 {
 247         gpointer sel_user_data = NULL;
 248         IRRECO_ENTER;
 249
 250         irreco_listbox_get_selection(self, NULL, NULL, &sel_user_data);
 251         IRRECO_RETURN_PTR(sel_user_data);
 252 }
 253
 254 /**
 255  * Move the currently selected row upwards.
 256  */
 257 gboolean irreco_listbox_move_selected_up(IrrecoListbox *self)
 258 {
 259         gint sel_index;
 260         IRRECO_ENTER
 261
 262         sel_index = irreco_listbox_get_selection_index(self);
 263         if (sel_index == -1) IRRECO_RETURN_BOOL(FALSE);
 264         IRRECO_RETURN_BOOL(irreco_listbox_move(
 265                 self, sel_index, sel_index - 1));
 266 }
 267
 268 /**
 269  * Move the currently selected row downwards.
 270  */
 271 gboolean irreco_listbox_move_selected_down(IrrecoListbox *self)
 272 {
 273         gint sel_index;
 274         IRRECO_ENTER
 275
 276         sel_index = irreco_listbox_get_selection_index(self);
 277         if (sel_index == -1) IRRECO_RETURN_BOOL(FALSE);
 278         IRRECO_RETURN_BOOL(irreco_listbox_move(
 279                 self, sel_index, sel_index + 1));
 280 }
 281
 282 gboolean irreco_listbox_move(IrrecoListbox *self,
 283                              gint from_index,
 284                              gint to_index)
 285 {
 286         GtkTreeIter from_iter;
 287         GtkTreeIter to_iter;
 288         IRRECO_ENTER
 289
 290         /* Check indices. We assume that below zero means first,
 291            and above list lenght means last. */
 292         if (from_index < 0) {
 293                 from_index = 0;
 294         } else if (from_index > self->list_store->length) {
 295                 IRRECO_RETURN_BOOL(FALSE);
 296         }
 297
 298         if (to_index > self->list_store->length) {
 299                 to_index = self->list_store->length;
 300         } else if (to_index < 0) {
 301                 IRRECO_RETURN_BOOL(FALSE);
 302         }
 303
 304         IRRECO_DEBUG("Moving item from index \"%i\" to index \"%i\".\n",
 305                      from_index, to_index);
 306
 307         if (irreco_listbox_get_iter(self, from_index, &from_iter)
 308             && irreco_listbox_get_iter(self, to_index, &to_iter)) {
 309                 if (from_index > to_index) {
 310                         IRRECO_DEBUG("Moving up.\n");
 311                         gtk_list_store_move_before(self->list_store,
 312                                                    &from_iter, &to_iter);
 313                 } else {
 314                         IRRECO_DEBUG("Moving down.\n");
 315                         gtk_list_store_move_after(self->list_store,
 316                                                   &from_iter, &to_iter);
 317                 }
 318
 319                 /* Set selection to the moved row. */
 320                 if (gtk_tree_selection_iter_is_selected(
 321                         self->tree_selection, &from_iter)) {
 322                 } else {
 323                         gtk_tree_selection_select_iter(self->tree_selection,
 324                                                        &from_iter);
 325                 }
 326
 327                 IRRECO_RETURN_BOOL(TRUE);
 328         }
 329
 330         IRRECO_RETURN_BOOL(FALSE);
 331 }
 332
 333 gboolean irreco_listbox_remove_selected(IrrecoListbox *self)
 334 {
 335         gint index;
 336         GtkTreeIter iter;
 337         gint sel_index;
 338         IRRECO_ENTER
 339
 340         sel_index = irreco_listbox_get_selection_index(self);
 341         if ((index = sel_index) == -1
 342             || irreco_listbox_get_iter(self, index, &iter) == FALSE) {
 343                 IRRECO_RETURN_BOOL(FALSE);
 344         }
 345
 346         /* Attemt to select another row before we destroy the current one.
 347            This helps to prevent double selection changed events being sent,
 348            when the old row is destroyed (and thus unselected) and selecting
 349            another row afterwards. */
 350         irreco_listbox_set_selection(self, index - 1)
 351                 || irreco_listbox_set_selection(self, index + 1);
 352
 353         gtk_list_store_remove(self->list_store, &iter);
 354         IRRECO_RETURN_BOOL(TRUE);
 355 }
 356
 357 gboolean irreco_listbox_remove(IrrecoListbox *self, gint index)
 358 {
 359         GtkTreeIter iter;
 360         IRRECO_ENTER
 361
 362         if (irreco_listbox_get_iter(self, index, &iter) == FALSE) {
 363                 IRRECO_RETURN_BOOL(FALSE);
 364         }
 365         gtk_list_store_remove(self->list_store, &iter);
 366         IRRECO_RETURN_BOOL(TRUE);
 367 }
 368
 369 /** @} */
 370
 371
 372
 373 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
 374 /* Events and Callbacks                                                       */
 375 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
 376
 377 /**
 378  * @name Events and Callbacks
 379  * @{
 380  */
 381 #if 0
 382 static void irreco_listbox_scrolled_size_request(GtkWidget *widget,
 383                                                  GtkRequisition *requisition,
 384                                                  IrrecoListbox *self)
 385 {
 386         IRRECO_ENTER
 387
 388         if (requisition->width < self->min_width) {
 389                 requisition->width = self->min_width;
 390         } else if (requisition->width > self->max_width) {
 391                 requisition->width = self->max_width;
 392         }
 393
 394         if (requisition->height < self->min_height) {
 395                 requisition->height = self->min_height;
 396         } else if (requisition->height > self->max_height) {
 397                 requisition->height = self->max_height;
 398         }
 399
 400         IRRECO_RETURN
 401 }
 402 #endif
 403 /** @} */
 404
 405 /** @} */
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417