[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-core-devel
Subject:    Review Request: Add new KDate class to simplify date localization
From:       "John Layt" <johnlayt () googlemail ! com>
Date:       2010-10-25 20:54:09
Message-ID: 20101025205409.3065.52001 () vidsolbach ! de
[Download RAW message or body]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://svn.reviewboard.kde.org/r/5692/
-----------------------------------------------------------

Review request for kdelibs.


Summary
-------

The KCalendarSystem api for localizing dates is awkward, inconvenient, unintuitive, \
and long-winded, causing many mistakes to be made or localization to be ignored \
altogether.  This change adds a new KDate class designed to make localizing dates as \
easy as using QDate.

Some QDate code may look like:

    QDate myDate( aYear, aMonth, aDay );
    int doy = myDate.dayOfYear();

The KDE localized date code looks something like:

    QDate myDate;
    KGlobal::locale()->calendar()->setDate( myDate, aYear, aMonth, aDay );
    int doy = KGlobal::locale()->calendar()->dayOfYear( myDate );

The localized KDate code would look like:

    KDate myDate( aYear, aMonth, aDay );
    int doy = myDate.dayOfYear();

Much easier.

KDate is a thin wrapper around KCalendarSystem and QDate, with a near identical api \
to QDate and as such can be used as a drop-in replacement with very few changes.  \
Some deprecated or unnecessary KCalendarSystem methods have not been included, but \
these can still be accessed via the calendar() methods.  Some new convenience methods \
have also been added such as setCurrentDate() and addYearsOn().

Some methods have QDate overloads for convenience, and the assignment and comparison \
operators partially work with QDate on the rhs.  If anyone knows how to make it work \
with QDate on the lhs, or any other QDate compatibility ideas, I'm all ears.

For now I only intend this to be used as a convenience class by apps internally and \
not to be used in kdelibs api as I don't see much advantage in that, but I may do so \
if the demand for convenience is there.

I have named it KDate, but there is the possibility people may get confused and think \
that KDateTime also localizes datetime's, but that is not the case.  If people think \
this will be a problem KLocalizedDate is an alternative if more awkward name.


Diffs
-----

  /trunk/KDE/kdelibs/kdecore/CMakeLists.txt 1189756 
  /trunk/KDE/kdelibs/kdecore/date/kdate.h PRE-CREATION 
  /trunk/KDE/kdelibs/kdecore/date/kdate.cpp PRE-CREATION 
  /trunk/KDE/kdelibs/kdecore/tests/kcalendartest.h 1189756 
  /trunk/KDE/kdelibs/kdecore/tests/kcalendartest.cpp 1189756 

Diff: http://svn.reviewboard.kde.org/r/5692/diff


Testing
-------

Full unit tests included.


Thanks,

John


[Attachment #3 (text/html)]

<html>
 <body>
  <div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
   <table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 \
solid;">  <tr>
     <td>
      This is an automatically generated e-mail. To reply, visit:
      <a href="http://svn.reviewboard.kde.org/r/5692/">http://svn.reviewboard.kde.org/r/5692/</a>
  </td>
    </tr>
   </table>
   <br />


<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('http://svn.reviewboard.kde.orgrb/images/review_request_box_top_bg.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;">  <tr>
  <td>

<div>Review request for kdelibs.</div>
<div>By John Layt.</div>





<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">The KCalendarSystem api for localizing dates is awkward, inconvenient, \
unintuitive, and long-winded, causing many mistakes to be made or localization to be \
ignored altogether.  This change adds a new KDate class designed to make localizing \
dates as easy as using QDate.

Some QDate code may look like:

    QDate myDate( aYear, aMonth, aDay );
    int doy = myDate.dayOfYear();

The KDE localized date code looks something like:

    QDate myDate;
    KGlobal::locale()-&gt;calendar()-&gt;setDate( myDate, aYear, aMonth, aDay );
    int doy = KGlobal::locale()-&gt;calendar()-&gt;dayOfYear( myDate );

The localized KDate code would look like:

    KDate myDate( aYear, aMonth, aDay );
    int doy = myDate.dayOfYear();

Much easier.

KDate is a thin wrapper around KCalendarSystem and QDate, with a near identical api \
to QDate and as such can be used as a drop-in replacement with very few changes.  \
Some deprecated or unnecessary KCalendarSystem methods have not been included, but \
these can still be accessed via the calendar() methods.  Some new convenience methods \
have also been added such as setCurrentDate() and addYearsOn().

Some methods have QDate overloads for convenience, and the assignment and comparison \
operators partially work with QDate on the rhs.  If anyone knows how to make it work \
with QDate on the lhs, or any other QDate compatibility ideas, I&#39;m all ears.

For now I only intend this to be used as a convenience class by apps internally and \
not to be used in kdelibs api as I don&#39;t see much advantage in that, but I may do \
so if the demand for convenience is there.

I have named it KDate, but there is the possibility people may get confused and think \
that KDateTime also localizes datetime&#39;s, but that is not the case.  If people \
think this will be a problem KLocalizedDate is an alternative if more awkward \
name.</pre>  </td>
 </tr>
</table>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">Full unit tests included.</pre>  </td>
 </tr>
</table>




<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">

 <li>/trunk/KDE/kdelibs/kdecore/CMakeLists.txt <span style="color: \
grey">(1189756)</span></li>

 <li>/trunk/KDE/kdelibs/kdecore/date/kdate.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>/trunk/KDE/kdelibs/kdecore/date/kdate.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>/trunk/KDE/kdelibs/kdecore/tests/kcalendartest.h <span style="color: \
grey">(1189756)</span></li>

 <li>/trunk/KDE/kdelibs/kdecore/tests/kcalendartest.cpp <span style="color: \
grey">(1189756)</span></li>

</ul>

<p><a href="http://svn.reviewboard.kde.org/r/5692/diff/" style="margin-left: \
3em;">View Diff</a></p>




  </td>
 </tr>
</table>




  </div>
 </body>
</html>



[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic