Changeset 2896

Show
Ignore:
Timestamp:
10/31/07 13:49:11
Author:
pvanhoof
Message:

2007-10-31 Philip Van Hoof <pvanhoof@gnome.org>

        • \NoSelect? folders should never get a STATUS request, fixed
        • Documentation clarification about priority and flags
        • Renamed tny_header_set_flags to set_flag, same for unset
        • This was a major API change
Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/ChangeLog

    r2895 r2896  
    33        * \NoSelect folders should never get a STATUS request, fixed 
    44        * Documentation clarification about priority and flags 
     5        * Renamed tny_header_set_flags to set_flag, same for unset 
     6 
     7        * This was a major API change 
    58 
    692007-10-30  Philip Van Hoof  <pvanhoof@gnome.org> 
  • trunk/libtinymail-camel/tny-camel-full-msg-receive-strategy.c

    r2825 r2896  
    103103                        _tny_camel_mime_part_set_part (TNY_CAMEL_MIME_PART (message),  
    104104                                                CAMEL_MIME_PART (camel_message));  
    105                         tny_header_set_flags (nheader, TNY_HEADER_FLAG_CACHED); 
    106                         tny_header_unset_flags (nheader, TNY_HEADER_FLAG_PARTIAL); 
     105                        tny_header_set_flag (nheader, TNY_HEADER_FLAG_CACHED); 
     106                        tny_header_unset_flag (nheader, TNY_HEADER_FLAG_PARTIAL); 
    107107                        g_object_unref (nheader); 
    108                         tny_header_set_flags (header, TNY_HEADER_FLAG_CACHED); 
    109                         tny_header_unset_flags (header, TNY_HEADER_FLAG_PARTIAL); 
     108                        tny_header_set_flag (header, TNY_HEADER_FLAG_CACHED); 
     109                        tny_header_unset_flag (header, TNY_HEADER_FLAG_PARTIAL); 
    110110                } 
    111111        } 
  • trunk/libtinymail-camel/tny-camel-header.c

    r2871 r2896  
    155155 
    156156static void 
    157 tny_camel_header_set_flags (TnyHeader *self, TnyHeaderFlags mask) 
     157tny_camel_header_set_flag (TnyHeader *self, TnyHeaderFlags mask) 
    158158{ 
    159159        TnyCamelHeader *me = TNY_CAMEL_HEADER (self); 
     
    185185 
    186186static void 
    187 tny_camel_header_unset_flags (TnyHeader *self, TnyHeaderFlags mask) 
     187tny_camel_header_unset_flag (TnyHeader *self, TnyHeaderFlags mask) 
    188188{ 
    189189        TnyCamelHeader *me = TNY_CAMEL_HEADER (self); 
     
    373373        klass->set_subject_func = tny_camel_header_set_subject; 
    374374        klass->set_replyto_func = tny_camel_header_set_replyto; 
    375         klass->set_flags_func = tny_camel_header_set_flags
    376         klass->unset_flags_func = tny_camel_header_unset_flags
     375        klass->set_flag_func = tny_camel_header_set_flag
     376        klass->unset_flag_func = tny_camel_header_unset_flag
    377377        klass->get_flags_func = tny_camel_header_get_flags; 
    378378 
  • trunk/libtinymail-camel/tny-camel-msg-header.c

    r2888 r2896  
    241241 
    242242static void 
    243 tny_camel_msg_header_set_flags (TnyHeader *self, TnyHeaderFlags mask) 
     243tny_camel_msg_header_set_flag (TnyHeader *self, TnyHeaderFlags mask) 
    244244{ 
    245245        TnyCamelMsgHeader *me = TNY_CAMEL_MSG_HEADER (self); 
    246246 
    247247        if (me->decorated) { 
    248                 tny_header_set_flags (me->decorated, mask); 
     248                tny_header_set_flag (me->decorated, mask); 
    249249        } 
    250250 
     
    272272 
    273273static void 
    274 tny_camel_msg_header_unset_flags (TnyHeader *self, TnyHeaderFlags mask) 
     274tny_camel_msg_header_unset_flag (TnyHeader *self, TnyHeaderFlags mask) 
    275275{ 
    276276        TnyCamelMsgHeader *me = TNY_CAMEL_MSG_HEADER (self); 
    277277 
    278278        if (me->decorated) { 
    279                 tny_header_set_flags (me->decorated, mask); 
     279                tny_header_set_flag (me->decorated, mask); 
    280280        } 
    281281 
     
    514514        klass->set_subject_func = tny_camel_msg_header_set_subject; 
    515515        klass->set_replyto_func = tny_camel_msg_header_set_replyto; 
    516         klass->set_flags_func = tny_camel_msg_header_set_flags
    517         klass->unset_flags_func = tny_camel_msg_header_unset_flags
     516        klass->set_flag_func = tny_camel_msg_header_set_flag
     517        klass->unset_flag_func = tny_camel_msg_header_unset_flag
    518518        klass->get_flags_func = tny_camel_msg_header_get_flags; 
    519519 
  • trunk/libtinymail-camel/tny-camel-msg.c

    r2825 r2896  
    269269                        TNY_CAMEL_FOLDER (priv->folder), 
    270270                        tny_header_get_uid (priv->header)); 
    271                 /* tny_header_set_flags (priv->header, TNY_HEADER_FLAG_PARTIAL); */ 
     271                /* tny_header_set_flag (priv->header, TNY_HEADER_FLAG_PARTIAL); */ 
    272272        } 
    273273} 
  • trunk/libtinymail-camel/tny-camel-partial-msg-receive-strategy.c

    r2825 r2896  
    103103                        _tny_camel_mime_part_set_part (TNY_CAMEL_MIME_PART (message),  
    104104                                                CAMEL_MIME_PART (camel_message));  
    105                         tny_header_set_flags (nheader, TNY_HEADER_FLAG_CACHED); 
    106                         tny_header_set_flags (nheader, TNY_HEADER_FLAG_PARTIAL); 
     105                        tny_header_set_flag (nheader, TNY_HEADER_FLAG_CACHED); 
     106                        tny_header_set_flag (nheader, TNY_HEADER_FLAG_PARTIAL); 
    107107                        g_object_unref (nheader); 
    108                         tny_header_set_flags (header, TNY_HEADER_FLAG_CACHED); 
    109                         tny_header_set_flags (header, TNY_HEADER_FLAG_PARTIAL); 
     108                        tny_header_set_flag (header, TNY_HEADER_FLAG_CACHED); 
     109                        tny_header_set_flag (header, TNY_HEADER_FLAG_PARTIAL); 
    110110                } 
    111111        } 
  • trunk/libtinymail-test/tny-header-test.c

    r2224 r2896  
    147147        TnyHeaderFlags flags; 
    148148 
    149         tny_header_set_flags (iface, TNY_HEADER_FLAG_HIGH_PRIORITY); 
    150         flags = tny_header_get_flags (iface); 
     149        tny_header_set_priority (iface, TNY_HEADER_FLAG_HIGH_PRIORITY); 
     150        flags = tny_header_get_priority (iface); 
    151151        fail_unless (flags == TNY_HEADER_FLAG_HIGH_PRIORITY, "Unable to set high priority.\n"); 
    152152 
    153         tny_header_unset_flags (iface, TNY_HEADER_FLAG_PRIORITY); 
    154         flags = tny_header_get_flags (iface); 
    155         fail_unless (flags == 0, "Unable to unset priority"); 
    156  
    157         tny_header_set_flags (iface, TNY_HEADER_FLAG_LOW_PRIORITY); 
    158         flags = tny_header_get_flags (iface); 
     153        tny_header_set_priority (iface, TNY_HEADER_FLAG_NORMAL_PRIORITY); 
     154        flags = tny_header_get_priority (iface); 
     155        fail_unless (flags == TNY_HEADER_FLAG_NORMAL_PRIORITY, "Unable to set normal priority.\n"); 
     156 
     157        tny_header_set_priority (iface, TNY_HEADER_FLAG_LOW_PRIORITY); 
     158        flags = tny_header_get_priority (iface); 
    159159        fail_unless (flags == TNY_HEADER_FLAG_LOW_PRIORITY, "Unable to set low priority.\n"); 
    160160 
  • trunk/libtinymail/tny-header.c

    r2895 r2896  
    470470 
    471471/** 
    472  * tny_header_set_flags
    473  * @self: a #TnyHeader object 
    474  * @mask: A #TnyHeaderFlags bitmask of flags to set. 
    475  *  
    476  * Modify message flags. Modifying the TNY_HEADER_FLAG_SEEN will trigger the  
     472 * tny_header_set_flag
     473 * @self: a #TnyHeader object 
     474 * @mask: A #TnyHeaderFlags bitmask flag to set. 
     475 *  
     476 * Modify message flag @mask. Modifying the TNY_HEADER_FLAG_SEEN will trigger the  
    477477 * notification of folder observers if @self was originated from a folder. 
    478478 * 
    479  * No not use this method to set priority settings. Use tny_header_set_priority 
    480  * in stead. 
     479 * Do not use this method to set priority settings. Use tny_header_set_priority 
     480 * in stead. Don't set more than one flag. Use the labels of the TnyHeaderFlags 
     481 * as an enum. 
    481482 **/ 
    482483void  
    483 tny_header_set_flags (TnyHeader *self, TnyHeaderFlags mask) 
    484 { 
    485 #ifdef DBC /* require */ 
    486         g_assert (TNY_IS_HEADER (self)); 
    487         g_assert (TNY_HEADER_GET_IFACE (self)->set_flags_func != NULL); 
    488 #endif 
    489  
    490         TNY_HEADER_GET_IFACE (self)->set_flags_func (self, mask); 
     484tny_header_set_flag (TnyHeader *self, TnyHeaderFlags mask) 
     485{ 
     486#ifdef DBC /* require */ 
     487        g_assert (TNY_IS_HEADER (self)); 
     488        g_assert (TNY_HEADER_GET_IFACE (self)->set_flag_func != NULL); 
     489#endif 
     490 
     491        TNY_HEADER_GET_IFACE (self)->set_flag_func (self, mask); 
    491492 
    492493#ifdef DBC /* ensure */ 
     
    518519 * @priority: A priority setting (high, low or normal) 
    519520 *  
    520  * Set the priority of the message. 
     521 * Set the priority of the message. To unset the priority, you can use  
     522 * TNY_HEADER_FLAG_NORMAL_PRIORITY as @priority. Don't combine @priority with 
     523 * other flags. Use additional tny_header_set_flag calls if you want to do  
     524 * that. 
    521525 **/ 
    522526void 
     
    525529        TnyHeaderFlags flags; 
    526530        g_return_if_fail  (priority & TNY_HEADER_FLAG_PRIORITY_MASK != priority); 
     531 
     532        /* Is this necessary? */ 
    527533        flags = tny_header_get_flags (self); 
    528534        flags &= ~TNY_HEADER_FLAG_PRIORITY_MASK; 
    529535        flags |= priority; 
    530         tny_header_set_flags (self, flags); 
    531         return; 
    532 
    533  
    534 /** 
    535  * tny_header_unset_flags: 
    536  * @self: a #TnyHeader object 
    537  * @mask: A #TnyHeaderFlags bitmask of flags to clear. 
    538  *  
    539  * Reset message flags. Modifying the TNY_HEADER_FLAG_SEEN will trigger the  
     536        /* -- */ 
     537 
     538        tny_header_set_flag (self, flags); 
     539        return; 
     540
     541 
     542/** 
     543 * tny_header_unset_flag: 
     544 * @self: a #TnyHeader object 
     545 * @mask: A #TnyHeaderFlags flag to clear. 
     546 *  
     547 * Reset message flag @mask. Modifying the TNY_HEADER_FLAG_SEEN will trigger the  
    540548 * notification of folder observers if @self was originated from a folder. 
    541549 *  
     550 * Don't attempt to unset the priority. Use tny_header_set_priority (header,  
     551 * TNY_HEADER_FLAG_NORMAL_PRIORITY) to set the priority of a message to normal  
     552 * (which is the same as unsetting it). Don't unset multiple flags. 
    542553 **/ 
    543554void  
    544 tny_header_unset_flags (TnyHeader *self, TnyHeaderFlags mask) 
    545 { 
    546 #ifdef DBC /* require */ 
    547         g_assert (TNY_IS_HEADER (self)); 
    548         g_assert (TNY_HEADER_GET_IFACE (self)->unset_flags_func != NULL); 
    549 #endif 
    550  
    551         TNY_HEADER_GET_IFACE (self)->unset_flags_func (self, mask); 
     555tny_header_unset_flag (TnyHeader *self, TnyHeaderFlags mask) 
     556{ 
     557#ifdef DBC /* require */ 
     558        g_assert (TNY_IS_HEADER (self)); 
     559        g_assert (TNY_HEADER_GET_IFACE (self)->unset_flag_func != NULL); 
     560#endif 
     561 
     562        TNY_HEADER_GET_IFACE (self)->unset_flag_func (self, mask); 
    552563 
    553564#ifdef DBC /* ensure */ 
  • trunk/libtinymail/tny-header.h

    r2882 r2896  
    9797        TnyFolder* (*get_folder_func) (TnyHeader *self); 
    9898        TnyHeaderFlags (*get_flags_func) (TnyHeader *self); 
    99         void (*set_flags_func) (TnyHeader *self, TnyHeaderFlags mask); 
    100         void (*unset_flags_func) (TnyHeader *self, TnyHeaderFlags mask); 
     99        void (*set_flag_func) (TnyHeader *self, TnyHeaderFlags mask); 
     100        void (*unset_flag_func) (TnyHeader *self, TnyHeaderFlags mask); 
    101101}; 
    102102 
     
    123123TnyFolder* tny_header_get_folder (TnyHeader *self); 
    124124TnyHeaderFlags tny_header_get_flags (TnyHeader *self); 
    125 void tny_header_set_flags (TnyHeader *self, TnyHeaderFlags mask); 
    126 void tny_header_unset_flags (TnyHeader *self, TnyHeaderFlags mask); 
     125void tny_header_set_flag (TnyHeader *self, TnyHeaderFlags mask); 
     126void tny_header_unset_flag (TnyHeader *self, TnyHeaderFlags mask); 
    127127 
    128128TnyHeaderFlags tny_header_get_priority (TnyHeader *self); 
  • trunk/tests/c-demo/tny-demoui-summary-view.c

    r2875 r2896  
    750750                TnyHeaderFlags flags = tny_header_get_flags (header); 
    751751                if (!(flags & TNY_HEADER_FLAG_SEEN)) 
    752                         tny_header_set_flags (header, TNY_HEADER_FLAG_SEEN); 
     752                        tny_header_set_flag (header, TNY_HEADER_FLAG_SEEN); 
    753753                tny_msg_view_set_msg (info->msg_view, msg); 
    754754        } else