epoc32/include/smsuset.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 
    21 
    22 /**
    23  @file
    24  
    25  Gets the time-out value.
    26  
    27  @return Time-out value 
    28  
    29 */
    30 inline const TTimeIntervalMicroSeconds32& TSmsSettings::Timeout() const
    31 	{
    32 	return iTimeoutMicroSeconds32;
    33 	}
    34 
    35 
    36 /**
    37  *  Sets the time-out value.
    38  *  
    39  *  @param aTimeout Time-out value 
    40  */
    41 inline void TSmsSettings::SetTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
    42 	{
    43 	iTimeoutMicroSeconds32=aTimeout;
    44 	}
    45 
    46 
    47 /**
    48  *  Gets the maximum number of attempts to send an SMS.
    49  *  
    50  *  @return Maximum number of attempts to send a SMS 
    51  */
    52 inline TInt TSmsSettings::SendTryLimit() const
    53 	{
    54 	return iSendTryLimit;
    55 	}
    56 
    57 
    58 /**
    59  *  Sets the maximum number of attempts to send an SMS.
    60  *  
    61  *  @param aLimit Maximum number of attempts to send a SMS 
    62  */
    63 inline void TSmsSettings::SetSendTryLimit(TInt aLimit)
    64 	{
    65 	iSendTryLimit=aLimit;
    66 	}
    67 
    68 
    69 /**
    70  *  Gets whether the PDU can be deleted from the SIM.
    71  *  
    72  *  @return True if the PDU can be deleted from the SIM 
    73  */
    74 inline TBool TSmsSettings::DeletePDUsFromSIM() const
    75 	{
    76 	return iFlags&ESmsFlagDeletePDUsFromSIM;
    77 	}
    78 
    79 
    80 /**
    81  *  Sets whether the PDU can be deleted from the SIM.
    82  *  
    83  *  @param aDelete True if the PDU can be deleted from the SIM 
    84  */
    85 inline void TSmsSettings::SetDeletePDUsFromSIM(TBool aDelete)
    86 	{
    87 	iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromSIM: iFlags&(~ESmsFlagDeletePDUsFromSIM);
    88 	}
    89 
    90 
    91 /**
    92  *  Gets whether the PDU can be deleted from the phone store.
    93  *  
    94  *  @return True if the PDU can be deleted from the phone store 
    95  */
    96 inline TBool TSmsSettings::DeletePDUsFromPhoneStores() const
    97 	{
    98 	return iFlags&ESmsFlagDeletePDUsFromPhoneStores;
    99 	}
   100 
   101 
   102 /**
   103  *  Sets whether the PDU can be deleted from the phone store.
   104  *  
   105  *  @param aDelete True if the PDU can be deleted from phone store 
   106  */
   107 inline void TSmsSettings::SetDeletePDUsFromPhoneStores(TBool aDelete)
   108 	{
   109 	iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromPhoneStores: iFlags&(~ESmsFlagDeletePDUsFromPhoneStores);
   110 	}
   111 
   112 
   113 /**
   114  *  Gets whether the PDU can be deleted from the combined store.
   115  *  
   116  *  @return True if the PDU can be deleted from the combined store 
   117  */
   118 inline TBool TSmsSettings::DeletePDUsFromCombinedStores() const
   119 	{
   120 	return iFlags&ESmsFlagDeletePDUsFromCombinedStores;
   121 	}
   122 
   123 
   124 /**
   125  *  Sets whether the PDU can be deleted from the combined store.
   126  *  
   127  *  @param aDelete True if the PDU can be deleted from the combined store 
   128  */
   129 inline void TSmsSettings::SetDeletePDUsFromCombinedStores(TBool aDelete)
   130 	{
   131 	iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromCombinedStores: iFlags&(~ESmsFlagDeletePDUsFromCombinedStores);
   132 	}
   133 
   134 
   135 /**
   136  *  Gets the value of the Reassembly store life time.
   137  *  
   138  *  @return Reassembly store life time 
   139  */
   140 inline const TTimeIntervalMinutes& TSmsSettings::ReassemblyLifetime() const
   141 	{
   142 	return iReassemblyLifetime;
   143 	}
   144 
   145 
   146 /**
   147  *  Sets the value of the Reassembly store life time.
   148  *  
   149  *  @param aReassemblyLifetime Reassembly store life time 
   150  */
   151 inline void TSmsSettings::SetReassemblyLifetime(const TTimeIntervalMinutes& aReassemblyLifetime)
   152 	{
   153 	iReassemblyLifetime=aReassemblyLifetime;
   154 	}
   155 
   156 
   157 /**
   158  *  Gets the value of the segmentation store multiplier.
   159  *  
   160  *  @return Segmentation store multiplier 
   161  */
   162 inline TInt TSmsSettings::KSegmentationLifetimeMultiplier() const
   163 	{
   164 	return iKSegmentationLifetimeMultiplier;
   165 	}
   166 
   167 
   168 /**
   169  *  Sets the value of the segmentation store multiplier.
   170  *  
   171  *  @param aKSegmentationLifetimeMultiplier Segmentation store multiplier 
   172  */
   173 inline void TSmsSettings::SetKSegmentationLifetimeMultiplier(TInt aKSegmentationLifetimeMultiplier)
   174 	{
   175 	iKSegmentationLifetimeMultiplier=aKSegmentationLifetimeMultiplier;
   176 	}
   177 
   178 
   179 /**
   180  *  Gets the value of the modem initialisation timeout duration.
   181  *  
   182  *  @return Modem initialisation timeout duration 
   183  */
   184 inline const TTimeIntervalMicroSeconds32& TSmsSettings::ModemInitializationTimeout() const
   185 	{
   186 	return iModemInitializationTimeoutMicroSeconds32;
   187 	}
   188 
   189 
   190 /**
   191  *  Sets the value of the modem initialisation timeout duration.
   192  *  
   193  *  @param aTimeout Modem initialisation timeout duration 
   194  */
   195 inline void TSmsSettings::SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   196 	{
   197 	iModemInitializationTimeoutMicroSeconds32=aTimeout;
   198 	}
   199 
   200 
   201 /**
   202  *  Gets the Send Try Timeout value
   203  *  
   204  *  @return Time-out value
   205  */
   206 inline const TTimeIntervalMicroSeconds32& TSmsSettings::SendTryTimeout() const
   207 	{
   208 	return iSendTryTimeoutMicroSeconds32;
   209 	}
   210 
   211 
   212 /**
   213  *  Sets the Send Try Timeout value.
   214  *  
   215  *  @param aTimeout Time-out value
   216  */
   217 inline void TSmsSettings::SetSendTryTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   218 	{
   219 	iSendTryTimeoutMicroSeconds32=aTimeout;
   220 	}
   221 
   222 
   223 /**
   224  *  Gets the Boot Timer Timeout value
   225  *  
   226  *  @return Boot Timer Time-out value
   227  */
   228 inline const TTimeIntervalMicroSeconds32& TSmsSettings::BootTimerTimeout()
   229     {
   230     return iBootTimerTimeout32;
   231     }
   232 
   233 
   234 /**
   235  *  Sets the Boot Timer Timeout value
   236  *  
   237  *  @param aTimeout Time-out value 
   238  */
   239 inline void TSmsSettings::SetBootTimerTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   240     {
   241     iBootTimerTimeout32 = aTimeout;
   242     }