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