calendarui/views/dayview/src/calendayutils.cpp
author hgs
Fri, 15 Oct 2010 12:10:36 +0530
changeset 83 5aadd1120515
parent 81 ce92091cbd61
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  CalenDayUtils utility class implementation.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
// System includes
63
hgs
parents: 57
diff changeset
    19
#include <QDateTime>
hgs
parents: 57
diff changeset
    20
#include <HbDeviceProfile>
hgs
parents: 57
diff changeset
    21
#include <HbStyle>
hgs
parents: 57
diff changeset
    22
#include <HbInstance>
45
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// User includes
hgs
parents:
diff changeset
    25
#include "calendayutils.h"
hgs
parents:
diff changeset
    26
#include "calendaycommonheaders.h"
hgs
parents:
diff changeset
    27
#include "agendaentry.h"
hgs
parents:
diff changeset
    28
#include "calendateutils.h"
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// Initialization of static member
hgs
parents:
diff changeset
    31
CalenDayUtils* CalenDayUtils::mInstance = 0;
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/*!
hgs
parents:
diff changeset
    34
 \class CalenDayUtils
hgs
parents:
diff changeset
    35
 \brief Singleton utility class.
hgs
parents:
diff changeset
    36
 
hgs
parents:
diff changeset
    37
 Class cannot be used in console applications.
hgs
parents:
diff changeset
    38
 
hgs
parents:
diff changeset
    39
 Provided functionalities (getters):
hgs
parents:
diff changeset
    40
 - screen width of device
hgs
parents:
diff changeset
    41
 - default width of hour element
hgs
parents:
diff changeset
    42
 - default height of hour element
hgs
parents:
diff changeset
    43
 - default width of content area
hgs
parents:
diff changeset
    44
 - current orientation of screen
hgs
parents:
diff changeset
    45
 - pointer to the main window of application
hgs
parents:
diff changeset
    46
 */
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
/*!
hgs
parents:
diff changeset
    49
 \brief Returns the instance of CalenDayUtils class
hgs
parents:
diff changeset
    50
 */
hgs
parents:
diff changeset
    51
CalenDayUtils *CalenDayUtils::instance()
hgs
parents:
diff changeset
    52
{
hgs
parents:
diff changeset
    53
    if (!mInstance) {
hgs
parents:
diff changeset
    54
        mInstance = new CalenDayUtils();
hgs
parents:
diff changeset
    55
    }
hgs
parents:
diff changeset
    56
    return mInstance;
hgs
parents:
diff changeset
    57
}
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
/*!
hgs
parents:
diff changeset
    60
 \brief Destructor
hgs
parents:
diff changeset
    61
 */
hgs
parents:
diff changeset
    62
CalenDayUtils::~CalenDayUtils()
hgs
parents:
diff changeset
    63
{
hgs
parents:
diff changeset
    64
    
hgs
parents:
diff changeset
    65
}
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
/*!
hgs
parents:
diff changeset
    68
 \brief screenWidth
hgs
parents:
diff changeset
    69
 
hgs
parents:
diff changeset
    70
 \return Width of main window's screen
hgs
parents:
diff changeset
    71
 */
hgs
parents:
diff changeset
    72
qreal CalenDayUtils::screenWidth() const
hgs
parents:
diff changeset
    73
{
hgs
parents:
diff changeset
    74
    ASSERT(mMainWindow);
hgs
parents:
diff changeset
    75
    
hgs
parents:
diff changeset
    76
    return mMainWindow->layoutRect().width();
hgs
parents:
diff changeset
    77
}
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
/*!
83
hgs
parents: 81
diff changeset
    80
 \brief screenHeight
hgs
parents: 81
diff changeset
    81
 
hgs
parents: 81
diff changeset
    82
 \return Height of main window's screen
hgs
parents: 81
diff changeset
    83
 */
hgs
parents: 81
diff changeset
    84
qreal CalenDayUtils::screenHeight() const
hgs
parents: 81
diff changeset
    85
{
hgs
parents: 81
diff changeset
    86
    ASSERT(mMainWindow);
hgs
parents: 81
diff changeset
    87
    
hgs
parents: 81
diff changeset
    88
    return mMainWindow->layoutRect().height();
hgs
parents: 81
diff changeset
    89
}
hgs
parents: 81
diff changeset
    90
hgs
parents: 81
diff changeset
    91
/*!
45
hgs
parents:
diff changeset
    92
 \brief hourElementWidth
hgs
parents:
diff changeset
    93
 
hgs
parents:
diff changeset
    94
 \return Width of hour element
hgs
parents:
diff changeset
    95
 */
hgs
parents:
diff changeset
    96
qreal CalenDayUtils::hourElementWidth() const
hgs
parents:
diff changeset
    97
{
hgs
parents:
diff changeset
    98
    return mHourElementWidth;
hgs
parents:
diff changeset
    99
}
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
/*!
hgs
parents:
diff changeset
   102
 \brief hourElementHeight
hgs
parents:
diff changeset
   103
 
hgs
parents:
diff changeset
   104
 \return Height of hour element
hgs
parents:
diff changeset
   105
 */
hgs
parents:
diff changeset
   106
qreal CalenDayUtils::hourElementHeight() const
hgs
parents:
diff changeset
   107
{
hgs
parents:
diff changeset
   108
    return mHourElementHeight;
hgs
parents:
diff changeset
   109
}
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
/*!
70
hgs
parents: 64
diff changeset
   112
 \brief minEventHeight
hgs
parents: 64
diff changeset
   113
 
hgs
parents: 64
diff changeset
   114
 \return Minimum height of event bubble
hgs
parents: 64
diff changeset
   115
 */
hgs
parents: 64
diff changeset
   116
qreal CalenDayUtils::minEventHeight() const
hgs
parents: 64
diff changeset
   117
{
hgs
parents: 64
diff changeset
   118
    return mMinEventHeight;
hgs
parents: 64
diff changeset
   119
}
hgs
parents: 64
diff changeset
   120
hgs
parents: 64
diff changeset
   121
/*!
45
hgs
parents:
diff changeset
   122
 \brief contentWidth
hgs
parents:
diff changeset
   123
 
hgs
parents:
diff changeset
   124
 \return Width of content area
hgs
parents:
diff changeset
   125
 */
hgs
parents:
diff changeset
   126
qreal CalenDayUtils::contentWidth() const
hgs
parents:
diff changeset
   127
{
hgs
parents:
diff changeset
   128
    return (screenWidth() - mHourElementWidth);
hgs
parents:
diff changeset
   129
}
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
/*!
hgs
parents:
diff changeset
   132
 \brief orientation
hgs
parents:
diff changeset
   133
 
hgs
parents:
diff changeset
   134
 \return Orientation of main window
hgs
parents:
diff changeset
   135
 */
hgs
parents:
diff changeset
   136
Qt::Orientation CalenDayUtils::orientation() const
hgs
parents:
diff changeset
   137
{
hgs
parents:
diff changeset
   138
    ASSERT(mMainWindow);
hgs
parents:
diff changeset
   139
        
hgs
parents:
diff changeset
   140
    return mMainWindow->orientation();
hgs
parents:
diff changeset
   141
}
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
/*!
hgs
parents:
diff changeset
   144
 \brief mainWindow
hgs
parents:
diff changeset
   145
 
hgs
parents:
diff changeset
   146
 \return Pointer to main window of application
hgs
parents:
diff changeset
   147
 */
hgs
parents:
diff changeset
   148
HbMainWindow* CalenDayUtils::mainWindow()
hgs
parents:
diff changeset
   149
{
hgs
parents:
diff changeset
   150
    ASSERT(mMainWindow);
hgs
parents:
diff changeset
   151
    
hgs
parents:
diff changeset
   152
    return mMainWindow;
hgs
parents:
diff changeset
   153
}
hgs
parents:
diff changeset
   154
81
hgs
parents: 70
diff changeset
   155
/*
hgs
parents: 70
diff changeset
   156
 * Get event's start/end time fromm agenda entry.
hgs
parents: 70
diff changeset
   157
 * Start/end time are validated to be within the current day (the case of
hgs
parents: 70
diff changeset
   158
 * multi-day events)
hgs
parents: 70
diff changeset
   159
 * @param start [out] valid start time
hgs
parents: 70
diff changeset
   160
 * @param end [out] valid end time
hgs
parents: 70
diff changeset
   161
 * @param entry [in] agenda entry asociated with the event.
hgs
parents: 70
diff changeset
   162
 * @param currentDate [in] current date
45
hgs
parents:
diff changeset
   163
 */
81
hgs
parents: 70
diff changeset
   164
void CalenDayUtils::getEventValidStartEndTime(
hgs
parents: 70
diff changeset
   165
    QDateTime& start,
hgs
parents: 70
diff changeset
   166
    QDateTime& end,
hgs
parents: 70
diff changeset
   167
    const AgendaEntry& entry,
hgs
parents: 70
diff changeset
   168
    QDateTime& currentDate)
45
hgs
parents:
diff changeset
   169
{
hgs
parents:
diff changeset
   170
    start = entry.startTime();
hgs
parents:
diff changeset
   171
    end = entry.endTime();
81
hgs
parents: 70
diff changeset
   172
hgs
parents: 70
diff changeset
   173
    if (!CalenDateUtils::onSameDay(start, currentDate)) {
hgs
parents: 70
diff changeset
   174
        start = CalenDateUtils::beginningOfDay(currentDate);
45
hgs
parents:
diff changeset
   175
    }
81
hgs
parents: 70
diff changeset
   176
hgs
parents: 70
diff changeset
   177
    if (!CalenDateUtils::onSameDay(end, currentDate)) {
hgs
parents: 70
diff changeset
   178
        QDateTime tommorrow(currentDate.addDays(1));
hgs
parents: 70
diff changeset
   179
        end = CalenDateUtils::beginningOfDay(tommorrow).addSecs(-60);
45
hgs
parents:
diff changeset
   180
    }
hgs
parents:
diff changeset
   181
}
hgs
parents:
diff changeset
   182
hgs
parents:
diff changeset
   183
/*!
hgs
parents:
diff changeset
   184
 \brief Constructor
hgs
parents:
diff changeset
   185
 */
hgs
parents:
diff changeset
   186
CalenDayUtils::CalenDayUtils() : mMainWindow(NULL)
hgs
parents:
diff changeset
   187
{
hgs
parents:
diff changeset
   188
    if (HbInstance::instance()->allMainWindows().count() > 0) {
hgs
parents:
diff changeset
   189
        mMainWindow = HbInstance::instance()->allMainWindows().first();
hgs
parents:
diff changeset
   190
    }
hgs
parents:
diff changeset
   191
    mHourElementWidth = calculateHourElementWidth();
hgs
parents:
diff changeset
   192
    mHourElementHeight = calculateHourElementHeight();
70
hgs
parents: 64
diff changeset
   193
    mMinEventHeight = calculateMinEventHeight();
45
hgs
parents:
diff changeset
   194
}
hgs
parents:
diff changeset
   195
hgs
parents:
diff changeset
   196
/*!
hgs
parents:
diff changeset
   197
 \brief Calculates the width of hour element according to UI spec.
hgs
parents:
diff changeset
   198
 
hgs
parents:
diff changeset
   199
 \return Calculated width of hour element
hgs
parents:
diff changeset
   200
 */
hgs
parents:
diff changeset
   201
qreal CalenDayUtils::calculateHourElementWidth() const
hgs
parents:
diff changeset
   202
{
hgs
parents:
diff changeset
   203
    HbStyle style;
hgs
parents:
diff changeset
   204
    HbDeviceProfile deviceProfile;
hgs
parents:
diff changeset
   205
    qreal unitInPixels = deviceProfile.unitValue();
hgs
parents:
diff changeset
   206
hgs
parents:
diff changeset
   207
    // Calculate element's preferred width
hgs
parents:
diff changeset
   208
    qreal prefWidth = 0.0;
hgs
parents:
diff changeset
   209
    qreal textWidth = 0.0;
hgs
parents:
diff changeset
   210
    qreal horizontalSpacing = 0.0;
hgs
parents:
diff changeset
   211
    
hgs
parents:
diff changeset
   212
    textWidth = 8.04 * unitInPixels; // pix (according to UI spec)   
hgs
parents:
diff changeset
   213
    style.parameter(QString("hb-param-margin-gene-middle-horizontal"), 
hgs
parents:
diff changeset
   214
        horizontalSpacing, deviceProfile);
hgs
parents:
diff changeset
   215
    prefWidth = horizontalSpacing * 2 + textWidth;
hgs
parents:
diff changeset
   216
    
hgs
parents:
diff changeset
   217
    return prefWidth;
hgs
parents:
diff changeset
   218
}
hgs
parents:
diff changeset
   219
hgs
parents:
diff changeset
   220
/*!
hgs
parents:
diff changeset
   221
 \brief Calculates the height of hour element according to UI spec.
hgs
parents:
diff changeset
   222
 
hgs
parents:
diff changeset
   223
 \return Calculated height of hour element
hgs
parents:
diff changeset
   224
 */
hgs
parents:
diff changeset
   225
qreal CalenDayUtils::calculateHourElementHeight() const
hgs
parents:
diff changeset
   226
{
hgs
parents:
diff changeset
   227
    HbStyle style;
hgs
parents:
diff changeset
   228
    HbDeviceProfile deviceProfile;
hgs
parents:
diff changeset
   229
    
hgs
parents:
diff changeset
   230
    qreal unitInPixels = deviceProfile.unitValue();
hgs
parents:
diff changeset
   231
    
hgs
parents:
diff changeset
   232
    // Calculate element's preferred height
hgs
parents:
diff changeset
   233
    qreal prefHeight = 0.0;
hgs
parents:
diff changeset
   234
    qreal textHeight = 0.0;
hgs
parents:
diff changeset
   235
    qreal verticalSpacing = 0.0;
hgs
parents:
diff changeset
   236
        
83
hgs
parents: 81
diff changeset
   237
    qreal bottomSpacer = 5 * unitInPixels;
45
hgs
parents:
diff changeset
   238
    style.parameter(QString("hb-param-text-height-secondary"), textHeight, 
hgs
parents:
diff changeset
   239
        deviceProfile);
hgs
parents:
diff changeset
   240
    style.parameter(QString("hb-param-margin-gene-middle-vertical"), 
hgs
parents:
diff changeset
   241
        verticalSpacing, deviceProfile);
hgs
parents:
diff changeset
   242
hgs
parents:
diff changeset
   243
    prefHeight = textHeight * 2; //time + ampm
hgs
parents:
diff changeset
   244
    prefHeight += verticalSpacing * 2;
hgs
parents:
diff changeset
   245
    prefHeight += bottomSpacer;
hgs
parents:
diff changeset
   246
    
hgs
parents:
diff changeset
   247
    return prefHeight;
hgs
parents:
diff changeset
   248
}
70
hgs
parents: 64
diff changeset
   249
hgs
parents: 64
diff changeset
   250
/*!
hgs
parents: 64
diff changeset
   251
 \brief Calculates the height of hour element according to UI spec.
hgs
parents: 64
diff changeset
   252
 
hgs
parents: 64
diff changeset
   253
 \return Calculated minimum height of event bubble
hgs
parents: 64
diff changeset
   254
 */
hgs
parents: 64
diff changeset
   255
qreal CalenDayUtils::calculateMinEventHeight() const
hgs
parents: 64
diff changeset
   256
{
hgs
parents: 64
diff changeset
   257
    HbStyle style;
hgs
parents: 64
diff changeset
   258
    HbDeviceProfile deviceProfile;
hgs
parents: 64
diff changeset
   259
hgs
parents: 64
diff changeset
   260
    // Calculate minimum height of event bubble
hgs
parents: 64
diff changeset
   261
    qreal textHeight = 0.0;
hgs
parents: 64
diff changeset
   262
    qreal topSpacing = 0.0;
hgs
parents: 64
diff changeset
   263
    qreal bottomSpacing = 0.0;
hgs
parents: 64
diff changeset
   264
    style.parameter(QString("hb-param-text-height-secondary"), textHeight,
hgs
parents: 64
diff changeset
   265
        deviceProfile);
hgs
parents: 64
diff changeset
   266
    style.parameter(QString("hb-param-margin-gene-top"), topSpacing, 
hgs
parents: 64
diff changeset
   267
        deviceProfile);
hgs
parents: 64
diff changeset
   268
    style.parameter(QString("hb-param-margin-gene-bottom"), bottomSpacing, 
hgs
parents: 64
diff changeset
   269
        deviceProfile);
hgs
parents: 64
diff changeset
   270
    
hgs
parents: 64
diff changeset
   271
    return (topSpacing + textHeight + bottomSpacing);
hgs
parents: 64
diff changeset
   272
}