epoc32/include/apmrec.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 1997-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 //
    15 
    16 inline TInt CApaDataRecognizerType::MimeTypesCount() const
    17 /** Gets the number of data (MIME) types supported by this recognizer.
    18 
    19 @return The number of data types.
    20 @see iCountDataTypes */
    21 	{
    22 	return iCountDataTypes;
    23 	}
    24 
    25 inline TUid CApaDataRecognizerType::TypeUid() const
    26 /** Gets the UID that identifies the recognizer.
    27 
    28 @return The UID. */
    29 	{
    30 	return iTypeUid;
    31 	}
    32 
    33 inline TInt CApaDataRecognizerType::Priority() const
    34 /** Gets the recognizer's priority.
    35 
    36 The priority defines the likelihood that the recognizer will successfully 
    37 identify data. This is one of the CApaDataRecognizerType::TRecognizerPriority 
    38 enumerators.
    39 
    40 @return The priority value.
    41 @see CApaDataRecognizerType::TRecognizerPriority */
    42 	{
    43 	return iPriority;
    44 	}
    45 	
    46 inline TInt CApaDataRecognizerType::Confidence() const
    47 /** Gets the recognizer's confidence rating for the most recently recognized data.
    48 
    49 @return The confidence rating. This is one of the TRecognitionConfidence enumeration 
    50 values.
    51 @see CApaDataRecognizerType::TRecognitionConfidence
    52 @see iConfidence */
    53 	{
    54 	return iConfidence;
    55 	}
    56 
    57 inline TInt CApaDataRecognizerType::Locked() const
    58 /** Tests whether the recognizer is locked.
    59 
    60 @return If zero, the recognizer is not locked; if greater than 0, the recognizer 
    61 is locked.
    62 @see Lock()
    63 @see Unlock() */
    64 	{
    65 	return iLock;
    66 	}
    67 
    68 // Deprecated - Use CApaDataRecognizer::AddDataRecognizerTypeL instead 
    69 // as adding a concrete recognizer into the list could leave.
    70 /**
    71 @deprecated 7.0s
    72 */
    73 inline void CApaDataRecognizer::AddDataRecognizerType(CApaDataRecognizerType* aDataRecognizerType)
    74 	{
    75 	AddDataRecognizerTypeL(aDataRecognizerType);
    76 	}