Changeset 3114


Ignore:
Timestamp:
10/08/07 13:33:03 (6 years ago)
Author:
thomas
Message:

Patch by: Emmanuele Bassi <ebassi@…>

  • doc/reference/Makefile.am:
  • doc/reference/libmokojournal-docs.sgml:
  • doc/reference/libmokojournal.types
  • doc/reference/libmokojournal-sections.txt
  • mokojournal/moko-journal.c:
  • mokojournal/moko-journal.h:

Generate a correct sections.txt file.

Fixed a couple of inconsistencies in the API.

Location:
trunk/src/target/OM-2007.2/libraries/libmokojournal2
Files:
2 added
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/target/OM-2007.2/libraries/libmokojournal2/ChangeLog

    r3083 r3114  
     12007-10-08  Thomas Wood  <thomas@openedhand.com> 
     2 
     3        Patch by: Emmanuele Bassi <ebassi@o-hand.com> 
     4 
     5        * doc/reference/Makefile.am: 
     6        * doc/reference/libmokojournal-docs.sgml: 
     7        * doc/reference/libmokojournal.types 
     8        * doc/reference/libmokojournal-sections.txt 
     9        * mokojournal/moko-journal.c: 
     10        * mokojournal/moko-journal.h: 
     11 
     12        Generate a correct sections.txt file. 
     13 
     14        Fixed a couple of inconsistencies in the API. 
     15 
    1162007-10-04  Thomas Wood  <thomas@openedhand.com> 
    217 

  • trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/Makefile.am

    r3079 r3114  
    4848# Header files to ignore when scanning. 
    4949# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h 
    50 IGNORE_HFILES= 
     50IGNORE_HFILES=moko-time-priv.h 
    5151 
    5252# Images to copy into HTML directory. 
    … …  
    7676# Other files to distribute 
    7777# e.g. EXTRA_DIST += version.xml.in 
    78 EXTRA_DIST = version.xml.in 
     78EXTRA_DIST += version.xml.in 
    7979 
    8080# Files not to distribute 

  • trunk/src/target/OM-2007.2/libraries/libmokojournal2/doc/reference/libmokojournal-docs.sgml

    r3079 r3114  
    1717    <title>libmokojournal2</title> 
    1818    <xi:include href="xml/moko-journal.xml"/> 
    19     <xi:include href="xml/moko-time-priv.xml"/> 
    2019    <xi:include href="xml/moko-time.xml"/> 
    2120  </chapter> 

  • trunk/src/target/OM-2007.2/libraries/libmokojournal2/mokojournal/moko-journal.c

    r3083 r3114  
    16251625 
    16261626/** 
    1627  * moko_journal_entry_set_type: 
     1627 * moko_journal_entry_set_entry_type: 
    16281628 * @entry: the current instance of journal entry 
    16291629 * @type: the new type 
    … …  
    16321632 */ 
    16331633void 
    1634 moko_journal_entry_set_type (MokoJournalEntry *a_entry, 
    1635                              MokoJournalEntryType a_type) 
     1634moko_journal_entry_set_entry_type (MokoJournalEntry *a_entry, 
     1635                                   MokoJournalEntryType a_type) 
    16361636{ 
    16371637  g_return_if_fail (a_entry) ; 

  • trunk/src/target/OM-2007.2/libraries/libmokojournal2/mokojournal/moko-journal.h

    r3083 r3114  
    4848 ***********************************************************/ 
    4949 
    50 typedef struct _MokoJournal MokoJournal ; 
    51 typedef struct _MokoJournalClass MokoJournalClass ; 
    52 typedef struct _MokoJournalEntry MokoJournalEntry ; 
     50typedef struct _MokoJournal             MokoJournal; 
     51typedef struct _MokoJournalClass        MokoJournalClass; 
     52 
     53typedef struct _MokoJournalEntry        MokoJournalEntry; 
     54 
     55typedef struct _MokoLocation            MokoLocation; 
     56typedef struct _MokoGSMLocation         MokoGSMLocation; 
    5357 
    5458struct _MokoJournal 
    5559{ 
    5660  GObject parent; 
    57 } ; 
     61}; 
    5862 
    5963struct _MokoJournalClass 
    … …  
    6165  GObjectClass parent_class; 
    6266 
    63   void (*entry_added)   (MokoJournal *journal, const MokoJournalEntry *entry) ; 
    64   void (*entry_removed) (MokoJournal *journal, const MokoJournalEntry *entry) ; 
     67  void (*entry_added)   (MokoJournal            *journal, 
     68                         const MokoJournalEntry *entry); 
     69  void (*entry_removed) (MokoJournal            *journal, 
     70                         const MokoJournalEntry *entry); 
    6571} ; 
    6672 
    6773/** 
    6874 * MokoJournalEntryType: 
    69  * 
    70  * this represents the primary type of a journal entry. 
     75 * @UNDEF_ENTRY: used internally 
     76 * @EMAIL_JOURNAL_ENTRY: E-mail 
     77 * @SMS_JOURNAL_ENTRY: SMS calls 
     78 * @VOICE_JOURNAL_ENTRY: voice calls 
     79 * @FAX_JOURNAL_ENTRY: fax calls 
     80 * @DATA_JOURNAL_ENTRY: data calls (like modules) 
     81 * @NB_OF_ENTRY_TYPES: terminator of entry types 
     82 * 
     83 * Reresents the primary type of a journal entry. 
    7184 */ 
    7285typedef enum { 
    73   UNDEF_ENTRY=0, 
     86  UNDEF_ENTRY, 
    7487  EMAIL_JOURNAL_ENTRY, 
    75   /*sms calls*/ 
    7688  SMS_JOURNAL_ENTRY, 
    77   /*voice calls*/ 
    7889  VOICE_JOURNAL_ENTRY, 
    79   /*fax call*/ 
    8090  FAX_JOURNAL_ENTRY, 
    81   /*data calls (like modems)*/ 
    8291  DATA_JOURNAL_ENTRY, 
    83   NB_OF_ENTRY_TYPES /*must always be the last*/ 
    84 } MokoJournalEntryType ; 
     92 
     93  NB_OF_ENTRY_TYPES 
     94} MokoJournalEntryType; 
    8595 
    8696typedef enum { 
    87   DIRECTION_IN=0, 
     97  DIRECTION_IN, 
    8898  DIRECTION_OUT 
    89 } MessageDirection ; 
    90  
    91 typedef struct 
    92 { 
    93   gfloat longitude ; 
    94   gfloat latitude ; 
    95 } MokoLocation ; 
    96  
    97 typedef struct 
    98 { 
    99   /*local area code*/ 
    100   gushort lac ; 
    101   /*cell id*/ 
    102   gushort cid ; 
    103 } MokoGSMLocation ; 
    104  
    105 /* The 'entry added' callback function */ 
    106  
    107  
    108 /*<journal management>*/ 
    109 MokoJournal* moko_journal_open_default () ; 
    110 void moko_journal_close (MokoJournal *journal) ; 
    111 gboolean moko_journal_add_entry (MokoJournal *journal, MokoJournalEntry *entry) ; 
    112 int moko_journal_get_nb_entries (MokoJournal *journal) ; 
    113 gboolean moko_journal_get_entry_at (MokoJournal *journal, 
    114                                     guint index, 
    115                                     MokoJournalEntry **entry) ; 
    116 gboolean moko_journal_remove_entry_at (MokoJournal *journal, 
    117                                        guint index) ; 
    118 gboolean moko_journal_remove_entry_by_uid (MokoJournal *journal, 
    119                                            const gchar* uid) ; 
    120 gboolean moko_journal_write_to_storage (MokoJournal *journal) ; 
    121 gboolean moko_journal_load_from_storage (MokoJournal *journal) ; 
    122  
    123 /*<journal entries querying>*/ 
    124 /*</journal entries querying>*/ 
    125  
    126 /*</journal management>*/ 
    127  
    128  
    129 /*<journal entries management>*/ 
    130 MokoJournalEntry* moko_journal_entry_new (MokoJournalEntryType type) ; 
    131 MokoJournalEntryType moko_journal_entry_get_entry_type (MokoJournalEntry *entry); 
    132 void moko_journal_entry_set_type (MokoJournalEntry *entry, 
    133                                   MokoJournalEntryType type) ; 
    134 const gchar* moko_journal_entry_get_uid (MokoJournalEntry *entry) ; 
    135 const gchar* moko_journal_entry_get_contact_uid (MokoJournalEntry *entry) ; 
    136 void  moko_journal_entry_set_contact_uid (MokoJournalEntry *entry, 
    137                                           const gchar *uid) ; 
    138 const gchar* moko_journal_entry_get_summary (MokoJournalEntry *entry) ; 
    139 void moko_journal_entry_set_summary (MokoJournalEntry *entry, 
    140                                      const gchar* summary) ; 
    141 gboolean moko_journal_entry_get_start_location (MokoJournalEntry *entry, 
    142                                                 MokoLocation *location) ; 
    143 gboolean moko_journal_entry_set_start_location (MokoJournalEntry *entry, 
    144                                                 MokoLocation *location) ; 
    145 gboolean moko_journal_entry_get_direction (MokoJournalEntry *entry, 
    146                                            MessageDirection *direction) ; 
    147 void moko_journal_entry_set_direction (MokoJournalEntry *entry, 
    148                                        MessageDirection direction) ; 
    149 const MokoTime* moko_journal_entry_get_dtstart (MokoJournalEntry *entry) ; 
    150 void moko_journal_entry_set_dtstart (MokoJournalEntry *entry, MokoTime* dtstart); 
    151 const gchar* moko_journal_entry_get_source (MokoJournalEntry *entry) ; 
    152 void moko_journal_entry_set_source (MokoJournalEntry *entry, 
    153                                     const gchar *source) ; 
    154 gboolean moko_journal_entry_info_set_gsm_location (MokoJournalEntry *entry, 
    155                                                    MokoGSMLocation *location) ; 
    156 gboolean moko_journal_entry_get_gsm_location (MokoJournalEntry *entry, 
    157                                               MokoGSMLocation *location); 
    158 gboolean moko_journal_entry_set_wifi_ap_mac_address (MokoJournalEntry *entry, 
    159                                                      const guchar *address) ; 
    160 const guchar *moko_journal_entry_get_wifi_ap_mac_address 
    161                                                   (MokoJournalEntry *entry) ; 
    162 /*<voice call info>*/ 
    163  
    164 gboolean moko_journal_entry_has_voice_info (MokoJournalEntry *entry); 
    165 void moko_journal_voice_info_set_distant_number (MokoJournalEntry *info, 
    166                                                 const gchar *number) ; 
    167 const gchar* moko_journal_voice_info_get_distant_number 
    168                                                 (MokoJournalEntry *info) ; 
    169 void moko_journal_voice_info_set_local_number (MokoJournalEntry *info, 
    170                                                 const gchar *number) ; 
    171 const gchar* moko_journal_voice_info_get_local_number 
    172                                                 (MokoJournalEntry *info) ; 
    173 void moko_journal_voice_info_set_was_missed (MokoJournalEntry *info, 
    174                                              gboolean a_flag) ; 
    175 gboolean moko_journal_voice_info_get_was_missed (MokoJournalEntry *info) ; 
    176  
    177 /*</voice call info>*/ 
    178  
    179 /*<fax call info>*/ 
    180  
    181 gboolean moko_journal_entry_has_fax_info (MokoJournalEntry *entry) ; 
    182  
    183 gboolean moko_journal_entry_has_data_info (MokoJournalEntry *entry) ; 
    184 /*</fax call info>*/ 
    185  
    186 /*<sms info>*/ 
    187 gboolean moko_journal_entry_has_sms_info (MokoJournalEntry *entry) ; 
    188 /*</sms info>*/ 
    189  
    190 /*<email info>*/ 
    191  
    192 gboolean moko_journal_entry_has_email_info (MokoJournalEntry *entry) ; 
    193  
    194 /*</email info>*/ 
    195  
    196  
    197 /*</journal entries management>*/ 
    198  
    199 /*<helpers for bindings>*/ 
    200 GType moko_journal_get_type (void) ; 
    201 GType moko_location_get_type (void) ; 
    202 GType moko_gsm_location_get_type (void) ; 
    203 GType moko_journal_entry_get_type (void) ; 
    204  
    205 MokoLocation* moko_location_copy (const MokoLocation*) ; 
    206 void          moko_location_free (MokoLocation*) ; 
    207  
    208 MokoGSMLocation* moko_gsm_location_copy (const MokoGSMLocation*); 
    209 void             moko_gsm_location_free (MokoGSMLocation*); 
    210  
    211 MokoJournalEntry* moko_journal_entry_ref (MokoJournalEntry*); 
    212 void              moko_journal_entry_unref (MokoJournalEntry*); 
    213  
    214 /*</helpers for bindings>*/ 
     99} MessageDirection; 
     100 
     101/** 
     102 * MokoLocation: 
     103 * @longitude: longitude of a journal entry 
     104 * @latitude: latitude of a journal entry 
     105 * 
     106 * Geographical location of a journal entry 
     107 */ 
     108struct _MokoLocation 
     109{ 
     110  gfloat longitude; 
     111  gfloat latitude; 
     112}; 
     113 
     114/** 
     115 * MokoGSMLocation: 
     116 * @lac: local area code 
     117 * @id: cell id 
     118 * 
     119 * GSM location of a journal entry 
     120 */ 
     121struct _MokoGSMLocation 
     122{ 
     123  gushort lac; 
     124  gushort cid; 
     125}; 
     126 
     127MokoJournal *moko_journal_open_default        (void); 
     128void         moko_journal_close               (MokoJournal       *journal); 
     129gboolean     moko_journal_add_entry           (MokoJournal       *journal, 
     130                                               MokoJournalEntry  *entry); 
     131gint         moko_journal_get_nb_entries      (MokoJournal       *journal) ; 
     132gboolean     moko_journal_get_entry_at        (MokoJournal       *journal, 
     133                                               guint              index_, 
     134                                               MokoJournalEntry **entry) ; 
     135gboolean     moko_journal_remove_entry_at     (MokoJournal       *journal, 
     136                                               guint              index_); 
     137gboolean     moko_journal_remove_entry_by_uid (MokoJournal       *journal, 
     138                                               const gchar       *uid); 
     139gboolean     moko_journal_write_to_storage    (MokoJournal       *journal); 
     140gboolean     moko_journal_load_from_storage   (MokoJournal       *journal); 
     141 
     142/* journal entries management */ 
     143MokoJournalEntry *    moko_journal_entry_new                     (MokoJournalEntryType  type); 
     144MokoJournalEntryType  moko_journal_entry_get_entry_type          (MokoJournalEntry     *entry); 
     145void                  moko_journal_entry_set_entry_type          (MokoJournalEntry     *entry, 
     146                                                                  MokoJournalEntryType  type); 
     147G_CONST_RETURN gchar *moko_journal_entry_get_uid                 (MokoJournalEntry     *entry); 
     148G_CONST_RETURN gchar *moko_journal_entry_get_contact_uid         (MokoJournalEntry     *entry); 
     149void                  moko_journal_entry_set_contact_uid         (MokoJournalEntry     *entry, 
     150                                                                  const gchar          *uid); 
     151G_CONST_RETURN gchar *moko_journal_entry_get_summary             (MokoJournalEntry     *entry); 
     152void                  moko_journal_entry_set_summary             (MokoJournalEntry     *entry, 
     153                                                                  const gchar          *summary); 
     154gboolean              moko_journal_entry_get_start_location      (MokoJournalEntry     *entry, 
     155                                                                  MokoLocation         *location); 
     156gboolean              moko_journal_entry_set_start_location      (MokoJournalEntry     *entry, 
     157                                                                  MokoLocation         *location); 
     158gboolean              moko_journal_entry_get_direction           (MokoJournalEntry     *entry, 
     159                                                                  MessageDirection     *direction); 
     160void                  moko_journal_entry_set_direction           (MokoJournalEntry     *entry, 
     161                                                                  MessageDirection      direction); 
     162const MokoTime *      moko_journal_entry_get_dtstart             (MokoJournalEntry     *entry); 
     163void                  moko_journal_entry_set_dtstart             (MokoJournalEntry     *entry, 
     164                                                                  MokoTime             *dtstart); 
     165G_CONST_RETURN gchar *moko_journal_entry_get_source              (MokoJournalEntry     *entry); 
     166void                  moko_journal_entry_set_source              (MokoJournalEntry     *entry, 
     167                                                                  const gchar          *source); 
     168gboolean              moko_journal_entry_set_gsm_location        (MokoJournalEntry     *entry, 
     169                                                                  MokoGSMLocation      *location); 
     170gboolean              moko_journal_entry_get_gsm_location        (MokoJournalEntry     *entry, 
     171                                                                  MokoGSMLocation      *location); 
     172gboolean              moko_journal_entry_set_wifi_ap_mac_address (MokoJournalEntry     *entry, 
     173                                                                  const guchar         *address); 
     174const guchar *        moko_journal_entry_get_wifi_ap_mac_address (MokoJournalEntry     *entry); 
     175 
     176/* voice call info */ 
     177gboolean              moko_journal_entry_has_voice_info          (MokoJournalEntry *entry); 
     178void                  moko_journal_voice_info_set_distant_number (MokoJournalEntry *info, 
     179                                                                  const gchar      *number); 
     180G_CONST_RETURN gchar *moko_journal_voice_info_get_distant_number (MokoJournalEntry *info); 
     181void                  moko_journal_voice_info_set_local_number   (MokoJournalEntry *info, 
     182                                                                  const gchar      *number); 
     183G_CONST_RETURN gchar *moko_journal_voice_info_get_local_number   (MokoJournalEntry *info); 
     184void                  moko_journal_voice_info_set_was_missed     (MokoJournalEntry *info, 
     185                                                                  gboolean          missing); 
     186gboolean              moko_journal_voice_info_get_was_missed     (MokoJournalEntry *info); 
     187 
     188/* fax call info */ 
     189gboolean moko_journal_entry_has_fax_info  (MokoJournalEntry *entry); 
     190gboolean moko_journal_entry_has_data_info (MokoJournalEntry *entry); 
     191 
     192/* sms info */ 
     193gboolean moko_journal_entry_has_sms_info (MokoJournalEntry *entry); 
     194 
     195/* email info */ 
     196gboolean moko_journal_entry_has_email_info (MokoJournalEntry *entry); 
     197 
     198/* helpers for bindings */ 
     199GType moko_journal_get_type (void) G_GNUC_CONST; 
     200GType moko_location_get_type (void) G_GNUC_CONST; 
     201GType moko_gsm_location_get_type (void) G_GNUC_CONST; 
     202GType moko_journal_entry_get_type (void) G_GNUC_CONST; 
     203 
     204MokoLocation* moko_location_copy (const MokoLocation *location); 
     205void          moko_location_free (MokoLocation       *location); 
     206 
     207MokoGSMLocation* moko_gsm_location_copy (const MokoGSMLocation *location); 
     208void             moko_gsm_location_free (MokoGSMLocation       *location); 
     209 
     210MokoJournalEntry* moko_journal_entry_ref   (MokoJournalEntry *entry); 
     211void              moko_journal_entry_unref (MokoJournalEntry *entry); 
    215212 
    216213G_END_DECLS 
Note: See TracChangeset for help on using the changeset viewer.