|
Carbide.c++ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISymbianSDK
This interface provides details on a single Symbian OS SDK. Notes on return values for unknown/undefined items: - String value are empty "" - IPath and IFile objects are null - containers have zero size
Field Summary | |
---|---|
static java.lang.String |
EKA1_A_BRANCH_IDENTIFIER
Branch identifier to note Beech branch, OS 8.1a and prior |
static java.lang.String |
EKA1_S_BRANCH_IDENTIFIER
Branch identifier to note S branch, OS 7.0x |
static java.lang.String |
EKA2_B_BRANCH_IDENTIFIER
Branch identifier to note Cedar branch, OS 8.0b and later (not used for OS 9.x and greater) |
static java.lang.String |
PUBLISHER_NOKIA
|
static java.lang.String |
PUBLISHER_SYMBIAN
|
static java.lang.String |
PUBLISHER_UIQ
|
static java.lang.String |
S60_FAMILY_ID
|
static java.lang.String |
S60_SDK_NAME
|
static java.lang.String |
S80_FAMILY_ID
|
static java.lang.String |
S80_SDK_NAME
|
static java.lang.String |
SERIES60_FAMILY_ID
|
static java.lang.String |
SERIES60_SDK_NAME
|
static java.lang.String |
TECHVIEW_FAMILY_ID
|
static java.lang.String |
TECHVIEW_SDK_NAME
|
static java.lang.String |
UIQ_FAMILY_ID
|
static java.lang.String |
UIQ_SDK_NAME
|
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getAvailablePlatforms()
Returns the list of all available platforms for this SDK. |
IBSFCatalog |
getBSFCatalog()
Get the BSF catalog for the SDK. |
java.util.Date |
getCreationDate()
Get the creation date of the manifest.xml |
java.lang.String |
getEPOCROOT()
Returns the absolute path to the epoc32 directory of this SDK. |
java.lang.String |
getFamily()
Returns the family name of this SDK. |
java.util.List<ISymbianBuildContext> |
getFilteredBuildConfigurations()
Returns the filtered list of build configurations for this SDK. |
IPath |
getIncludePath()
Returns an IPath for the epoc32\include directory of this SDK. |
java.io.File |
getLicenseFile()
Get the licese file location in the SDK. |
java.lang.String |
getName()
Returns the display name of this SDK. |
Version |
getOSVersion()
Returns the OS version string of this SDK. |
java.util.List<java.lang.String> |
getPlatformMacros(java.lang.String platform)
Returns the list of all platform macros for this SDK. |
java.io.File |
getPrefixFile()
Returns the File object for the prefix file for this SDK. |
java.util.List<IDefine> |
getProjectVariantHRHDefines()
Deprecated. use ISymbianBuildContext.getVariantHRHDefines() instead. This was moved because the include paths
in which to find any header files included from the main .hrh file may be build configuration specific. |
java.util.List<java.lang.String> |
getProjectVariantHRHMacros()
Deprecated. use #getProjectVariantHRHDefines() which returns a list of IDefine instead. |
java.lang.String |
getPublisherName()
Get the publisher name present in manifest.xml |
java.net.URL |
getPublisherURL()
Get the HTTP location for the SDK publisher. |
IPath |
getReleaseRoot()
Returns an IPath for the epoc32\release directory of this SDK. |
boolean |
getRequiresRestart()
Deprecated. |
java.lang.String |
getSDKDescription()
|
java.lang.String |
getSDKOSBranch()
Get the branch qualifier for the OS. |
Version |
getSDKVersion()
Returns the SDK version string of this SDK. |
java.util.List<java.lang.String> |
getSupportedTargetTypes()
Get a list of supported targettypes listed by this SDK. |
java.util.List<java.lang.String> |
getTargetTypeMacros(java.lang.String targettype)
Get a list of macros specific to the given target type, e.g. |
IPath |
getToolsPath()
Returns an IPath for the epoc32\tools directory of this SDK. |
java.util.List<ISymbianBuildContext> |
getUnfilteredBuildConfigurations()
Returns the unfiltered list of build configurations for this SDK. |
java.lang.String |
getUniqueId()
Returns the unique id of this SDK. |
java.util.List<java.lang.String> |
getVariantCFGMacros()
Returns a list of the macros defined in the variant.cfg file. |
java.lang.String |
getVendor()
Returns the vendor name of this SDK. |
java.util.List<java.lang.String> |
getVendorSDKMacros()
Get a list of macros that are used to distinguish this SDK. |
boolean |
isDefaultSDK()
Returns whether or not this is the default SDK in the devices.xml file. |
boolean |
isEKA1()
Tell if the SDK is EKA1 |
boolean |
isEKA2()
Tell if the SDK is EKA2 |
boolean |
isEnabled()
Returns true if the SDK is enabled, false otherwise. |
boolean |
isS60()
Tell if the SDK is Series60 |
boolean |
isValid()
Returns true if the SDK is configured properly, false otherwise. |
void |
scanSDK()
Scans/Rescans the SDK for info such as prefix file, variant macros, manifest.xml, etc. |
void |
setCreateDate(java.util.Date createDate)
|
void |
setEnabled(boolean enable)
Marks the SDK as enabled or disabled |
void |
setEPOCROOT(java.lang.String epocRoot)
|
void |
setIsDefaultSDK(boolean isDefault)
|
void |
setLicenseFile(java.io.File licenseFile)
|
void |
setName(java.lang.String name)
|
void |
setOSSDKBranch(java.lang.String branch)
|
void |
setOSVersion(Version osVer)
|
void |
setPrefixFile(IPath prefixFile)
|
void |
setPublisherName(java.lang.String pubName)
|
void |
setPublisherURL(java.net.URL pubURL)
|
void |
setSDKDescription(java.lang.String descr)
|
void |
setSDKVersion(Version sdkVers)
|
void |
setSupportsWINSCW_UREL(boolean isSupported)
Set the flag wheter or not this SDK has WINSCW UREL binary support |
void |
setUniqueID(java.lang.String id)
|
boolean |
supportsWINSCW_UREL()
Get whether or not this SDK has WINSCW UREL binary support |
java.util.List<java.lang.String> |
validationErrors()
Returns a list of human readable error strings desribing why the SDK is not configured properly. |
Field Detail |
---|
static final java.lang.String EKA1_A_BRANCH_IDENTIFIER
static final java.lang.String EKA1_S_BRANCH_IDENTIFIER
static final java.lang.String EKA2_B_BRANCH_IDENTIFIER
static final java.lang.String SERIES60_FAMILY_ID
static final java.lang.String S60_FAMILY_ID
static final java.lang.String S80_FAMILY_ID
static final java.lang.String UIQ_FAMILY_ID
static final java.lang.String TECHVIEW_FAMILY_ID
static final java.lang.String SERIES60_SDK_NAME
static final java.lang.String S60_SDK_NAME
static final java.lang.String S80_SDK_NAME
static final java.lang.String UIQ_SDK_NAME
static final java.lang.String TECHVIEW_SDK_NAME
static final java.lang.String PUBLISHER_NOKIA
static final java.lang.String PUBLISHER_UIQ
static final java.lang.String PUBLISHER_SYMBIAN
Method Detail |
---|
boolean isValid()
true
if the SDK is configured properly, and
false
otherwisejava.util.List<java.lang.String> validationErrors()
isValid()
boolean isEnabled()
true
if the SDK is enabled, and
false
otherwisevoid setEnabled(boolean enable)
enable
- whether to enable or disable the SDKjava.util.List<java.lang.String> getPlatformMacros(java.lang.String platform)
This is somewhat equivalent to calling "bldmake plat" on the command line These are the macros that can be used in MMP and INF files. They are only given by name (no value)
platform
- the platform name
java.util.List<java.lang.String> getProjectVariantHRHMacros()
Macros follow the form of a #define statement, excluding the "#define", e.g.:
"FOO", "BAR=1", "_INCLUDE_=\"\\mydir\\prefix.hrh\\\"", "INCLUDE(x)=\epoc32\include\##x"
java.util.List<IDefine> getProjectVariantHRHDefines()
ISymbianBuildContext.getVariantHRHDefines()
instead. This was moved because the include paths
in which to find any header files included from the main .hrh file may be build configuration specific.
java.util.List<java.lang.String> getVariantCFGMacros()
java.util.List<java.lang.String> getVendorSDKMacros()
java.util.List<java.lang.String> getAvailablePlatforms()
java.util.List<ISymbianBuildContext> getFilteredBuildConfigurations()
Build configs to disply can be filtered by the user using a global preference page.
java.util.List<ISymbianBuildContext> getUnfilteredBuildConfigurations()
Build configs to disply can be filtered by the user using a global preference page.
java.lang.String getUniqueId()
java.lang.String getName()
java.lang.String getVendor()
java.lang.String getFamily()
java.lang.String getEPOCROOT()
boolean isDefaultSDK()
true
if the SDK is the default, and
false
otherwiseVersion getOSVersion()
Version getSDKVersion()
java.io.File getPrefixFile()
null
if there isn't one for this SDK.IPath getToolsPath()
null
.IPath getReleaseRoot()
null
.IPath getIncludePath()
null
.java.lang.String getSDKDescription()
java.util.Date getCreationDate()
java.io.File getLicenseFile()
java.lang.String getSDKOSBranch()
java.net.URL getPublisherURL()
java.lang.String getPublisherName()
java.util.List<java.lang.String> getSupportedTargetTypes()
java.util.List<java.lang.String> getTargetTypeMacros(java.lang.String targettype)
targettype
-
@Deprecated boolean getRequiresRestart()
void setLicenseFile(java.io.File licenseFile)
void setPrefixFile(IPath prefixFile)
void setOSVersion(Version osVer)
void setSDKVersion(Version sdkVers)
void setPublisherURL(java.net.URL pubURL)
void setCreateDate(java.util.Date createDate)
void setOSSDKBranch(java.lang.String branch)
void setIsDefaultSDK(boolean isDefault)
void setSDKDescription(java.lang.String descr)
void setPublisherName(java.lang.String pubName)
void setUniqueID(java.lang.String id)
void setEPOCROOT(java.lang.String epocRoot)
void setName(java.lang.String name)
boolean isEKA1()
boolean isEKA2()
boolean isS60()
boolean supportsWINSCW_UREL()
void setSupportsWINSCW_UREL(boolean isSupported)
isSuported
- void scanSDK()
IBSFCatalog getBSFCatalog()
|
Carbide.c++ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |