epoc32/include/apmrec.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.
williamr@2
     1
// Copyright (c) 1997-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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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
//
williamr@2
    15
williamr@2
    16
inline TInt CApaDataRecognizerType::MimeTypesCount() const
williamr@2
    17
/** Gets the number of data (MIME) types supported by this recognizer.
williamr@2
    18
williamr@2
    19
@return The number of data types.
williamr@2
    20
@see iCountDataTypes */
williamr@2
    21
	{
williamr@2
    22
	return iCountDataTypes;
williamr@2
    23
	}
williamr@2
    24
williamr@2
    25
inline TUid CApaDataRecognizerType::TypeUid() const
williamr@2
    26
/** Gets the UID that identifies the recognizer.
williamr@2
    27
williamr@2
    28
@return The UID. */
williamr@2
    29
	{
williamr@2
    30
	return iTypeUid;
williamr@2
    31
	}
williamr@2
    32
williamr@2
    33
inline TInt CApaDataRecognizerType::Priority() const
williamr@2
    34
/** Gets the recognizer's priority.
williamr@2
    35
williamr@2
    36
The priority defines the likelihood that the recognizer will successfully 
williamr@2
    37
identify data. This is one of the CApaDataRecognizerType::TRecognizerPriority 
williamr@2
    38
enumerators.
williamr@2
    39
williamr@2
    40
@return The priority value.
williamr@2
    41
@see CApaDataRecognizerType::TRecognizerPriority */
williamr@2
    42
	{
williamr@2
    43
	return iPriority;
williamr@2
    44
	}
williamr@2
    45
	
williamr@2
    46
inline TInt CApaDataRecognizerType::Confidence() const
williamr@2
    47
/** Gets the recognizer's confidence rating for the most recently recognized data.
williamr@2
    48
williamr@2
    49
@return The confidence rating. This is one of the TRecognitionConfidence enumeration 
williamr@2
    50
values.
williamr@2
    51
@see CApaDataRecognizerType::TRecognitionConfidence
williamr@2
    52
@see iConfidence */
williamr@2
    53
	{
williamr@2
    54
	return iConfidence;
williamr@2
    55
	}
williamr@2
    56
williamr@2
    57
inline TInt CApaDataRecognizerType::Locked() const
williamr@2
    58
/** Tests whether the recognizer is locked.
williamr@2
    59
williamr@2
    60
@return If zero, the recognizer is not locked; if greater than 0, the recognizer 
williamr@2
    61
is locked.
williamr@2
    62
@see Lock()
williamr@2
    63
@see Unlock() */
williamr@2
    64
	{
williamr@2
    65
	return iLock;
williamr@2
    66
	}
williamr@2
    67
williamr@4
    68
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    69
williamr@2
    70
// Deprecated - Use CApaDataRecognizer::AddDataRecognizerTypeL instead 
williamr@2
    71
// as adding a concrete recognizer into the list could leave.
williamr@2
    72
/**
williamr@2
    73
@deprecated 7.0s
williamr@2
    74
*/
williamr@2
    75
inline void CApaDataRecognizer::AddDataRecognizerType(CApaDataRecognizerType* aDataRecognizerType)
williamr@2
    76
	{
williamr@2
    77
	AddDataRecognizerTypeL(aDataRecognizerType);
williamr@2
    78
	}
williamr@4
    79
williamr@4
    80
#endif //SYMBIAN_ENABLE_SPLIT_HEADERS