Review Request: Add new KDate class to simplify date localization

[John Layt]

> On 2010-10-26 13:35:22, David Jarvie wrote:
> > Looks a good piece of work. I have only had time so far to look at the header file.
> > 
> > The main issue is that it needs a class level comment to explain what the class is for. One extra item which the class comment could have would be an explanation of how QDate relates to a KDate using the Gregorian calendar and western locales.
> > 
> > I'm also concerned about the handling of weeks - is the ISO week the only week which exists, or do some calendar systems have alternatives? If so, some revamping might be needed.

Thanks David.  The apidox was largely a copy-and-paste from the old KCalendarSystem apidox which is not great in places.  I'm in the process of re-writing it all to a higher standard, I'm just posting some interim replies as it's taking a while :-)

Good point on the week numbers, I do plan to implement support for other week numbering systems (US for example), so I might as well get the api for it right now.  I think people should be able to cope with the difference from QDate / KCalendarSystem functionality.

That's actually got me to thinking, while I've tried to be consistent with the QDate/KCalendarSystem api, perhaps it would be better to fix a couple of other bad bits of api I inherited?


> On 2010-10-26 13:35:22, David Jarvie wrote:
> > /trunk/KDE/kdelibs/kdecore/date/kdate.h, line 307
> > <http://svn.reviewboard.kde.org/r/5692/diff/1/?file=40246#file40246line307>
> >
> >     I wonder about the method name. Possibly addYearsTo() instead? Similarly for addMonthsOn() and addDaysOn().

Done.


- John


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


On 2010-10-25 20:54:08, John Layt wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://svn.reviewboard.kde.org/r/5692/
> -----------------------------------------------------------
> 
> (Updated 2010-10-25 20:54:08)
> 
> 
> 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
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-core-devel/attachments/20101026/f23860a1/attachment.htm>