class RApaLsSession : public RSessionBase |
A session with the application architecture server.
The server provides access to a cached list of the applications on the device.
To use this class, clients first need to connect to the server.
Then, one of GetAllApps() , GetEmbeddableApps() or GetFilteredApps() needs to be called. These functions do some initialisation of server data in preparation for returning the application list (which is owned by the server).
Then, GetNextApp() is called in a loop. The first time around, it populates the session's application list and retrieves the first application in the list. Further calls to GetNextApp() retrieve the remaining applications in the list, until RApaLsSession::ENoMoreAppsInList is returned.
The session should be closed when it is no longer needed, before it goes out of scope.
Various functions in RApaLsSession need to access the application list, and may return RApaLsSession::EAppListInvalid to indicate that the function was called before the initial population of the list is complete. If this occurs, you could try again after a short delay.
This class provides many other functions, for instance launching applications, querying application-specific information, recognising data.
Public Member Enumerations | |
---|---|
enum | TApaLsErrorCode { ENoMoreAppsInList = 1, EAppListInvalid } |
enum | TLaunchType { ELaunchNewApp = 1, ESwitchFiles } |
Inherited Enumerations | |
---|---|
RHandleBase:TAttributes | |
RSessionBase:TAttachMode |
Private Attributes | |
---|---|
CApaLsSessionExtension * | iExtension |
Inherited Attributes | |
---|---|
RHandleBase::iHandle |
IMPORT_C TInt | AppCount | ( | TInt & | aCount | ) | const |
Gets the total number of applications.
Control panel applications are excluded.
TInt & aCount | On return, the total number of applications. |
IMPORT_C TInt | AppForDataType | ( | const TDataType & | aDataType, |
TUid & | aAppUid | |||
) | const |
Gets the UID of an application that can handle the specified data (MIME) type.
If no application can be found, the function returns the UID of the preferred default handler. If none of the default handlers can handle the data type, then a NULL UID is returned.
IMPORT_C TInt | AppForDocument | ( | const TDesC & | aFileName, |
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
Gets the data (MIME) type of the data in the specified file and gets the UID of an application that can handle this type.
IMPORT_C TInt | AppForDocument | ( | const RFile & | aFile, |
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
IMPORT_C TInt | AppForDocumentAndService | ( | const TDesC & | aFileName, |
TUid | aServiceUid, | |||
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
Gets the data (MIME) type of the data in the specified file and gets the UID of an application that can handle this type and service.
IMPORT_C TInt | AppForDocumentAndService | ( | const RFile & | aFile, |
TUid | aServiceUid, | |||
TUid & | aAppUid, | |||
TDataType & | aDataType | |||
) | const |
void | CleanupOperation | ( | TAny * | aAny | ) | [private, static] |
TAny * aAny |
IMPORT_C TInt | CreateDocument | ( | const TDesC & | aDocFileName, |
TUid | aAppUid, | |||
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
const TDesC & aDocFileName | |
TUid aAppUid | |
TThreadId & aThreadId | |
TLaunchType aUnused = ELaunchNewApp |
CBufFlat * | CreateRegFilesBufferL | ( | const RPointerArray < TDesC > & | aRegFiles | ) | [private, static] |
const RPointerArray < TDesC > & aRegFiles |
IMPORT_C TInt | DeleteDataMapping | ( | const TDataType & | aDataType | ) |
const TDataType & aDataType |
void | DeletePointerToPointerToTAny | ( | TAny * | aPointerToPointerToTAny | ) | [private, static] |
TAny * aPointerToPointerToTAny |
IMPORT_C void | DeregisterNonNativeApplicationL | ( | TUid | aApplication | ) |
TUid aApplication |
TInt | DoAppForDocumentOptionallySpecifyingService | ( | const TDesC & | aFileName, |
TUid | aServiceUid, | |||
TUid & | aAppUid, | |||
TDataType & | aDataType, | |||
TInt | aOpcode | |||
) | const [private] |
void | DoGetAppIconSizesL | ( | TUid | aAppUid, |
CArrayFixFlat < TSize > & | aArrayToFill | |||
) | const [private] |
TUid aAppUid | |
CArrayFixFlat < TSize > & aArrayToFill |
void | DoGetAppOwnedFilesL | ( | CDesCArray & | aArrayToFill, |
TUid | aAppUid | |||
) | const [private] |
CDesCArray & aArrayToFill | |
TUid aAppUid |
void | DoGetAppViewsL | ( | CApaAppViewArray & | aArrayToFill, |
TUid | aAppUid | |||
) | const [private] |
CApaAppViewArray & aArrayToFill | |
TUid aAppUid |
void | DoStartAppL | ( | const CApaCommandLine & | aCommandLine, |
TThreadId * | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
const CApaCommandLine & aCommandLine | |
TThreadId * aThreadId | |
TRequestStatus * aRequestStatusForRendezvous |
void | DoStartApplicationL | ( | const TDesC & | aNativeExecutableName, |
const CApaCommandLine & | aCommandLine, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
const TDesC & aNativeExecutableName | |
const CApaCommandLine & aCommandLine | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous |
IMPORT_C TInt | EmbeddableAppCount | ( | TInt & | aCount | ) | const |
Gets the total number of embeddable applications.
Control panel applications are excluded.
TInt & aCount | On return, the total number of embeddable applications. |
void | FetchArrayL | ( | MArrayFiller & | aArrayFiller, |
TUid | aAppUid, | |||
TInt | aOpcode, | |||
TInt | aInitialBufSize | |||
) | const [private] |
This method implementes a generic mechanism for retrieving data items from the AppArc server. The data items can be either TSize , TApaAppViewInfo , or TDesC (see MArrayFiller).
IMPORT_C void | ForceCommitNonNativeApplicationsUpdatesL | ( | ) |
Commits the non-native application updates. This is an asynchronous method which will not wait until the application list is updated. CApaAppListNotifier class should be used to synchronize the completion of updating the application list.
IMPORT_C TInt | ForceRegistration | ( | const RPointerArray < TDesC > & | aRegFiles | ) |
const RPointerArray < TDesC > & aRegFiles |
IMPORT_C TInt | GetAcceptedConfidence | ( | TInt & | aConfidence | ) | const |
TInt & aConfidence |
IMPORT_C TInt | GetAllApps | ( | ) | const |
Initialises the process of getting all applications in the cached list.
Control panel applications are excluded.
A call to this function is followed by subsequent and repeated calls to GetNextApp() to retrieve all applications in the cached list.
IMPORT_C TInt | GetAppByDataType | ( | const TDataType & | aDataType, |
TUid | aServiceUid, | |||
TUid & | aAppUid | |||
) | const |
Gets the application associated with the data type and the service uid from the datatype store.
The function will only look into the datatype store and will not use the default type associations. This is different from the AppForDataTypeAndService() function.
IMPORT_C TInt | GetAppCapability | ( | TDes8 & | aCapabilityBuf, |
TUid | aAppUid | |||
) | const |
Gets the capabilities of the application with the specified UID.
TDes8 & aCapabilityBuf | A modifiable descriptor that, on return, contains the application's capability information. The data returned in the descriptor is mapped by the TApaAppCapability class. If no matching application is found, then the content of this descriptor is not changed. |
TUid aAppUid | The application specific UID. |
IMPORT_C TInt | GetAppIcon | ( | TUid | aAppUid, |
TInt | aSize, | |||
CApaMaskedBitmap & | aAppBitmap | |||
) | const |
gets the bitmap handles from the Server, forms these up into a CApaMaskedBitmap
Sets aAppBitmap to be the small, medium or large app icon of the app with uid aAppUid, when aSize=0, 1 or 2 respectively. Panics the caller if a different index is specified. The overload which takes a TSize should be used instead.
TUid aAppUid | The application specific UID. |
TInt aSize | The required size of the icon. |
CApaMaskedBitmap & aAppBitmap | On return, the application icon. |
IMPORT_C TInt | GetAppIcon | ( | TUid | aAppUid, |
TSize | aSize, | |||
CApaMaskedBitmap & | aAppBitmap | |||
) | const |
TUid aAppUid | |
TSize aSize | |
CApaMaskedBitmap & aAppBitmap |
IMPORT_C TInt | GetAppIconSizes | ( | TUid | aAppUid, |
CArrayFixFlat < TSize > & | aArrayToFill | |||
) | const |
Gets the available icon sizes for the application with the specified UID.
TUid aAppUid | The application specific UID. |
CArrayFixFlat < TSize > & aArrayToFill | On return, the array contains all of the available icon sizes. |
IMPORT_C TInt | GetAppInfo | ( | TApaAppInfo & | aInfo, |
TUid | aAppUid | |||
) | const |
Gets information about the application with the specified UID.
TApaAppInfo & aInfo | On return, contains the application information, if an application with the specified UID is found. If no matching application is found, then this object is not changed. |
TUid aAppUid | The application specific UID. |
IMPORT_C TInt | GetAppOwnedFiles | ( | CDesCArray & | aAppOwnedFiles, |
TUid | aAppUid | |||
) | const |
Gets the list of file names for which the application with the specified UID claims ownership.
The list is written to a descriptor array supplied by the caller.
Note that if the function fails due to lack of memory, the array is left in an undefined state.
CDesCArray & aAppOwnedFiles | On return, the descriptor array contains the file names. |
TUid aAppUid | The application specific UID. |
IMPORT_C CApaAppServiceInfoArray * | GetAppServiceOpaqueDataLC | ( | TUid | aAppUid, |
TUid | aServiceUid | |||
) | const |
IMPORT_C void | GetAppServicesL | ( | TUid | aAppUid, |
CArrayFixFlat < TUid > & | aServiceUids | |||
) | const |
TUid aAppUid | |
CArrayFixFlat < TUid > & aServiceUids |
IMPORT_C CApaAppServiceInfoArray * | GetAppServicesLC | ( | TUid | aAppUid | ) | const |
Gets the services implemented by the application that has the specified application UID.
The returned CApaAppServiceInfoArray object contains an array of TApaAppServiceInfo objects.
Information on each service implementation is contained in a TApaAppServiceInfo object.
TApaAppServiceInfo::Uid() returns the service UID of the service implemented by the specified application UID.
TUid aAppUid | The application specific UID. |
IMPORT_C TInt | GetAppViewIcon | ( | TUid | aAppUid, |
TUid | aViewUid, | |||
const TSize & | aSize, | |||
CApaMaskedBitmap & | aViewBitmap | |||
) | const |
Gets the icon for the specified view published by the application that has the specified UID.
The icon returned is that which is closest in size to the specified size.
TUid aAppUid | The application specific UID. |
TUid aViewUid | The UID identifying the view. |
const TSize & aSize | The requested size of the icon. |
CApaMaskedBitmap & aViewBitmap | On return, the icon that is closest in size to the requested size. |
IMPORT_C TInt | GetAppViewIcon | ( | TUid | aAppUid, |
TUid | aViewUid, | |||
HBufC *& | aFullFileName | |||
) | const |
IMPORT_C TInt | GetAppViews | ( | CApaAppViewArray & | aAppViews, |
TUid | aAppUid | |||
) | const |
Gets the views published by the application that has the specified UID.
Information on each view is contained in a TApaAppViewInfo object, and this set of objects is put into the array supplied by the caller.
CApaAppViewArray & aAppViews | On return, the array contains information on all of the views published by the specified application. |
TUid aAppUid | The application specific UID. |
IMPORT_C TInt | GetDefaultScreenNumber | ( | TInt & | aDefaultScreenNumber, |
TUid | aAppUid | |||
) | const |
Gets the default screen-number of the application with the specified UID.
IMPORT_C TInt | GetEmbeddableApps | ( | ) | const |
Initialises the process of getting all embeddable applications from the cached list.
Control panel applications are excluded.
A call to this function is followed by subsequent and repeated calls to GetNextApp() to retrieve embeddable applications in the cached list.
Only applications which specify KAppEmbeddable or KAppEmbeddableOnly in their application information file will be returned by subsequent calls to GetNextApp() .
IMPORT_C TInt | GetEmbeddableApps | ( | TInt | aScreenMode | ) | const |
TInt aScreenMode |
IMPORT_C TInt | GetFilteredApps | ( | const TApaEmbeddabilityFilter & | aFilter | ) | const |
Initialises the process of getting all applications matching aFilter in the cached list.
Control panel applications are excluded.
A call to this function is followed by subsequent and repeated calls to GetNextApp() to retrieve all applications matching aFilter in the cached list.
const TApaEmbeddabilityFilter & aFilter | Defines the filter to be applied to the cached list. |
IMPORT_C TInt | GetFilteredApps | ( | const TApaEmbeddabilityFilter & | aFilter, |
TInt | aScreenMode | |||
) | const |
const TApaEmbeddabilityFilter & aFilter | |
TInt aScreenMode |
IMPORT_C TInt | GetFilteredApps | ( | TUint | aCapabilityAttributeMask, |
TUint | aCapabilityAttributeValue | |||
) | const |
IMPORT_C TInt | GetFilteredApps | ( | TUint | aCapabilityAttributeMask, |
TUint | aCapabilityAttributeValue, | |||
TInt | aScreenMode | |||
) | const |
void | GetMainThreadIdL | ( | TThreadId & | aThreadId, |
const RProcess & | aProcess | |||
) | [private, static] |
Get the ID of the process's main thread.
TInt | GetNewBufferFromFile | ( | HBufC8 *& | aBuffer, |
const TDesC & | aFileName | |||
) | const [private] |
TInt | GetNewOpaqueData | ( | HBufC8 *& | aOpaqueData, |
TInt | aLengthOfOpaqueData | |||
) | const [private] |
Allocated a new buffer for aOpaqueData containing data fetched fronm AppArc server. Returns an error code if no opaque data could be allocated or fetched.
IMPORT_C TInt | GetNextApp | ( | TApaAppInfo & | aInfo | ) | const |
Gets information about the next application or embeddable application from the cached list.
A sequence of calls to this function must always be preceded by a call to one of GetAllApps() , GetEmbeddableApps() or GetFilteredApps() .
TApaAppInfo & aInfo | On return, contains application information. |
IMPORT_C TInt | GetNextApp | ( | TApaAppInfo & | aInfo, |
TInt | aScreenMode | |||
) | const |
TApaAppInfo & aInfo | |
TInt aScreenMode |
IMPORT_C TInt | GetPreferredBufSize | ( | TInt & | aPreferredBufSize | ) | const |
Gets the preferred number of bytes of data to read from a file for the purpose of recognizing the data type.
This should be used to determine the size of buffer to pass to the 3-parameter overload of RecognizeData() or to the 4-parameter overload of RecognizeSpecificData() .
TInt & aPreferredBufSize | On return, contains either the largest buffer size required by any of the currently installed data-recognizers, or the value that would be returned by GetMaxDataBufSize(), whichever is less. |
IMPORT_C TInt | GetServerApps | ( | TUid | aServiceUid | ) | const |
Initialises the process of getting server applications in the cached list.
Control panel applications are excluded.
A call to this function is followed by subsequent and repeated calls to GetNextApp() to retrieve server applications in the cached list.
Only applications which specify one or more services in their application information file will be returned by subsequent calls to GetNextApp() .
TUid aServiceUid |
CBufBase * | GetServiceBufferLC | ( | TInt | aOpcode, |
TUid | aUid1, | |||
TUid | aUid2 = KNullUid | |||
) | const [private] |
IMPORT_C CApaAppServiceInfoArray * | GetServiceImplementationsLC | ( | TUid | aServiceUid | ) | const |
Gets the service implementations for the specified service UID.
The returned CApaAppServiceInfoArray object contains an array of TApaAppServiceInfo objects.
Information on each implementation is contained in a TApaAppServiceInfo object.
TApaAppServiceInfo::Uid() returns the UID of the application that implements the specified service UID.
TUid aServiceUid | The service UID. |
IMPORT_C CApaAppServiceInfoArray * | GetServiceImplementationsLC | ( | TUid | aServiceUid, |
const TDataType & | aDataType | |||
) | const |
IMPORT_C TInt | GetSupportedDataTypesL | ( | CDataTypeArray & | aDataTypes | ) | const |
Gets a list of recognized data(MIME) types by all recognizers.
CDataTypeArray & aDataTypes | The array of data (MIME) types. |
IMPORT_C TInt | InsertDataMapping | ( | const TDataType & | aDataType, |
TDataTypePriority | aPriority, | |||
TUid | aUid | |||
) |
Changes an existing data type mapping, or adds a new one.
If the data type is not currently mapped, a new mapping is added. If the data type is mapped, its mapping is replaced.
const TDataType & aDataType | A new or existing data type. |
TDataTypePriority aPriority | The priority with which the application handles the data type. |
TUid aUid | The UID of the application to associate with the data type. |
IMPORT_C TInt | InsertDataMapping | ( | const TDataType & | aDataType, |
TDataTypePriority | aPriority, | |||
TUid | aUid, | |||
TUid | aServiceUid | |||
) |
Changes an existing data type mapping, or adds a new one.
If the data type is not currently mapped, a new mapping is added. If the data type is mapped, its mapping is replaced.
const TDataType & aDataType | A new or existing data type. |
TDataTypePriority aPriority | The priority with which the application handles the data type. |
TUid aUid | The UID of the application to associate with the data type. |
TUid aServiceUid | The UID of the service. |
IMPORT_C TInt | InsertDataMappingIfHigher | ( | const TDataType & | aDataType, |
TDataTypePriority | aPriority, | |||
TUid | aUid, | |||
TBool & | aInserted | |||
) |
Changes an existing data type mapping, or adds a new one. If the data type is not currently mapped, it is added. If the data type is mapped with a priority lower than aPriority, the new mapping replaces the existing one. Otherwise, no change is made.
const TDataType & aDataType | A new or existing data type. |
TDataTypePriority aPriority | The priority with which the application handles the data type. |
TUid aUid | The UID of the application to associate with the data type. |
TBool & aInserted | Non-zero if the new mapping was added or an existing mapping replaced, zero otherwise. |
IMPORT_C TInt | IsProgram | ( | const TDesC & | aFileName, |
TBool & | aProgram | |||
) | const |
Tests whether the file is a native executable (DLL or EXE).
IMPORT_C TInt | MatchesSecurityPolicy | ( | TBool & | aMatches, |
TUid | aAppUid, | |||
const TSecurityPolicy & | aSecurityPolicy | |||
) | const |
Tests whether the given TSecurityPolicy matches with the application TSecurityPolicy .
TBool & aMatches | On return, contains the result. ETrue if the application TSecurityPolicy matches the given TSecurityPolicy or else EFalse |
TUid aAppUid | Uid of the application for which the security policy has to be matched |
const TSecurityPolicy & aSecurityPolicy | TSecurityPolicy to test whether the application with given uid matches with its TSecurityPolicy or not. |
IMPORT_C void | NotifyOnDataMappingChange | ( | TRequestStatus & | aRequestStatus | ) |
Notification of changes in data-type mapping
This asynchronous function (whose corresponding "cancel" operation is CancelNotifyOnDataTypeMappingChange) completes when any data-type / application-UID association changes, i.e. when the default application handling a particular MIME-type changes.
CancelNotifyOnDataTypeMappingChange
TRequestStatus & aRequestStatus | As is normal for an asynchronous operation, this object is set to something other than KRequestPending when the asynchronous operation that has been triggered by this function completes. |
IMPORT_C TInt | NumberOfOwnDefinedIcons | ( | TUid | aAppUid, |
TInt & | aCount | |||
) | const |
Gets the number of icons defined by the app that has the specified UID
Applications that don't define icons in their application information file will return an aCount value of zero when this function is called.
IMPORT_C TInt | RecognizeData | ( | const TDesC8 & | aBuffer, |
TDataRecognitionResult & | aDataType | |||
) | const |
Gets the data (MIME) type of data passed by buffer.
const TDesC8 & aBuffer | A buffer containing data; Provide preferred size of buffer. If MIME type could not be recognized using this buffer, provide a buffer of larger size. |
TDataRecognitionResult & aDataType | On return, contains the result of the attempt to recognize data. |
IMPORT_C TInt | RecognizeData | ( | const TDesC & | aName, |
const TDesC8 & | aBuffer, | |||
TDataRecognitionResult & | aDataType | |||
) | const |
const TDesC & aName | |
const TDesC8 & aBuffer | |
TDataRecognitionResult & aDataType |
IMPORT_C TInt | RecognizeFilesL | ( | const TDesC & | aPath, |
CDataRecognitionResultArray & | aResult | |||
) | const |
Gets the data (MIME) type for files in a specified directory. Because this call may take a long time to complete, the asynchronous version is strongly recommended. Furthermore, it is not possible to use this synchronous function while an asynchronous request is still active.
const TDesC & aPath | A valid path. Note that the path must end with a backslash. |
CDataRecognitionResultArray & aResult | If the call was successful, this parameter contains the recognition result. |
IMPORT_C void | RecognizeFilesL | ( | const TDesC & | aPath, |
CDataRecognitionResultArray & | aResult, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aPath | |
CDataRecognitionResultArray & aResult | |
TRequestStatus & aStatus |
IMPORT_C TInt | RecognizeFilesL | ( | const TDesC & | aPath, |
const TDesC8 & | aDataType, | |||
CDataRecognitionResultArray & | aResult | |||
) | const |
const TDesC & aPath | |
const TDesC8 & aDataType | |
CDataRecognitionResultArray & aResult |
IMPORT_C void | RecognizeFilesL | ( | const TDesC & | aPath, |
const TDesC8 & | aDataType, | |||
CDataRecognitionResultArray & | aResult, | |||
TRequestStatus & | aStatus | |||
) |
const TDesC & aPath | |
const TDesC8 & aDataType | |
CDataRecognitionResultArray & aResult | |
TRequestStatus & aStatus |
IMPORT_C TInt | RecognizeSpecificData | ( | const TDesC & | aName, |
const TDesC8 & | aBuffer, | |||
const TDataType & | aDataType, | |||
TBool & | aResult | |||
) | const |
Tests whether data taken from a named file has the specified data (MIME) type.
const TDesC & aName | The name of the file containing the data. |
const TDesC8 & aBuffer | A buffer containing data taken from the specified file; Provide preferred size of buffer from beginning of the file. If MIME type could not be recognized using this buffer, provide a buffer of larger size. |
const TDataType & aDataType | The data (MIME) type. |
TBool & aResult | On return, contains the result of the test. |
IMPORT_C TInt | RecognizeSpecificData | ( | const RFile & | aFile, |
const TDataType & | aDataType, | |||
TBool & | aResult | |||
) | const |
IMPORT_C void | RegisterListPopulationCompleteObserver | ( | TRequestStatus & | aStatus | ) | const |
TRequestStatus & aStatus |
IMPORT_C void | RegisterNonNativeApplicationL | ( | TUid | aApplicationType, |
const TDriveUnit & | aDrive, | |||
CApaRegistrationResourceFileWriter & | aRegistrationResourceFile, | |||
CApaLocalisableResourceFileWriter * | aLocalisableResourceFile, | |||
const RFile * | aIconFile | |||
) |
TUid aApplicationType | |
const TDriveUnit & aDrive | |
CApaRegistrationResourceFileWriter & aRegistrationResourceFile | |
CApaLocalisableResourceFileWriter * aLocalisableResourceFile | |
const RFile * aIconFile |
IMPORT_C void | RegisterNonNativeApplicationTypeL | ( | TUid | aApplicationType, |
const TDesC & | aNativeExecutable | |||
) |
IMPORT_C TInt | RollbackNonNativeApplicationsUpdates | ( | ) |
Rolls back all changes made to the list of installed non-native applications since the last call to PrepareNonNativeApplicationsUpdatesL() .
This function can be called even if PrepareNonNativeApplicationsUpdatesL() hasn't been called before (in which case it does nothing).
TInt | SendReceiveWithReconnect | ( | TInt | aFunction, |
const TIpcArgs & | aIpcArgs | |||
) | const [private] |
Make a call to AppArc server's aFunction, passing it aIpcArgs.
IMPORT_C TInt | SetAcceptedConfidence | ( | TInt | aConfidence | ) |
Sets the confidence threshold for successful data recognition.
This is the minimum acceptable confidence level that must be reported by a data recognizer for data to be accepted as of a given type.
TInt aConfidence | The confidence threshold. Although this is an integer value, data recognizers use the discrete values defined by the CApaDataRecognizerType::TRecognitionConfidence enumeration. |
IMPORT_C TInt | SetAppShortCaption | ( | const TDesC & | aShortCaption, |
TLanguage | aLanguage, | |||
TUid | aAppUid | |||
) |
Sets the short caption of the application.
Overrides the short caption specified in the localizable resource file for this application. Short captions set using this API will only take effect until the next device reset.
const TDesC & aShortCaption | The short caption of the application. The maximum length allowed is KApaMaxAppCaption. |
TLanguage aLanguage | The language corresponding to the caption. If this is ELangNone the caption is used for all languages for which a language specific short caption has not been set. |
TUid aAppUid | The uid of the application. |
IMPORT_C void | SetFsSessionL | ( | RFs & | aFsSession | ) | [static] |
RFs & aFsSession |
IMPORT_C TInt | SetMaxDataBufSize | ( | TInt | aBufSize | ) |
Sets the maximum size of the data that can be read from a file for the purpose of recognizing the data type.
The value is not used when the client explicitly supplies a buffer, for example in calls to RecognizeData() and RecognizeSpecificData() , but is used in the implementation of functions such as StartDocument() and CreateDocument() .
Unless explicitly set, a default value of KApaAppListServMaxBuffer is used.
CreateDocument() StartDocument() RecognizeData() RecognizeSpecificData()
TInt aBufSize | The maximum size of data to be read. |
IMPORT_C void | SetNotify | ( | TBool | aCompleteImmediatelyIfNoScanImpendingOrInProgress, |
TRequestStatus & | aStatus | |||
) |
TBool aCompleteImmediatelyIfNoScanImpendingOrInProgress | |
TRequestStatus & aStatus |
IMPORT_C TInt | StartApp | ( | const CApaCommandLine & | aCommandLine | ) |
Starts an application defined by the specified command line information. This is an asynchronous method which doesn't wait for the process creation to complete. To be informed of the process creation success, then appropriate overloaded method taking a TRequestStatus parameter should be used.
This is only recommended for non document based applications.
View based applications are usually started by activating a specific view using CCoeAppUi::ActivateViewL. Alternatively, using StartApp() to start a view based application will activate the application's default view.
CCoeAppUi::ActivateViewL()
const CApaCommandLine & aCommandLine | The command line. |
IMPORT_C TInt | StartApp | ( | const CApaCommandLine & | aCommandLine, |
TThreadId & | aThreadId | |||
) |
const CApaCommandLine & aCommandLine | |
TThreadId & aThreadId |
IMPORT_C TInt | StartApp | ( | const CApaCommandLine & | aCommandLine, |
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) |
const CApaCommandLine & aCommandLine | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous |
TInt | StartApplicationPassingDocumentName | ( | const TDesC & | aNativeExecutableName, |
const TDesC & | aLogicalExecutableName, | |||
const TDesC8 * | aOpaqueData, | |||
const TDesC & | aDocumentName, | |||
TThreadId & | aThreadId, | |||
TApaCommand | aCommand, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
TInt | StartApplicationPassingFileHandle | ( | const TDesC & | aNativeExecutableName, |
const TDesC & | aLogicalExecutableName, | |||
const TDesC8 * | aOpaqueData, | |||
const RFile & | aFile, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous | |||
) | [private] |
IMPORT_C TInt | StartDocument | ( | const TDesC & | aDocFileName, |
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
Finds and launches an application to handle the document contained in the specified file.
const TDesC & aDocFileName | The document name. |
TThreadId & aThreadId | On return, the id of the main thread started. |
TLaunchType aUnused = ELaunchNewApp |
IMPORT_C TInt | StartDocument | ( | const TDesC & | aDocFileName, |
const TDataType & | aDataType, | |||
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
const TDesC & aDocFileName | |
const TDataType & aDataType | |
TThreadId & aThreadId | |
TLaunchType aUnused = ELaunchNewApp |
IMPORT_C TInt | StartDocument | ( | const TDesC & | aDocFileName, |
TUid | aAppUid, | |||
TThreadId & | aThreadId, | |||
TLaunchType | aUnused = ELaunchNewApp | |||
) |
const TDesC & aDocFileName | |
TUid aAppUid | |
TThreadId & aThreadId | |
TLaunchType aUnused = ELaunchNewApp |
IMPORT_C TInt | StartDocument | ( | RFile & | aDocFile, |
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous = NULL | |||
) |
RFile & aDocFile | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous = NULL |
IMPORT_C TInt | StartDocument | ( | RFile & | aDocFile, |
const TDataType & | aDataType, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous = NULL | |||
) |
RFile & aDocFile | |
const TDataType & aDataType | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous = NULL |
IMPORT_C TInt | StartDocument | ( | RFile & | aDocFile, |
TUid | aAppUid, | |||
TThreadId & | aThreadId, | |||
TRequestStatus * | aRequestStatusForRendezvous = NULL | |||
) |
RFile & aDocFile | |
TUid aAppUid | |
TThreadId & aThreadId | |
TRequestStatus * aRequestStatusForRendezvous = NULL |
TInt | TransferAndInternalizeDataL | ( | const TDesC & | aPath, |
const TInt | aRequiredBufferSize, | |||
CDataRecognitionResultArray & | aResult | |||
) | const [private] |
This function transfers the data to the client-side and "fills" the CDataRecognitionResultArray object.
const TDesC & aPath | |
const TInt aRequiredBufferSize | |
CDataRecognitionResultArray & aResult |
IMPORT_C TVersion | Version | ( | ) | const |
Gets the version of the application architecture server.
ENoMoreAppsInList = 1 |
A possible return value from GetNextApp() , to indicate that there are no more applications in the list. |
EAppListInvalid |
Indicates that an RApaLsSession member function was called before the session's application list is fully populated. |
Defines the way an application is launched. This is no longer in use. Has no effect!
ELaunchNewApp = 1 | |
ESwitchFiles |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.