epoc32/include/swi/AppVersion.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: Java Registy API header file
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef TAPPVERSION_H
williamr@2
    19
#define TAPPVERSION_H
williamr@2
    20
williamr@2
    21
/**
williamr@2
    22
 * This class is used to represent the version of a Java application.
williamr@2
    23
 * The standard TVersion provided in Symbian OS can't be used because it 
williamr@2
    24
 * doesn't allow for major and minor version numbers above 127. 
williamr@2
    25
 */
williamr@2
    26
class TAppVersion
williamr@2
    27
    {
williamr@2
    28
    public:
williamr@2
    29
williamr@2
    30
        /**
williamr@2
    31
         * This constructor creates a 0.0.0 version.
williamr@2
    32
         */
williamr@2
    33
        inline TAppVersion();
williamr@2
    34
williamr@2
    35
        /**
williamr@2
    36
         * This is the copy constructor.
williamr@2
    37
         * @param aAppVersion is the app version that will be copied
williamr@2
    38
         */	
williamr@2
    39
        inline TAppVersion(const TAppVersion& aAppVersion);
williamr@2
    40
williamr@2
    41
        /**
williamr@2
    42
         * This constructor creates a version according to the arguments.
williamr@2
    43
         * @param aMajor is the major version number 
williamr@2
    44
         * @param aMinor is the minor version number
williamr@2
    45
         * @param aBuild is the micro version number
williamr@2
    46
         */
williamr@2
    47
        inline TAppVersion(TInt aMajor, TInt aMinor, TInt aBuild);
williamr@2
    48
williamr@2
    49
        /**
williamr@2
    50
         * Assignment operator.
williamr@2
    51
         * @param aAppVersion is the app version to be assigned to the object
williamr@2
    52
         */
williamr@2
    53
        inline TAppVersion& operator =(const TAppVersion& aAppVersion);
williamr@2
    54
williamr@2
    55
        /**
williamr@2
    56
         * Equality operator.
williamr@2
    57
         * @param aAppVersion is the app version to be compared with 
williamr@2
    58
         * the object's app version
williamr@2
    59
         * @return ETrue if the app versions are the same, EFalse otherwise
williamr@2
    60
         */
williamr@2
    61
        inline TBool operator ==(const TAppVersion& aAppVersion) const;
williamr@2
    62
	
williamr@2
    63
        /**
williamr@2
    64
         * Inequality operator.
williamr@2
    65
         * @param aAppVersion is the app version to be compared with 
williamr@2
    66
         * the object's app version
williamr@2
    67
         * @return ETrue if the app versions are not the same, EFalse otherwise
williamr@2
    68
         */
williamr@2
    69
        inline TBool operator !=(const TAppVersion& aAppVersion) const;
williamr@2
    70
williamr@2
    71
        /**
williamr@2
    72
         * Less than operator.
williamr@2
    73
         * @param aAppVersion is the app version to be compared with 
williamr@2
    74
         * the object's app version
williamr@2
    75
         * @return ETrue if the app version to the left of the operator is less
williamr@2
    76
         * than the version to the right, EFalse otherwise
williamr@2
    77
         */
williamr@2
    78
        inline TBool operator <(const TAppVersion& aAppVersion) const;
williamr@2
    79
williamr@2
    80
        /**
williamr@2
    81
         * Greater than operator.
williamr@2
    82
         * @param aAppVersion is the app version to be compared with 
williamr@2
    83
         * the object's app version
williamr@2
    84
         * @return ETrue if the app version to the left of the operator is 
williamr@2
    85
         * greater than the version to the right, EFalse otherwise
williamr@2
    86
         */
williamr@2
    87
        inline TBool operator >(const TAppVersion& aAppVersion) const;
williamr@2
    88
williamr@2
    89
        /**
williamr@2
    90
         * Less or equal operator.
williamr@2
    91
         * @param aAppVersion is the app version to be compared with 
williamr@2
    92
         * the object's app version
williamr@2
    93
         * @return ETrue if the app version to the left of the operator is 
williamr@2
    94
         * less than or equal to the version to the right, EFalse otherwise
williamr@2
    95
         */
williamr@2
    96
        inline TBool operator <=(const TAppVersion& aAppVersion) const;
williamr@2
    97
williamr@2
    98
        /**
williamr@2
    99
         * Greater or equal operator.
williamr@2
   100
         * @param aAppVersion is the app version to be compared with 
williamr@2
   101
         * the object's app version
williamr@2
   102
         * @return ETrue if the app version to the left of the operator is 
williamr@2
   103
         * greater than or equal to the version to the right, EFalse otherwise
williamr@2
   104
         */
williamr@2
   105
         inline TBool operator >=(const TAppVersion& aAppVersion) const;
williamr@2
   106
williamr@2
   107
    public:
williamr@2
   108
        TInt iMajor;
williamr@2
   109
        TInt iMinor;
williamr@2
   110
        TInt iBuild;
williamr@2
   111
    };
williamr@2
   112
williamr@2
   113
#include <swi/appversion.inl>
williamr@2
   114
williamr@2
   115
#endif // TAPPVERSION_H
williamr@2
   116
williamr@2
   117
// End of File