Update the API Documentation for DateFormat and TimeString utility classes

Add a Translator hint what M, D, Y mean

3 files changed, 263 insertions, 3 deletions

diff --git a/library/dummy_api_docu.cpp b/library/dummy_api_docu.cpp
index f2153df..97d28e8 100644
--- a/library/dummy_api_docu.cpp
+++ b/library/dummy_api_docu.cpp
@@ -274,96 +274,346 @@
 
 
 /**
  * \class StyleExtendedInterface
  * \brief The Plugin Interface for all Opie styles
  *
  * If you want to create a new QStyle for Opie use this class.
  *
  * key(ushort,ushort,ushort,bool,bool)
  */
 
 /*
  * Taskbar Applets
  */
 
 
 /**
  * \class TaskbarAppletInterface
  *
  * This is the base class of all Applets shown in the taskbar
  * An applets need to provide a position and a widget.
  *
  * Applets need to be put into OPIEDIR/plugins/applets
  *
  */
 /**
  * \fn QWidget* TaskbarAppletInterface::applet( QWidget* parent )
  * \brief return the new Applet Widget
  *
  * @param parent The parent of the Applet normally the taskbar
  */
 
 /**
  * \fn int TaskbarAppletInterface::position()const;
  * \brief the wished position
  *
  * From left to right. 0 is left. The clock uses 10
  */
 
 
 /**
  * \class WindowDecorationInterface
  *
  * Interface class for Window Decorations. Yu need to implement
  * metric and drawing functions.
  */
 
 /**
  * \class WindowDecorationInterface::WindowData
  *
  * Window informations like the QRect, Palette, Caption
  * and flag
  */
 
 /**
  * \fn int WindowDecorationInterface::metric(Metric m,const WindowData* )
  *
  * Return the width for the item out of Metric.
  * Normally you will case Metric and default: should call the interface
  * method. Also return 0
  */
 
 /**
  * \fn void WindowDecorationInterface::drawArea( Area a, QPainter* , const WindowData* )const
  *
  * draw the Area specefic in a to the QPainter
  */
 
 /**
  * \fn void WindowDecorationInterface::drawButton(Button b,QPainter*p ,const WindowData* d, int x, int y, int w,int h, QWSButton::State s)const
  *
  * @param b The Button to be drawn
  * @param p The painter to draw at
  * @param d The Window Data
  * @param x The X position of the button
  * @param y The Y position of the button
  * @param w The width of the button
  * @param h The height of the button
  * @param s The state of the button
  */
 
 /**
  * \fn QRegion WindowDecorationInterface::mask( const WindowData* )const
  *
  * The mask of the Decoration.
  *
  * \code
  *     int th = metric(TitleHeight,wd);
  *   QRect rect( wd->rect );
  *   QRect r(rect.left() - metric(LeftBorder,wd),
  *          rect.top() - th - metric(TopBorder,wd),
  *          rect.width() + metric(LeftBorder,wd) + metric(RightBorder,wd),
  *          rect.height() + th + metric(TopBorder,wd) + metric(BottomBorder,wd));
  *  return QRegion(r) - rect;
  * \endcode
  */
+
+
+/**
+ * \class DateFormat
+ * \brief The format a Date and Time is composed
+ *
+ * Define how a Date and Time should be composed
+ *
+ * @see TimeString
+ */
+
+/**
+ * \enum DateFormat::Order
+ * The order of the Day,Month and Year
+ */
+/**
+ * \val DateFormat::Order::DayMonthYear
+ * First the Day, then the Month and the Year
+ */
+
+/**
+ * \val DateFormat::Order::MonthDayYear
+ * First the Month then Day and Year followed
+ */
+/**
+ * \val DateFormat::Order::YearMonthDay
+ * Year Month and then the Day
+ */
+
+/**
+ * \fn QString DateFormat::toNumberString()const
+ *  Return the Order of Days as string (M/D/Y) in example
+ *  this string can be shown to the user.
+ *  It will extract three bits at a time and compose
+ *  a string
+ */
+
+/**
+ * \fn QString DateFormat::toWordString()const
+ *  Return the DateFormat as written words
+ *
+ */
+
+/**
+ * \fn DateFormat::DateFormat(QChar s,Order or)
+ * A Constructor.
+ * @param s The seperator for the short representation. As used by toNumberString
+ * @param or The order used for short and long dates
+ */
+
+/**
+ * \fn DateFormat::DateFormat(QChar s,Order so,Order lo)
+ *
+ * A different Constructor with different long and short representation
+ * @param s The seperator
+ * @param so The short order representation
+ * @param lo The long order representation
+ */
+
+
+/**
+ * \fn DateFormat::DateFormat(const DateFormat&)
+ * Copy c'tor
+ *
+ */
+
+/**
+ * \enum DateFormat::Verbosity
+ * The verbosity as used by DateFormat::numberDate() and DateFormat::wordDate()
+ *
+ * \enum val shortNumber Express the Year as 04
+ * \enum val longNumber Express the Year as 2004
+ * \enum val showWeekDay Use week day names
+ * \enum val longWord Use long word. If not set the week day will be stripped to the first three characters
+ *
+ *
+ * @see DateFormat::numberDate
+ * @see DateFormat::wordDate
+ */
+
+/**
+ * \fn QString DateFormat::numberDate(const QDate& d,int v)const
+ *
+ *  Compose the QDate to a QString using the shortOrder() and
+ *  the verbosity. The verbosity is only used to see if the
+ *  year should be four positions or two positions wide.
+ *
+ *  @param d The QDate to be expressed as string
+ *  @param v Only DateFormat::Verbosity::shortNumber or
+ *           DateFormat::Verbosity::longNumber is used.
+ *           Use this to say if the year should be two or four
+ *           positions wide
+ *
+ * @see DateFormat::wordDate()
+ */
+
+/**
+ * \fn  QString DateFormat::wordDate(const QDate& d,int v )const
+ * Compose the QDate to a QString using the longOrder() options.
+ * The difference to numberDate() is the length of the resulting
+ * string. Weekday- and Monthnames are expressed as words as opposed to digits.
+ *
+ *
+ * @param d The Date to be used
+ * @param v The verbosity
+ */
+
+/**
+ * \fn void DateFormat::load(QDataStream&)
+ * load from the QDateStream. And set the values
+ * internally
+ */
+
+/**
+ * \fn void DateFormat::save(QDateStream&)const
+ * save this DateFormat into the QDataStream
+ */
+
+/**
+ *\fn QChar DateFormat::seperator()const
+ * The seperator used for the numberString()
+ */
+/**
+ * \fn DateFormat::Order DateFormat::shortOrder()const
+ * Return the DateFormat::Order for the shortOrder which will be used by numberString
+ */
+/**
+ * \fn DateFormat::Order DateFormat::longOrder()const
+ * Return the DateFormat::Order for the longOrder which will be used by the wordString
+ */
+
+/**
+ * \class TimeString
+ * \brief A frontend  to DateFormat
+ *
+ * A utility class to use DateFormat more easily
+ * @todo For ODP add QDateTime and QTime  operations honoring system settings
+ */
+
+/**
+ * \fn QString TimeString::shortDate(const QDate& d)
+ * Call the overloaded function with currentDateFormat()
+ *
+ * @param d The QDate to be transformed
+ * @see TimeString::shortDate(const QDate& d,DateFormat)
+ */
+/**
+ * \fn QString TimeString::dateString(const QDate& d);
+ * This function calls the overloaded function with currentDateFormat()
+ *
+ * @param d The QDate to be used
+ * @see TimeString::dateString(const QDate& d,DateFormat);
+ */
+/**
+ * \fn QString TimeString::longDateString(const QDate& d);
+ *
+ * This functions calls the olverloaded function with currentDateFormat()
+ *
+ * @param d The QDate to be used
+ * @see TimeString::longDateString(const QDate& d,DateFormat);
+ */
+/**
+ * \fn QString TimeString::dateString(const QDateTime&,bool,bool);
+ * @internal
+ */
+/**
+ * \fn QString TimeString::dateString(const QDateTime& t,bool)
+ * Do not use they do not honor system wide AMPM settings.
+ * Also
+ *
+ * @see numberDateString
+ * @see longNumberDateString
+ */
+/**
+ * \fn QString TimeString::numberDateString(const QDate& d, DateFormat f )
+ *  Return the date as String in number coding (DD/MM/YY) depending on the
+ *  date format
+ *
+ * @param d The QDate to be used
+ * @param f The DateFormat to be used
+ */
+/**
+ * \fn QString TimeString::numberDateString(const QDate& d)
+ * This is an overloaded function and uses the currentDateFormat()
+ * of the system
+ *
+ * @see currentDateFormat()
+ * @param d The QDate to be used
+ */
+/**
+ * \fn QString TimeString::longNumberDateString(const QDate& d, DateFormat f )
+ *  Return the date as String in number coding (DD/MM/YYYY) depending on the
+ *  date format. This uses the DateFormat::longNumber verbosity on the DateFormat::numberDate
+ *  method
+ *
+ * @param d The QDate to be used
+ * @param f The DateFormat to be used
+ */
+/**
+ * \fn QString TimeString::longNumberDateString(const QDate& d)
+ * This is an overloaded function and uses the currentDateFormat()
+ * of the system.
+ *
+ *
+ * @see currentDateFormat()
+ * @see longNumberDateString(const QDate&,DateFormat)
+ * @param d The QDate to be used
+ */
+
+
+/**
+ * \fn QString TimeString::shortDate(const QDate& d,DateFormat f)
+ * Calls DateFormat::wordDate with d
+ *
+ * Example: '20 Feb 04'
+ *
+ *
+ *
+ * @param d The QDate used
+ * @param f DateFormat which will be used for composing
+ * @todo Make naming consistent with the two other functions calling wordDate
+ */
+
+/**
+ * \fn QString TimeString::dateString(const QDate& d,DateFormat f )
+ * Calls and translates DateFormat::wordDate with d and
+ * DateFormat::longNumber|DateFormat::longWord
+ * This means we will translate the month name and have a 4 digit year (2004)
+ *
+ * Example: '20 Feb 2004'
+ *
+ * @param d The QDate.
+ * @param f The DateFormat which will be called
+ */
+
+/**
+ * \fn QSrring TimeString::longDateString(const QDate& d, DateFormat f )
+ * Calls and translates DateFormat::wordDate with DateFormat::showWeekDay|DateFormat::longNumber|DateFormat::longWord.
+ * This means you will have a string with the week day name, monthname and a four digit year.
+ *
+ * Example: 'Fr, 20 Feb 2004'
+ *
+ * @param d The QDate
+ *
+ */
+
+/**
+ * \fn DateFormat currentDateFormat()
+ * Return the System DateFormat
+ */
diff --git a/library/timestring.cpp b/library/timestring.cpp
index 8f60b72..2fd0191 100644
--- a/library/timestring.cpp
+++ b/library/timestring.cpp
@@ -1,169 +1,169 @@
 /**********************************************************************
 ** Copyright (C) 2000-2002 Trolltech AS.  All rights reserved.
 **
 ** This file is part of the Qtopia Environment.
 **
 ** This file may be distributed and/or modified under the terms of the
 ** GNU General Public License version 2 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.GPL included in the
 ** packaging of this file.
 **
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
 ** See http://www.trolltech.com/gpl/ for GPL licensing information.
 **
 ** Contact info@trolltech.com if any conditions of this licensing are
 ** not clear to you.
 **
 **********************************************************************/
 
 #include "timestring.h"
 #include <qobject.h>
 #include <qpe/qpeapplication.h> //for qApp
 #include "config.h"
 
 
 class TimeStringFormatKeeper : public QObject
 {
     Q_OBJECT
 public:
     static DateFormat currentFormat()
     {
         if ( !self )
             self  = new TimeStringFormatKeeper;
         return self->format;
     }
 private slots:
     void formatChanged( DateFormat f )
     {
         format = f;
     }
 private:
     static TimeStringFormatKeeper *self;
     DateFormat format;
 
     TimeStringFormatKeeper()
         : QObject( qApp )
     {
         Config config("qpe");
         config.setGroup( "Date" );
         format = DateFormat(QChar(config.readEntry("Separator", "/")[0]),
                 (DateFormat::Order)config .readNumEntry("ShortOrder", DateFormat::DayMonthYear),
                 (DateFormat::Order)config.readNumEntry("LongOrder", DateFormat::DayMonthYear));
 
         connect( qApp, SIGNAL( dateFormatChanged(DateFormat) ),
                  this, SLOT( formatChanged( DateFormat ) ) );
     }
 };
 
 TimeStringFormatKeeper *TimeStringFormatKeeper::self = 0;
 
 QString DateFormat::toNumberString() const
 {
     QString buf = "";
     // for each part of the order
     for (int i = 0; i < 3; i++) {
         // switch on the relavent 3 bits.
         switch((_shortOrder >> (i * 3)) & 0x0007) {
             case 0x0001:
-                buf += QObject::tr( "D" );
+                buf += QObject::tr( "D" , "Shortcut for Day");
                 break;
             case 0x0002:
-                buf += QObject::tr( "M" );
+                buf += QObject::tr( "M", "Shortcur for Month" );
                 break;
             case 0x0004:
                 buf += QObject::tr( "Y" );
                 break;
         }
         if (i < 2)
             buf += _shortSeparator;
     }
     return buf;
 }
 
 QString DateFormat::toWordString() const
 {
     QString buf = "";
     // for each part of the order
     for (int i = 0; i < 3; i++) {
         // switch on the relavent 3 bits.
         switch((_longOrder >> (i * 3)) & 0x0007) {
             case 0x0001:
                 buf += QObject::tr( "day" );
                 if (i < 2) {
                     if ((_shortOrder << ((i+1) * 3)) & 0x0007)
                         buf += ", ";
                     else
                         buf += " ";
                 }
                 break;
             case 0x0002:
                 buf += QObject::tr( "month" );
                 if (i < 2)
                     buf += " ";
                 break;
             case 0x0004:
                 buf += QObject::tr( "year" );
                 if (i < 2)
                     buf += ", ";
                 break;
         }
     }
     return buf;
 }
 
 QString DateFormat::numberDate(const QDate &d, int v) const
 {
     QString buf = "";
 
     int pad = 2;
 
     // for each part of the order
     for (int i = 0; i < 3; i++) {
         // switch on the relavent 3 bits.
         switch((_shortOrder >> (i * 3)) & 0x0007) {
             case 0x0001:
               if (pad==2) buf += QString().sprintf("%02d",d.day());
               else buf += QString().sprintf("%d",d.day());
                 break;
             case 0x0002:
               if (i==0) { // no padding with only MM/DD/YY format
                 pad=0;
               }
               if (pad==2) buf += QString().sprintf("%02d",d.month());
               else buf += QString().sprintf("%d",d.month());
                 break;
             case 0x0004:
                 {
                     int year = d.year();
                     if (!(v & longNumber))
                         year = year % 100;
                     buf += QString().sprintf("%02d",year);
                 }
                 break;
         }
         if (i < 2)
             buf += _shortSeparator;
     }
     return buf;
 }
 
 QString DateFormat::wordDate(const QDate &d, int v) const
 {
     QString buf = "";
     // for each part of the order
     if (v & showWeekDay) {
         QString weekDay = d.dayName(d.dayOfWeek());
         if (!(v & longWord)) {
             weekDay = weekDay.left(3);
         }
         buf += weekDay;
         if ((_longOrder & 0x0007) == 0x0002)
             buf += ' ';
         else
             buf += ", ";
     }
 
     for (int i = 0; i < 3; i++) {
         // switch on the relavent 3 bits.
diff --git a/library/timestring.h b/library/timestring.h
index 0335715..875c8bf 100644
--- a/library/timestring.h
+++ b/library/timestring.h
@@ -9,132 +9,142 @@
 ** packaging of this file.
 **
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
 ** See http://www.trolltech.com/gpl/ for GPL licensing information.
 **
 ** Contact info@trolltech.com if any conditions of this licensing are
 ** not clear to you.
 **
 **********************************************************************/
 
 #ifndef _TIMESTRING_H_
 #define _TIMESTRING_H_
 #include <qdatetime.h>
 #include <qstring.h>
 
 #if (QT_VERSION-0 >= 0x030000)
 #define DateFormat QPEDateFormat
 #endif
 
 // return a string with the time based on whether or not you want
 // you want it in 12 hour form.   if ampm is true, then return
 // it in 12 hour (am/pm) form otherwise return it in 24 hour form
 // in theory Qt 3,0 handles this better (hopefully obsoleteing this)
 class DateFormat
 {
 public:
     // date format type 001,010,100 = day month year
     enum Order {
         DayMonthYear = 0x0111, // 0x001 + 0x010(0x2 << 3) + 0x100(0x4 << 3)
         MonthDayYear = 0x010A,
         YearMonthDay = 0x0054
     };
 
     DateFormat(QChar s = '/', Order so = MonthDayYear) : _shortOrder(so),
         _longOrder(so), _shortSeparator(s) { }
     DateFormat(QChar s, Order so, Order lo) :  _shortOrder(so),
         _longOrder(lo), _shortSeparator(s) { }
     DateFormat(const DateFormat &o) : _shortOrder(o._shortOrder),
         _longOrder(o._longOrder), _shortSeparator(o._shortSeparator) { }
 
     bool operator==(const DateFormat &o)
     {
         if (o._shortOrder == _shortOrder && o._longOrder == _longOrder &&
                 o._shortSeparator == _shortSeparator)
             return TRUE;
         return FALSE;
     }
 
     // verbosity specifiers
     enum Verbosity {
         shortNumber = 0x01, // default
         longNumber  = 0x02,
 
         padNumber = 0x04,
 
         shortWord = 0x08, // default
         longWord = 0x10,
 
         showWeekDay = 0x20
     };
 
     QString toNumberString() const; // the M/D/Y string.
     QString toWordString() const; // the Month day, year string.
 
     QString numberDate(const QDate &d, int v = 0) const;
     QString wordDate(const QDate &d, int v = 0) const;
 
 #ifndef QT_NO_DATASTREAM
     void load(QDataStream&);
     void save(QDataStream&) const;
 #endif
 
     QChar separator() const { return _shortSeparator; };
     Order shortOrder() const { return _shortOrder; };
     Order longOrder() const { return _longOrder; };
 
 private:
     Order _shortOrder;
     Order _longOrder;
     QChar _shortSeparator;
 };
 
 #ifndef QT_NO_DATASTREAM
 QDataStream &operator<<(QDataStream &s, const DateFormat&df);
 QDataStream &operator>>(QDataStream &s, DateFormat&df);
 #endif
 
 class TimeString
 {
 public:
 
     //enum DateFormat { MonthDayYear, DayMonthYear, ISO8601,
                       //YearMonthDay = ISO8601 };
 
-
+/**
+ * @name Convience functions which use currentDateFormat
+ */
+//@{
     static QString shortDate( const QDate &d )
     { return shortDate( d, currentDateFormat() ); }
     static QString dateString( const QDate &d )
     { return dateString( d, currentDateFormat() ); }
     static QString longDateString( const QDate &d )
     { return longDateString( d, currentDateFormat() ); }
+//@}
     static QString dateString( const QDateTime &dt, bool ampm, bool seconds )
     { return dateString( dt, ampm, seconds, currentDateFormat() ); }
 
+
+   /** @name Do not use as they don't honor system settings for AMPM
+    *
+    */
+    //@{
     static QString dateString( const QDateTime &t, bool ampm = false );
     static QString timeString( const QTime &t, bool ampm, bool seconds );
     static QString timeString( const QTime &t, bool ampm = false );
     static QString shortTime( bool ampm, bool seconds );
     static QString shortTime( bool ampm = false );
+    //@}
 
     static QString numberDateString( const QDate &d, DateFormat );
     static QString numberDateString( const QDate &d )
     { return numberDateString( d, currentDateFormat() ); }
     static QString longNumberDateString( const QDate &d, DateFormat );
     static QString longNumberDateString( const QDate &d )
     { return longNumberDateString( d, currentDateFormat() ); }
 
     static QString shortDate( const QDate &, DateFormat );
     static QString dateString( const QDate &, DateFormat  );
     static QString longDateString( const QDate &, DateFormat );
 
     static DateFormat currentDateFormat();
 
 private:
     static QString dateString( const QDateTime &t, bool ampm, bool seconds, DateFormat );
 
 
 };
 
 #endif