include/gammu-category.h

   1 /**
   2  * \file gammu-category.h
   3  * \author Michal Čihař
   4  *
   5  * Categories handling.
   6  */
   7 #ifndef __gammu_category_h
   8 #define __gammu_category_h
   9
  10 /**
  11  * \defgroup Category Category
  12  * Categories handling.
  13  */
  14
  15 #include <gammu-limits.h>
  16 #include <gammu-error.h>
  17 #include <gammu-statemachine.h>
  18
  19 /**
  20  * Type of category
  21  *
  22  * \ingroup Category
  23  */
  24 typedef enum {
  25         /**
  26          * Todo entry category
  27          */
  28         Category_ToDo = 1,
  29         /**
  30          * Phonebook entry category
  31          */
  32         Category_Phonebook
  33 } GSM_CategoryType;
  34
  35 /**
  36  * Category entry.
  37  * \ingroup Category
  38  */
  39 typedef struct {
  40         /**
  41          * Type of category
  42          */
  43         GSM_CategoryType Type;
  44         /**
  45          * Location of category
  46          */
  47         int Location;
  48         /**
  49          * Name of category
  50          */
  51         unsigned char Name[(GSM_MAX_CATEGORY_NAME_LENGTH + 1) * 2];
  52 } GSM_Category;
  53
  54 /**
  55  * Status of categories.
  56  * \ingroup Category
  57  */
  58 typedef struct {
  59         /**
  60          * Type of category.
  61          */
  62         GSM_CategoryType Type;
  63         /**
  64          * Number of used category names.
  65          */
  66         int Used;
  67 } GSM_CategoryStatus;
  68
  69 /**
  70  * Reads category from phone.
  71  *
  72  * \param s State machine pointer.
  73  * \param Category Storage for category, containing its type and location.
  74  *
  75  * \return Error code
  76  *
  77  * \ingroup Category
  78  */
  79 GSM_Error GSM_GetCategory(GSM_StateMachine * s, GSM_Category * Category);
  80
  81 /**
  82  * Adds category to phone.
  83  *
  84  * \param s State machine pointer.
  85  * \param Category New category, containing its type and location.
  86  *
  87  * \return Error code
  88  *
  89  * \ingroup Category
  90  */
  91 GSM_Error GSM_AddCategory(GSM_StateMachine * s, GSM_Category * Category);
  92
  93 /**
  94  * Reads category status (number of used entries) from phone.
  95  *
  96  * \param s State machine pointer.
  97  * \param Status Category status, fill in type before calling.
  98  *
  99  * \return Error code
 100  *
 101  * \ingroup Category
 102  */
 103 GSM_Error GSM_GetCategoryStatus(GSM_StateMachine * s,
 104                                 GSM_CategoryStatus * Status);
 105 #endif
 106
 107 /* Editor configuration
 108  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 109  */