# HG changeset patch # User dadubrow # Date 1277238387 18000 # Node ID 13b01d8765f45fead251c63e5d6e27b20cbe6196 # Parent 2786ba7415f3606c3e590cb97c8f3a8dc3b6bd61# Parent 0142b520a1312cffee420111518d444dc921ee8f merge diff -r 2786ba7415f3 -r 13b01d8765f4 core/com.nokia.carbide.cpp.doc.user/html/concepts/AIFDefWizard.html --- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/AIFDefWizard.html Tue Jun 22 15:25:44 2010 -0500 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,71 +0,0 @@ - - -
-- The AIF, or application information file, is a Symbian OS-specific file - format. An AIF file contains information about captions, icons, capabilities - and MIME priority support used by the application. The MMP editor provides support for the AIF editor in the Sources > Resources group.
-- NOTE AIF files are used only for Symbian OS versions before 9.1. -
-- The kind of information an AIF file can contain are:
-- Icons: Icons are used to represent applications and - their associated document files in the system shell or application launcher. If - the phone's UI supports embedding, icons may also be used to represent embedded - documents. -
-- The source files for icons are .bmp bitmaps. These source files are - built into a single .mbm file (Symbian OS multiple bitmap file) which is - incorporated into the aif file as part of the build process. -
-- Captions: A caption is the text displayed beside its - icon. Typically it is the application's name.
-- Captions for multiple languages can be defined in a single aif, and - the one corresponding to the current system language will be used. In some UIs, - captions may be defined in a caption file, separate from the aif file. -
-- MIME Support: Multipurpose Internet Mail Extensions, - MIMEs, define a file format for transferring non-ASCII data, such as graphics, - audio and fax, over the Internet. The AIF file lists the MIME types that the - application supports, and the priority of support that each type is given. When - a file is opened, Symbian OS launches the application which has the highest - priority of support for the type of data in the file. -
-- Given two applications with the same MIME type priority, Symbian OS - arbitrarily launches one of them. -
-MBM, or multi-bitmap, is a Symbian OS-specific bitmap file format. This - file contains multiple bitmaps and it can contain both bitmaps with masks and + file contains multiple bitmaps and can contain bitmaps with masks and bitmaps without masks. It optimizes the bitmap handling capability of Symbian OS. The MMP Editor (in Sources tab > Resources > Bitmaps) and Symbian Project Navigator view provide support for creating and editing MBM files. In the Symbian Project Navigator view you can right-click on a scalable icon makefile (for example, Icons_scalable_dc.mk) and select Add MBM/MIF Entry... to open the Edit MBM/MIF Contents window.
diff -r 2786ba7415f3 -r 13b01d8765f4 core/com.nokia.carbide.cpp.doc.user/html/concepts/Modify.html --- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/Modify.html Tue Jun 22 15:25:44 2010 -0500 +++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/Modify.html Tue Jun 22 15:26:27 2010 -0500 @@ -21,8 +21,7 @@ + diff -r 2786ba7415f3 -r 13b01d8765f4 core/com.nokia.carbide.cpp.doc.user/html/concepts/build_configurations.htm --- a/core/com.nokia.carbide.cpp.doc.user/html/concepts/build_configurations.htm Tue Jun 22 15:25:44 2010 -0500 +++ b/core/com.nokia.carbide.cpp.doc.user/html/concepts/build_configurations.htm Tue Jun 22 15:26:27 2010 -0500 @@ -14,20 +14,20 @@Build configurations are defined when the project is created. A project can have any number of build configurations and more can be added as necessary. Each build configuration can have its own combination of tool settings to precisely control how it is defined and built. Build configurations are maintained in the project Properties window in the Carbide Build Configurations panel. To open the panel, select a project in the Symbian Project Navigator or Project Explorer view and select Project > Properties or right-click and select Properties.
-You can select a build configuration in the Active Configuration dropdown list or use the Project > Active Configuration menu option to set which build configuration to launch when running or debugging a program. The currently selected project can be launched by clicking the Run () or Debug (
) control on the tool bar to launch the project with the currently active build configuration. When no project is selected the last project debugged will be launched.
Build configurations are defined when the project is created. A project can have any number of build configurations and more can be added as necessary. Each build configuration can have its own combination of tool settings to precisely control how it is defined and built. Build configurations are maintained in the project Properties window in the Carbide Build Configurations panel. To open the panel, select a project in the Project Explorer or Symbian Project Navigator view and select Project > Properties or right-click and select Properties.
+You can select a build configuration in the Active Configuration group or use the Project > Active Configuration menu option to set which build configuration to launch when running or debugging a program. The currently selected project can be launched by clicking the Run () or Debug (
) control on the tool bar to launch the project with the currently active build configuration. When no project is selected the last project debugged will be launched.
If no launch configuration is present in the project, one is created on initial launch. Subsequent launches of the project will use either the last launch configuration or if more than one launch configuration exists, it uses the most correct one.
NOTE The Carbide Run and Debug buttons are shaded in blue to indicate their behavior differs from the standard Eclipse behavior.
-Item | Explanation | ||
---|---|---|---|
Active Configuration | -The Active Configuration drop down list allows you to select a configuration that is currently available for the selected project. The entries in the related sub-panes will change according to the selected configuration. The Configuration name consists of a target name and an SDK identifier in brackets. | +Configuration | +The Configuration drop down list allows you to select a configuration that is currently available for the selected project. The entries in the related sub-panes will change according to the selected configuration. The Configuration name consists of a target name and an SDK identifier in brackets. |
Manage... | @@ -35,17 +35,17 @@
When the Carbide.c++ IDE creates an build configuration it uses a standard naming convention to make it easy to identify. For example, HelloCarbide S60 5.0 Emulator Debug is a typical configuration name. The default name follows the form of:
+When the Carbide.c++ IDE creates an build configuration it uses a standard naming convention to make it easy to identify. For example, HelloCarbide (armv5_udeb) Emulator Debug is a typical configuration name. The default name follows the form of:
You can use the Debug window to edit the default build configuration names.
The plug-ins simplify Symbian OS development by removing the need to use command line build tools, and provide a graphical interface to Symbian OS - specific file formats, such as AIF and MBM.
+ specific file formats, such as MBM.The plug-ins provide a new perspective, called the Carbide.c++ Perspective, on the Eclipse workbench. This perspective enhances the standard CDT C/C++ perspective by allowing you to select easily the SDKs and build target types @@ -24,7 +24,6 @@
The following topics discuss these concepts in more detail:
Other revision systems are also supported but require the downloading of an Eclipse plug-in to add that capability to Carbide. Visit the eclipse-plugins.2y.net sites to locate the plug-ins you need.
+Other revision systems are also supported but require the downloading of an Eclipse plug-in to add that capability to Carbide. Visit the eclipse-plugins.2y.net sites to locate the plug-ins you need.
+The SCM you install normally adds its commands to the Team sub-menu in the Project Explorer view's context menu (Figure 1). Some SCM's install their own menu to Carbide. If this is the case, refer to the documentation included with the plug-in for details.
+Figure 1. Team sub-menu
This section only applies to the SBSv1 (abld) build system. If you are using the Raptor (SBSv2) build system Carbide does not perform any build system modifications to optimize dependency tracking.
-Carbide has made some performance improvements over command-line builds when performing incremental builds. Once a project has been built, many users invoke 'abld build' on their project, not knowing that their makefiles are regenerated each time, taking a large performance hit. Although a command-line user can invoke 'abld target' to improve incremental build performance, Carbide invokes each build stage independently for a full incremental build (including the 'abld makefile' stage). In order to get around this performance hit from the IDE, Carbide manages the source and resource dependencies in separate .d (dependency) files generated under the build system. Then Carbide makes a small modification to each component's (MMP) makefile under the \epoc32\build\ directory by including the generated .d files as dependency includes. This performance modification makes incremental builds faster from Carbide.
-Normally, you do not need to know the details of dependency management unless you first build from the command-line and then try to build their project from the IDE. When this happens, Carbide will prompt you with the Project rebuild notification dialog when you initiate a build from the IDE.
-Figure 1 -Dependency Tracking dialog
-It is recommended you choose the Improve Carbide build times option if you plan to continue building in Carbide. However, be cautious of this as Carbide will remove all the object code and build everything from scratch.
-If you choose the option Do not update dependencies, Carbide disables the option to manage dependencies under the Carbide Project Settings, SBSv1 tab.
-- Add scalable graphics (MIF), Symbian OS bitmaps (MBM) and application information (AIF) - resources to projects, and edit these resources. You can add these using the New command, which is available on the File menu, and on the pop-up menus of the C/C++ Projects and Navigator views. MBM, MIF and AIF editors are provided to modify + Add scalable graphics (MIF) and Symbian OS bitmaps (MBM) to projects, and edit these resources. You can add these using the New command, which is available on the File menu, and on the pop-up menus of the Project Explorer and Symbian Project Navigator views. MBM and MIF editors are provided to modify the resources.
- For more information, see Creating an MBM File and Creating an AIF File. -
+ For more information, see Creating an MBM File.
diff -r 2786ba7415f3 -r 13b01d8765f4 core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml
--- a/core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml Tue Jun 22 15:25:44 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/context_help/carbide_ide_dialogs_help.xml Tue Jun 22 15:26:27 2010 -0500
@@ -349,19 +349,10 @@
- The AIF Editor allows you to specify the Symbian OS - resource file and bitmaps that should be included in a Symbian OS application - information (AIF) file. Use of AIF files is restricted to using .bmp files and works for versions 2.x and later releases of the Symbian OS SDKs. For more information, see AIF File.
-- The AIF Editor is shown when a new AIF file is created or an existing file is edited in the Resources group of the MMP editor's Sources tab. Refer to Creating an AIF File for more information.
- -Item | -Explanation | -
---|---|
Target File | -Specifies the filename of the compiled AIF file, relative to the target path. Click the untitled.aif button to set the target file based on the SDK and project name. |
-
Resource File Path | -Choose a resource file from the current project, browse the file system or enter the path. For relative paths use the Carbide project as the reference point, not the MMP file location. | -
Up | -Select an image in the list and click Up to move the selection one position up in the list. | -
Down | -Select an image in the list and click Down to move the selection one position down in the list. |
-
Pair Image and Mask | -Select two adjacent unpaired BMP image entries in the list and click this button to combine the images together into image/mask pairs. | -
Split Image and Mask | -Select a paired BMP image in the list and click this button to split the image into image and mask entries. | -
Swap Image and Mask | -Select a paired BMP image in the list and click this button to swap the image and mask files and format information in paired image entries. | -
Add From Project | -Click this button to open an Add Images from Project dialog to reference available images in the project. | -
Add From Filesystem | -Click this button to open an Add Images From Filesystem dialog to locate and reference existing images in the filesystem or copy images to the project. | -
Remove | -Select an image and click Remove to remove image entry from the list. This does not delete file from directory. | -
Color depth | -Select the bit depth used to encode the image at build time. | -
Mask depth | -Select the bit depth used to encode the mask at build time. Options include: -
|
-
Color format | -Select Color to encode the image(s) as color or select Grayscale to encode the image(s) as grayscale. | -
Preview | -A preview of the image as it will appear at runtime. | -
-
Resources
- Add, remove, or edit resources, bitmaps, languages, and AIF files to be compiled with your project.
The Add Images from Filesystem dialog allows you to search for and add images currently available in the filesystem. Select an image and click OK to add the image.
-NOTE Information displayed under Help group will vary slightly depending upon whether this dialog was called from a MBM, MIF, or AIF editor.
-NOTE Information displayed under Help group will vary slightly depending upon whether this dialog was called from a MBM or MIF editor.
+Figure 1 - Add Images from Filesystem
The Environment Variables pane allows you to view the current User and System environment variables that will be used when any abld command is invoked. User variables are modified or added when a process is invoked. Read only system variables are listed. Variables and values in bold are items that have been modified from their default values.
-Some variables have special meaning, including:
-Figure 1 - Environment Variables
-Item | -Explanation | -
---|---|
New | -Click to add a new environment variable. You must specify a name and a value. | -
Edit | -Allows you to edit the name and value of an environment variable. | -
Undefine | -Undefines the selected variable so that it is not used during a build. -NOTE Some variables, like PATH, EPOCROOT, and those beginning with MW* have special meaning and cannot be undefined. |
-
Variable use | -Shows the use for the selected variable. Uses include: -
|
-
The Environment Variables pane allows you to view the current User and System environment variables that will be used when any abld command is invoked. User variables are modified or added when a process is invoked. Read only system variables are listed. Variables and values in bold are items that have been modified from their default values.
+Some variables have special meaning, including:
+Figure 1 - Environment Variables
+Item | +Explanation | +
---|---|
New | +Click to add a new environment variable. You must specify a name and a value. | +
Edit | +Allows you to edit the name and value of an environment variable. | +
Undefine | +Undefines the selected variable so that it is not used during a build. +NOTE Some variables, like PATH, EPOCROOT, and those beginning with MW* have special meaning and cannot be undefined. |
+
Variable use | +Shows the use for the selected variable. Uses include: +
|
+
The Paths and Symbols pane shows the paths and symbols used to the build the project index. This is a read-only list based on the setting of the Build configuration for the indexer option in the C/C++ General > Indexer panel. Carbide now caches the paths and symbols which persist between debug sessions. If any of the files like bld.inf, MMP, or any of their include files change, the list is automatically recalculated and CDT notified.
-To change what appears in the list:
-You can also specify a macro file using the Carbide Macro Settings page in the Properties for project dialog.
-Figure 1 - Paths and Symbols pane
-The Paths and Symbols pane shows the paths and symbols used to the build the project index. This is a read-only list based on the setting of the Build configuration for the indexer option in the C/C++ General > Indexer panel. Carbide now caches the paths and symbols which persist between debug sessions. If any of the files like bld.inf, MMP, or any of their include files change, the list is automatically recalculated and CDT notified.
+To change what appears in the list:
+You can also specify a macro file using the Macro Settings page in the Properties for project dialog.
+Figure 1 - Paths and Symbols pane
+The Macro Settings properties page allows you to specify a file containing macros that CDT uses to parse the source code.
Figure 1 - Carbide Macros Settings panel
-Figure 1 - Macros Settings panel
+Item | @@ -34,8 +34,7 @@
---|
Item | -Explanation | -
---|---|
SIS File Creation Options | -Define the SIS file created: -
|
-
Signing Options | -Defines the signing options applied to the configuration. The options include: -
Enter the required information into the enabled fields based on the signing option selected above: -
NOTE On Symbian OS 9.x builds, if the key/cert pair are not defined, makekeys will be called and temporary ones will be generated for you to "self-sign" the application. Self-signed applications should be in the - 0xE0000000-0xEFFFFFFF range. -NOTE All Application TRK build configuration require a PKG file. If none is found in the active project then you will be asked to choose one. |
-
Use the SIS Properties dialog to specify SIS file creation and signing options for the selected SIS file included in the project.
+Figure 1 - SIS Properties dialog
+Item | +Explanation | +
---|---|
SIS File Creation Options | +Define the SIS file created: +
|
+
Signing Options | +Defines the signing options applied to the configuration. The options include: +
Enter the required information into the enabled fields based on the signing option selected above: +
NOTE On Symbian OS 9.x builds, if the key/cert pair are not defined, makekeys will be called and temporary ones will be generated for you to "self-sign" the application. Self-signed applications should be in the + 0xE0000000-0xEFFFFFFF range. +NOTE All Application TRK build configuration require a PKG file. If none is found in the active project then you will be asked to choose one. |
+
To build all target build configurations enabled for the current project.
-Figure 1. Build All Configurations menu
Figure 1 shows the Dissassembly view stopped at a breakpoint.
-Figure 1 - Disassembly view
Figure 2 shows the context menu that appears when you right-click in the Dissassembly pane. Right-clicking the left border opens the breakpoint context menu in Figure 3.
The MIF Editor allows you to create or edit the .mif files list of scalable icons (.svg) - included in a S60 v3.0 and later GUI projects as well as standard .bmp files. A .mif file is a MSX Interchange Format (MIF) file that should be built by the project. MIF files replace the functionality of AIF (and MBM) files.
-NOTE This editor is only supported by the S60 3.0 and later SDKs.
-NOTE For resources that are included after creating a project, you should ensure that the output location is set correctly by viewing the file properties. The output location is set to "{EPOCROOT}\epoc32\include" by default, so if an alternate location is required you can set this in the file properties.
-Figure 1 - MIF File in the Symbian Project Navigator view
-The MIF Editor appears when a MIF file is - opened for editing. To open the editor double-click on a .mif file in the Symbian Project Navigator view (figure 1), or select a scalable icon makefile (for example, Icons_scalable_dc.mk), right-click and select the Add MBM/MIF Entry command.
-
Figure 2 - MBM/MIF Editor
-Item | -Explanation | -
---|---|
Target File | -Specifies the EPOCROOT relative path for the compiled images. Click the Default button to set the target file based on the SDK and project name. |
-
Header File | -Shows the generated header file. Select the Header option in the Header Generation group to create a default .mbg file. The path cannot be edited in this field. | -
Header Generation | -Options include: -
|
-
Up | -Select an image in the list and click Up to move the selection one position up in the list. | -
Down | -Select an image in the list and click Down to move the selection one position down in the list. |
-
Pair Image and Mask | -Select two adjacent unpaired BMP image entries in the list and click this button to combine the images together into image/mask pairs. | -
Split Image and Mask | -Select a paired BMP image in the list and click this button to split the image into image and mask entries. | -
Swap Image and Mask | -Select a paired BMP image in the list and click this button to swap the image and mask files and format information in paired image entries. | -
Add From Project | -Click this button to open the Add Images from Project dialog to reference available images in the project. | -
Add From Filesystem | -Click this button to open the Add Images From Filesystem dialog to locate and reference existing images in the filesystem or copy images to the project. | -
Remove | -Select an image and click Remove to remove image entry from the list. This does not delete file from directory. | -
Color depth | -Select the bit depth used to encode the image at build time. | -
Mask depth | -Select the bit depth used to encode the mask at build time. Options include: -
|
-
Color format | -Select Color to encode the image(s) as color or select Grayscale to encode the image(s) as grayscale. | -
Set from image | -Click this button to auto-detect the image depth, mask depth, and color/grayscale setting from the image contents. | -
Preview | -A preview of the image as it will appear at runtime. | -
- - - - + + +
The MIF Editor allows you to create or edit the .mif files list of scalable icons (.svg) + included in a S60 v3.0 and later GUI projects as well as standard .bmp files. A .mif file is a MSX Interchange Format (MIF) file that should be built by the project.
+NOTE This editor is only supported by the S60 3.0 and later SDKs.
+NOTE For resources that are included after creating a project, you should ensure that the output location is set correctly by viewing the file properties. The output location is set to "{EPOCROOT}\epoc32\include" by default, so if an alternate location is required you can set this in the file properties.
+Figure 1 - MIF File in the Symbian Project Navigator view
+The MIF Editor appears when a MIF file is + opened for editing. To open the editor double-click on a .mif file in the Symbian Project Navigator view (figure 1), or select a scalable icon makefile (for example, Icons_scalable_dc.mk), right-click and select the Add MBM/MIF Entry command.
+
Figure 2 - MBM/MIF Editor
+Item | +Explanation | +
---|---|
Target File | +Specifies the EPOCROOT relative path for the compiled images. Click the Default button to set the target file based on the SDK and project name. |
+
Header File | +Shows the generated header file. Select the Header option in the Header Generation group to create a default .mbg file. The path cannot be edited in this field. | +
Header Generation | +Options include: +
|
+
Up | +Select an image in the list and click Up to move the selection one position up in the list. | +
Down | +Select an image in the list and click Down to move the selection one position down in the list. |
+
Pair Image and Mask | +Select two adjacent unpaired BMP image entries in the list and click this button to combine the images together into image/mask pairs. | +
Split Image and Mask | +Select a paired BMP image in the list and click this button to split the image into image and mask entries. | +
Swap Image and Mask | +Select a paired BMP image in the list and click this button to swap the image and mask files and format information in paired image entries. | +
Add From Project | +Click this button to open the Add Images from Project dialog to reference available images in the project. | +
Add From Filesystem | +Click this button to open the Add Images From Filesystem dialog to locate and reference existing images in the filesystem or copy images to the project. | +
Remove | +Select an image and click Remove to remove image entry from the list. This does not delete file from directory. | +
Color depth | +Select the bit depth used to encode the image at build time. | +
Mask depth | +Select the bit depth used to encode the mask at build time. Options include: +
|
+
Color format | +Select Color to encode the image(s) as color or select Grayscale to encode the image(s) as grayscale. | +
Set from image | +Click this button to auto-detect the image depth, mask depth, and color/grayscale setting from the image contents. | +
Preview | +A preview of the image as it will appear at runtime. | +
+ + + + \ No newline at end of file diff -r 2786ba7415f3 -r 13b01d8765f4 core/com.nokia.carbide.cpp.doc.user/html/tasks/AppInfoFile.html --- a/core/com.nokia.carbide.cpp.doc.user/html/tasks/AppInfoFile.html Tue Jun 22 15:25:44 2010 -0500 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ - -
- The AIF Definition File wizard creates a file that - specifies an AIF file to be built as part of the project. An AIF file is a - Symbian OS application information file, which describes an application's icons - and properties. For more information, see Concepts >AIF File.
-NOTE AIF files are used only for projects created for Symbian OS versions - before v9.1.
-- Open the MMP file associated with the project in the Symbian Project Navigator (double-click on MMP file or right-click and select Open).
- -Figure 1 - MMP File in Symbian Project Navigator
-Figure 2 - Access to AIF Editor in MMP Editor
-Figure 3 - AIF Editor
-Figure 4- AIF Editor with information defined
-- This section describes the steps for adding and modifying resources of an - existing project. The resources may be a bitmap resource (MBM) or an - application information file (AIF) definition file. -
+ This section describes the steps for adding and modifying bitmap resources (MBM) of an + existing project.Note that the Symbian OS plug-ins do not provide a graphical editor for the Symbian OS resource (.rss) file format. Files of this type though @@ -20,7 +18,6 @@ resource compiler.
diff -r 2786ba7415f3 -r 13b01d8765f4 core/com.nokia.carbide.cpp.doc.user/html/tasks/index.html --- a/core/com.nokia.carbide.cpp.doc.user/html/tasks/index.html Tue Jun 22 15:25:44 2010 -0500 +++ b/core/com.nokia.carbide.cpp.doc.user/html/tasks/index.html Tue Jun 22 15:26:27 2010 -0500 @@ -36,15 +36,12 @@You can then add and build code in the project. This is mostly done using the standard CDT tools and techniques. The plug-ins through also offer special - support for the Symbian OS specific file formats for application information - files (AIF) and multi-bitmap files (MBM), as described in Modifying - Resources. -
+ support for the Symbian OS specific file formats and multi-bitmap files (MBM), as described in Modifying + Resources.The New Symbian OS C++ Class wizard appears showing the Select project page (Figure 1).
-Figure 1 - Symbian OS C++ Class wizard window
The Name and Location page appears (Figure 2).
-Figure 2 - Name and Location page
The Select a type of class page appears (Figure 3).
-Figure 3 - Select a type of class page
The Other Settings page appears (Figure 4).
-Figure 4 - Other Settings page
The new defined Symbian-based class titled NewClass, is added to the project and appears in the src folder (Figure 5).
-The new defined Symbian-based class titled SOSClassName is added to the project and appears in the src folder (Figure 5).
+Figure 5 -New class appears in Project Explorer list inside the project
Select the Project > Properties menu item or right-click the project name in the Project Explorer view, then select Properties. The project Properties for <project_name> window appears. Then select Carbide Build Configurations.
-Figure 1 - Active Configuration group in project Properties window
The Add/Remove Carbide Build Configuration window appears (Figure 2). Use the Add/Remove Carbide Build Configuration window to manage the build configurations that appear on the Build Configurations sub-menu for the current project. You can also click the Manage configurations for the current project icon () on the toolbar to open this dialog.
Figure 2 - Window for managing build configurations
- - +