diff -r 000000000000 -r fb279309251b carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/index-files/index-3.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/index-files/index-3.html Fri Apr 03 23:33:03 2009 +0100
@@ -0,0 +1,490 @@
+
+
+
+
+
+
+
+C-Index (Carbide.c++ SDK API Reference)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+A B C D E F G H I K L M N O P R S T U V W
+
+C
+
+calculateComponentLists(ICarbideBuildConfiguration, CarbideCommandLauncher) -
+Static method in class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+
+ callAbldBuildForConfiguration(ICarbideBuildConfiguration, IProgressMonitor, IConsole, int, boolean) -
+Static method in class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+Deprecated. use #invokeBuild(ICarbideBuildConfiguration, IConsole, IProgressMonitor)
instead
+canSetGeneratedHeaderFilePath() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource
+Tell whether the generated header can be set.
+ CARBIDE_BUILDER_EXTENSION_ID -
+Static variable in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+
+ CARBIDE_PROJECT_ID -
+Static variable in class com.nokia.carbide.cpp.project.core.ProjectCorePlugin
+
+ CARBIDE_PROJECT_MARKER -
+Static variable in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+
+ CARBIDE_PROJECT_NATURE_ID -
+Static variable in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+ID of the Carbide.c++ 1.2 project nature
+ CARBIDE_SBSV2_PROJECT_NATURE_ID -
+Static variable in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+ID of the Carbide.c++ SBSv2 builder project nature
+ CarbideBuilderPlugin - Class in com.nokia.carbide.cdt.builder The activator class controls the plug-in life cycle CarbideBuilderPlugin() -
+Constructor for class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+The constructor
+ CarbideCommandLauncher - Class in com.nokia.carbide.cdt.builder.builder A utility class to handle windows process execution. CarbideCommandLauncher(IProject, IProgressMonitor, IConsole, String[], IPath) -
+Constructor for class com.nokia.carbide.cdt.builder.builder.CarbideCommandLauncher
+Deprecated. don't pass in a console if you want to to get colored info/output/error streams. use CarbideCommandLauncher.CarbideCommandLauncher(IProject, IProgressMonitor, String[], IPath)
instead,
+ or pass in CUIPlugin.getDefault().getConsoleManager().getConsole(project)
+CarbideCommandLauncher(IProject, IProgressMonitor, String[], IPath) -
+Constructor for class com.nokia.carbide.cdt.builder.builder.CarbideCommandLauncher
+Create an instance of the CarbideCommandLauncher with error parsing
+ CarbideCommandLauncher(IProject, IProgressMonitor, IConsole) -
+Constructor for class com.nokia.carbide.cdt.builder.builder.CarbideCommandLauncher
+Deprecated. use CarbideCommandLauncher.CarbideCommandLauncher(IProject, IProgressMonitor, String[], IPath)
instead
+CarbideCPPBuilder - Class in com.nokia.carbide.cdt.builder.builder Main interface for invoking different build stages. CarbideCPPBuilder() -
+Constructor for class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+
+ CarbideUIPlugin - Class in com.nokia.carbide.cpp.ui The activator class controls the plug-in life cycle CarbideUIPlugin() -
+Constructor for class com.nokia.carbide.cpp.ui.CarbideUIPlugin
+The constructor
+ checkDevicesXMLSynchronized() -
+Method in interface com.nokia.carbide.cpp.sdk.core.ISDKManager
+Checks to see if the devices.xml on disk contains the same current information
+ as what we have in the sdk list.
+ checkPathWithSDKs(IPath) -
+Method in class com.nokia.carbide.cpp.sdk.ui.shared.BuildTargetsPage
+
+ clean(IProgressMonitor) -
+Method in class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+
+ CLEAN_COMPONENT_ACTION -
+Static variable in class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+
+ CLEAN_LEVEL_1 -
+Static variable in interface com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo
+
+ CLEAN_LEVEL_2 -
+Static variable in interface com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo
+
+ CLEAN_LEVEL_3 -
+Static variable in interface com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo
+
+ cleanAllComponents(ICarbideBuildConfiguration, CarbideCommandLauncher, IProgressMonitor) -
+Static method in class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+
+ cleanComponentSubset(ICarbideBuildConfiguration, CarbideCommandLauncher, IProgressMonitor) -
+Static method in class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+
+ com.nokia.carbide.cdt.builder - package com.nokia.carbide.cdt.builder com.nokia.carbide.cdt.builder.builder - package com.nokia.carbide.cdt.builder.builder com.nokia.carbide.cdt.builder.project - package com.nokia.carbide.cdt.builder.project com.nokia.carbide.cpp.epoc.engine - package com.nokia.carbide.cpp.epoc.engine com.nokia.carbide.cpp.epoc.engine.image - package com.nokia.carbide.cpp.epoc.engine.image com.nokia.carbide.cpp.epoc.engine.model - package com.nokia.carbide.cpp.epoc.engine.model com.nokia.carbide.cpp.epoc.engine.model.bldinf - package com.nokia.carbide.cpp.epoc.engine.model.bldinf com.nokia.carbide.cpp.epoc.engine.model.makefile - package com.nokia.carbide.cpp.epoc.engine.model.makefile com.nokia.carbide.cpp.epoc.engine.model.makefile.image - package com.nokia.carbide.cpp.epoc.engine.model.makefile.image com.nokia.carbide.cpp.epoc.engine.model.mmp - package com.nokia.carbide.cpp.epoc.engine.model.mmp com.nokia.carbide.cpp.epoc.engine.preprocessor - package com.nokia.carbide.cpp.epoc.engine.preprocessor com.nokia.carbide.cpp.project.core - package com.nokia.carbide.cpp.project.core com.nokia.carbide.cpp.project.core.processes - package com.nokia.carbide.cpp.project.core.processes com.nokia.carbide.cpp.project.ui.utils - package com.nokia.carbide.cpp.project.ui.utils com.nokia.carbide.cpp.sdk.core - package com.nokia.carbide.cpp.sdk.core com.nokia.carbide.cpp.sdk.ui - package com.nokia.carbide.cpp.sdk.ui com.nokia.carbide.cpp.sdk.ui.shared - package com.nokia.carbide.cpp.sdk.ui.shared com.nokia.carbide.cpp.ui - package com.nokia.carbide.cpp.ui com.nokia.carbide.template.engine - package com.nokia.carbide.template.engine com.nokia.carbide.templatewizard.process - package com.nokia.carbide.templatewizard.process com.nokia.carbide.templatewizard.processes - package com.nokia.carbide.templatewizard.processes combineBranches() -
+Method in class com.nokia.carbide.cpp.epoc.engine.preprocessor.AcceptedNodesViewFilter
+
+ combineBranches() -
+Method in class com.nokia.carbide.cpp.epoc.engine.preprocessor.AllNodesViewFilter
+
+ combineBranches() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.preprocessor.IViewFilter
+when #evaluteConditionals() returns true, then if true, then both true
+ and false branches of a test are included.
+ combineBranches() -
+Method in class com.nokia.carbide.cpp.epoc.engine.preprocessor.SharedNodesViewFilter
+
+ commit() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.IView
+Commits changes to the underlying translation unit (visible from IOwnedModel#getTranslationUnit() and IView#getFilteredTranslationUnit())
+
+ When a view is committed, changes may or may not be made to the owning model's document.
+ compileFile(IPath, ICarbideBuildConfiguration, IConsole, CarbideCommandLauncher, IProgressMonitor, boolean) -
+Static method in class com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder
+Invokes a compile of the the given file for the given build configuration.
+ concurrentBuildJobs() -
+Method in interface com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo
+Get the project setting for the maximum number or parallel make jobs
+ configFilter -
+Variable in class com.nokia.carbide.cpp.sdk.ui.shared.BuildTargetsPage.FilteringContentProviderWrapper
+
+ configureShell(Shell) -
+Method in class com.nokia.carbide.cpp.sdk.ui.shared.AddSDKDialog
+
+ console -
+Variable in class com.nokia.carbide.cdt.builder.builder.CarbideCommandLauncher
+
+ consoleErrorStream -
+Variable in class com.nokia.carbide.cdt.builder.builder.CarbideCommandLauncher
+
+ consoleInfoStream -
+Variable in class com.nokia.carbide.cdt.builder.builder.CarbideCommandLauncher
+
+ consoleOutStream -
+Variable in class com.nokia.carbide.cdt.builder.builder.CarbideCommandLauncher
+
+ context -
+Variable in class com.nokia.carbide.cdt.builder.DefaultViewConfiguration
+
+ convertExtensionTemplateFromFilesystem(IPath) -
+Method in class com.nokia.carbide.cdt.builder.BldInfViewPathHelper
+Convert the given full-path template makefile base path to the template
+ makefile-relative path.
+ convertExtensionTemplateToFilesystem(IPath) -
+Method in class com.nokia.carbide.cdt.builder.BldInfViewPathHelper
+Convert the given path (from an IExtension) into the full filesystem
+ path where its *.mk and *.meta files live.
+ convertFilesystemToWorkspace(IPath) -
+Method in class com.nokia.carbide.cdt.builder.EpocEnginePathHelper
+Convert a filesystem path to the workspace, taking care
+ to account for incorrect capitalization.
+ convertMMPToFilesystem(EMMPPathContext, IPath) -
+Method in class com.nokia.carbide.cdt.builder.MMPViewPathHelper
+Convert the given path (from an IMMPView API) into a full path
+ in the local filesystem.
+ convertMMPToProject(EMMPPathContext, IPath) -
+Method in class com.nokia.carbide.cdt.builder.MMPViewPathHelper
+Convert the given path (from an IMMPView API) into a project-relative
+ path, if possible.
+ convertMMPToWorkspace(EMMPPathContext, IPath) -
+Method in class com.nokia.carbide.cdt.builder.MMPViewPathHelper
+Convert the given path (from an IMMPView API) into a workspace-relative
+ path, if possible.
+ convertModelToProjectPath(IPath) -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.IView
+Convert a model-relative path to an project-relative path.
+ convertPathToView(IPath) -
+Method in class com.nokia.carbide.cdt.builder.EpocEnginePathHelper
+Convert a project-relative or absolute path to the
+ format expected by the view.
+ convertProjectOrFullPathToMMP(EMMPPathContext, IPath) -
+Method in class com.nokia.carbide.cdt.builder.MMPViewPathHelper
+Convert either a project-relative or a full filesystem path to an
+ MMP-appropriate path, which may either a project-relative path,
+ an EPOCROOT-relative path (with leading "/epoc32"), or an absolute (filesystem) path,
+ depending on context.
+ convertProjectToModelPath(IPath) -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.IView
+Convert a project-relative path to an model-relative path.
+ convertToFilesystem(IPath) -
+Method in class com.nokia.carbide.cdt.builder.EpocEnginePathHelper
+Convert the given path (from an IView API) into a
+ canonical full path in the local filesystem.
+ convertToProject(IPath) -
+Method in class com.nokia.carbide.cdt.builder.EpocEnginePathHelper
+Convert the given path (from an IView API) into a project-relative
+ path, if possible.
+ convertToWorkspace(IPath) -
+Method in class com.nokia.carbide.cdt.builder.EpocEnginePathHelper
+Convert the given path (from an IView API) into a workspace-relative
+ path, if possible.
+ copy() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.image.IImageSourceReference
+Copy self
+ copy() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource
+Deep copy the contents into a new multi-image source.
+ copy() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.bldinf.IExport
+
+ copy() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.bldinf.IExtension
+Return a copy of the data
+ copy() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.bldinf.IMakMakeReference
+
+ copy() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPAIFInfo
+Deep copy the contents
+ copy() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPResource
+Return copy of self
+ copyFile(URL, IFile, boolean, IProgressMonitor) -
+Method in class com.nokia.carbide.templatewizard.processes.CopyFiles
+Copy a file from the given source URL to the given workspace file.
+ CopyFiles - Class in com.nokia.carbide.templatewizard.processes Process used in templates to files in a project. CopyFiles() -
+Constructor for class com.nokia.carbide.templatewizard.processes.CopyFiles
+
+ CopyFilesAndFormatAsCpp - Class in com.nokia.carbide.cpp.project.core.processes Copy files and format per CDT tab policy CopyFilesAndFormatAsCpp() -
+Constructor for class com.nokia.carbide.cpp.project.core.processes.CopyFilesAndFormatAsCpp
+
+ CopyFilesAndUpdateSymbianOSProjectFiles - Class in com.nokia.carbide.cpp.project.core.processes Copy files and have any new mmp/mk or source files added to the bld.inf or mmp file CopyFilesAndUpdateSymbianOSProjectFiles() -
+Constructor for class com.nokia.carbide.cpp.project.core.processes.CopyFilesAndUpdateSymbianOSProjectFiles
+
+ CopyFileTree - Class in com.nokia.carbide.templatewizard.processes Process used in templates to copy a tree of files from one location to another,
+ optionally template-expanding contents along the way. CopyFileTree() -
+Constructor for class com.nokia.carbide.templatewizard.processes.CopyFileTree
+
+ CORONA_PROJECT_NATURE_ID -
+Static variable in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+ID of the Carbide.c++ 1.1/1.0 project nature
+ create(IImageMakefileView, IMultiImageSource, List<String>) -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.makefile.image.IImageBuilderCommandLineConverter
+Create a command line from the given multi-image source.
+ createBitmapSource() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource
+Create (doesn't add) a new BMP image source.
+ createBitmapSourceReference() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPAIFInfo
+create a new, empty, invalid bitmap source reference (not added)
+ createBuildInfo(Preferences, String, boolean) -
+Static method in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+
+ createBuildInfo(IProject, String) -
+Static method in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+
+ createButtonsForButtonBar(Composite) -
+Method in class com.nokia.carbide.cpp.sdk.ui.shared.AddSDKDialog
+Create contents of the button bar
+ createCarbideProjectMarker(IProject, int, String, int) -
+Static method in class com.nokia.carbide.cdt.builder.CarbideBuilderPlugin
+
+ createControl(Composite) -
+Method in class com.nokia.carbide.cpp.sdk.ui.shared.BuildTargetsPage
+see IDialogPage#createControl(Composite)
+ createDefine(String) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.preprocessor.DefineFactory
+Create a new argument-less macro definition whose expansion is implicitly "1"
+ createDefine(String, String) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.preprocessor.DefineFactory
+Create a new argument-less macro definition with the given expansion.
+ createDefine(String, String[], String) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.preprocessor.DefineFactory
+Create a function-like macro definition with the given argument
+ names and expansion.
+ createDialogArea(Composite) -
+Method in class com.nokia.carbide.cpp.sdk.ui.shared.AddSDKDialog
+Create contents of the dialog
+ createDocument() -
+Static method in class com.nokia.carbide.cpp.epoc.engine.DocumentFactory
+
+ createDocument(String) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.DocumentFactory
+
+ createExport() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.bldinf.IBldInfView
+Creates, doesn’t add
+ createExtension() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.bldinf.IBldInfView
+Create an IExtension.
+ CreateFolders - Class in com.nokia.carbide.templatewizard.processes Process used in templates to create folders in a project. CreateFolders() -
+Constructor for class com.nokia.carbide.templatewizard.processes.CreateFolders
+
+ createInstance(String, String, String, Version, String, Version, boolean) -
+Static method in class com.nokia.carbide.cpp.sdk.core.SymbianSDKFactory
+Create an new ISymbian SDK object
+ createMakefileReference() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.bldinf.IBldInfView
+Creates, doesn’t add
+ createMifConvConverter() -
+Static method in class com.nokia.carbide.cpp.epoc.engine.model.makefile.image.ImageBuilderCommandLineConverterFactory
+
+ createMMPAIFInfo() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPView
+create an empty, invalid AIF info instance (not set)
+ createMMPBitmap() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPView
+create a new, empty, invalid bitmap entry (not added)
+ createMMPReference() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.bldinf.IBldInfView
+Creates, doesn’t add
+ createMMPResource() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPView
+create a new, empty, invalid MMP resource (not added).
+ createModel(IPath, IDocument) -
+Method in class com.nokia.carbide.cpp.epoc.engine.model.BldInfModelFactory
+
+ createModel(IPath, IDocument) -
+Method in class com.nokia.carbide.cpp.epoc.engine.model.BSFModelFactory
+
+ createModel(IPath, IDocument) -
+Method in class com.nokia.carbide.cpp.epoc.engine.model.ImageMakefileModelFactory
+
+ createModel(IPath, IDocument) -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.IModelFactory
+Create a model
+ createModel(IPath) -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.IModelProvider
+Create a new model with an empty document, which is slated to live
+ at the given workspace path.
+ createModel(IPath, IDocument) -
+Method in class com.nokia.carbide.cpp.epoc.engine.model.MakefileModelFactory
+
+ createModel(IPath, IDocument) -
+Method in class com.nokia.carbide.cpp.epoc.engine.model.MMPModelFactory
+
+ createModel(IPath, IDocument) -
+Method in class com.nokia.carbide.cpp.epoc.engine.model.PKGModelFactory
+
+ createModelProvider(IModelFactory) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.model.ModelProviderFactory
+Create the appropriate model provider based on whether the platform is running.
+ createMultiImageSource(boolean, boolean, boolean) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.image.MultiImageSourceFactory
+
+ createMultiImageSource() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.makefile.image.IImageMakefileView
+Create a new, invalid multi-image source (not added)
+ createNewConfiguration(ISymbianBuildContext, boolean) -
+Method in interface com.nokia.carbide.cdt.builder.project.ICarbideProjectModifier
+Creates a new configuration and writes it to disk.
+ createProject(String, String) -
+Static method in class com.nokia.carbide.cpp.project.core.ProjectCorePlugin
+Creates an Eclipse project with the given name and location.
+ createProjectInfo(ICProjectDescription) -
+Method in interface com.nokia.carbide.cdt.builder.ICarbideBuildManager
+Creates a minimal Carbide.c++ project
+ CreateRezId - Class in com.nokia.carbide.cpp.project.core.processes Process used in templates to create a 4 character string based on the project name,
+ which is used in the main resource file in the NAME statement. CreateRezId() -
+Constructor for class com.nokia.carbide.cpp.project.core.processes.CreateRezId
+
+ createSimpleFreeformDefine(String) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.preprocessor.DefineFactory
+Create a define from an argument-less macro definition, which may include an "=" or a space
+ and an expansion.
+ createStandaloneModelProvider(IModelFactory) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.model.ModelProviderFactory
+
+ createSVGSource() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource
+Create (doesn't add) a new SVG image source.
+ CreateTemplateVariable - Class in com.nokia.carbide.templatewizard.processes Process used in templates to create variables used for
+ text substitution in other template files. CreateTemplateVariable() -
+Constructor for class com.nokia.carbide.templatewizard.processes.CreateTemplateVariable
+
+ createUnknownImageSource() -
+Method in interface com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource
+Create (doesn't add) an unknown image source.
+ createView(IViewConfiguration) -
+Method in interface com.nokia.carbide.cpp.epoc.engine.model.IModel
+Creates a view onto the contents of the model using the given configuration and filter.
+ createWorkspaceModelProvider(IModelFactory) -
+Static method in class com.nokia.carbide.cpp.epoc.engine.model.ModelProviderFactory
+
+
+
+
+
+
+
+
+
+
+
+
+A B C D E F G H I K L M N O P R S T U V W
+
+
+