chiark - git - mdw - disorder/blob - lib/selection.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2006, 2007 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * 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
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20 /** @file lib/selection.h
  21  * @brief Select management for Disobedience
  22  */
  23
  24 #ifndef SELECTION_H
  25 #define SELECTION_H
  26
  27 #include "hash.h"
  28
  29 /* Represent a selection using a hash */
  30
  31 hash *selection_new(void);
  32
  33 void selection_set(hash *h, const char *key, int selected);
  34 /* Set the selection status of KEY */
  35
  36 void selection_flip(hash *h, const char *key);
  37 /* Flip the selection status of KEY */
  38
  39 int selection_selected(hash *h, const char *key);
  40 /* Test whether KEY is selected.  Always returns 0 or 1. */
  41
  42 void selection_live(hash *h, const char *key);
  43 /* Mark KEY as live.  Ignored if KEY is not selected. */
  44
  45 void selection_cleanup(hash *h);
  46 /* Discard dead items (and mark everything left as dead) */
  47
  48 void selection_empty(hash *h);
  49 /* Empty the selection */
  50
  51 #endif /* SELECTION_H */
  52
  53 /*
  54 Local Variables:
  55 c-basic-offset:2
  56 comment-column:40
  57 fill-column:79
  58 indent-tabs-mode:nil
  59 End:
  60 */