epoc32/include/smsuset.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // contains the implementation of the inline function the TSmsSettings class
    15 // used to get and set the SMS settings
    16 // 
    17 //
    18 
    19 /**
    20  @file
    21  
    22  Gets the time-out value.
    23  
    24  @return Time-out value 
    25  
    26 */
    27 inline const TTimeIntervalMicroSeconds32& TSmsSettings::Timeout() const
    28     {
    29     return iTimeoutMicroSeconds32;
    30     }
    31 
    32 /**
    33  *  Sets the time-out value.
    34  *  
    35  *  @param aTimeout Time-out value 
    36  */
    37 inline void TSmsSettings::SetTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
    38     {
    39     iTimeoutMicroSeconds32=aTimeout;
    40     }
    41 
    42 /**
    43  *  Gets the maximum number of attempts to send an SMS.
    44  *  
    45  *  @return Maximum number of attempts to send a SMS 
    46  */
    47 inline TInt TSmsSettings::SendTryLimit() const
    48     {
    49     return iSendTryLimit;
    50     }
    51 
    52 /**
    53  *  Sets the maximum number of attempts to send an SMS.
    54  *  
    55  *  @param aLimit Maximum number of attempts to send a SMS 
    56  */
    57 inline void TSmsSettings::SetSendTryLimit(TInt aLimit)
    58     {
    59     iSendTryLimit=aLimit;
    60     }
    61 
    62 /**
    63  *  Gets whether the PDU can be deleted from the SIM.
    64  *  
    65  *  @return True if the PDU can be deleted from the SIM 
    66  */
    67 inline TBool TSmsSettings::DeletePDUsFromSIM() const
    68     {
    69     return iFlags&ESmsFlagDeletePDUsFromSIM;
    70     }
    71 
    72 /**
    73  *  Sets whether the PDU can be deleted from the SIM.
    74  *  
    75  *  @param aDelete True if the PDU can be deleted from the SIM 
    76  */
    77 inline void TSmsSettings::SetDeletePDUsFromSIM(TBool aDelete)
    78     {
    79     iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromSIM: iFlags&(~ESmsFlagDeletePDUsFromSIM);
    80     }
    81 
    82 /**
    83  *  Gets whether the PDU can be deleted from the phone store.
    84  *  
    85  *  @return True if the PDU can be deleted from the phone store 
    86  */
    87 inline TBool TSmsSettings::DeletePDUsFromPhoneStores() const
    88     {
    89     return iFlags&ESmsFlagDeletePDUsFromPhoneStores;
    90     }
    91 
    92 /**
    93  *  Sets whether the PDU can be deleted from the phone store.
    94  *  
    95  *  @param aDelete True if the PDU can be deleted from phone store 
    96  */
    97 inline void TSmsSettings::SetDeletePDUsFromPhoneStores(TBool aDelete)
    98     {
    99     iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromPhoneStores: iFlags&(~ESmsFlagDeletePDUsFromPhoneStores);
   100     }
   101 
   102 /**
   103  *  Gets whether the PDU can be deleted from the combined store.
   104  *  
   105  *  @return True if the PDU can be deleted from the combined store 
   106  */
   107 inline TBool TSmsSettings::DeletePDUsFromCombinedStores() const
   108     {
   109     return iFlags&ESmsFlagDeletePDUsFromCombinedStores;
   110     }
   111 
   112 /**
   113  *  Sets whether the PDU can be deleted from the combined store.
   114  *  
   115  *  @param aDelete True if the PDU can be deleted from the combined store 
   116  */
   117 inline void TSmsSettings::SetDeletePDUsFromCombinedStores(TBool aDelete)
   118     {
   119     iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromCombinedStores: iFlags&(~ESmsFlagDeletePDUsFromCombinedStores);
   120     }
   121 
   122 /**
   123  *  Gets the value of the Reassembly store life time.
   124  *  
   125  *  @return Reassembly store life time 
   126  */
   127 inline const TTimeIntervalMinutes& TSmsSettings::ReassemblyLifetime() const
   128     {
   129     return iReassemblyLifetime;
   130     }
   131 
   132 /**
   133  *  Sets the value of the Reassembly store life time.
   134  *  
   135  *  @param aReassemblyLifetime Reassembly store life time 
   136  */
   137 inline void TSmsSettings::SetReassemblyLifetime(const TTimeIntervalMinutes& aReassemblyLifetime)
   138     {
   139     iReassemblyLifetime=aReassemblyLifetime;
   140     }
   141 
   142 /**
   143  *  Gets the value of the segmentation store multiplier.
   144  *  
   145  *  @return Segmentation store multiplier 
   146  */
   147 inline TInt TSmsSettings::KSegmentationLifetimeMultiplier() const
   148     {
   149     return iKSegmentationLifetimeMultiplier;
   150     }
   151 
   152 /**
   153  *  Sets the value of the segmentation store multiplier.
   154  *  
   155  *  @param aKSegmentationLifetimeMultiplier Segmentation store multiplier 
   156  */
   157 inline void TSmsSettings::SetKSegmentationLifetimeMultiplier(TInt aKSegmentationLifetimeMultiplier)
   158     {
   159     iKSegmentationLifetimeMultiplier=aKSegmentationLifetimeMultiplier;
   160     }
   161 
   162 /**
   163  *  Gets the value of the modem initialisation timeout duration.
   164  *  
   165  *  @return Modem initialisation timeout duration 
   166  */
   167 inline const TTimeIntervalMicroSeconds32& TSmsSettings::ModemInitializationTimeout() const
   168     {
   169     return iModemInitializationTimeoutMicroSeconds32;
   170     }
   171 
   172 /**
   173  *  Sets the value of the modem initialisation timeout duration.
   174  *  
   175  *  @param aTimeout Modem initialisation timeout duration 
   176  */
   177 inline void TSmsSettings::SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   178     {
   179     iModemInitializationTimeoutMicroSeconds32=aTimeout;
   180     }
   181 
   182 /**
   183  *  Gets the Send Try Timeout value
   184  *  
   185  *  @return Time-out value
   186  */
   187 inline const TTimeIntervalMicroSeconds32& TSmsSettings::SendTryTimeout() const
   188     {
   189     return iSendTryTimeoutMicroSeconds32;
   190     }
   191 
   192 /**
   193  *  Sets the Send Try Timeout value.
   194  *  
   195  *  @param aTimeout Time-out value
   196  */
   197 inline void TSmsSettings::SetSendTryTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   198     {
   199     iSendTryTimeoutMicroSeconds32=aTimeout;
   200     }
   201 
   202 /**
   203  *  Gets the Boot Timer Timeout value
   204  *  
   205  *  @return Boot Timer Time-out value
   206  */
   207 inline const TTimeIntervalMicroSeconds32& TSmsSettings::BootTimerTimeout()
   208     {
   209     return iBootTimerTimeout32;
   210     }
   211 
   212 /**
   213  *  Sets the Boot Timer Timeout value
   214  *  
   215  *  @param aTimeout Time-out value 
   216  */
   217 inline void TSmsSettings::SetBootTimerTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   218     {
   219     iBootTimerTimeout32 = aTimeout;
   220     }