carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_15) on Tue Jan 06 17:31:53 CST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>
IExtension (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.cpp.epoc.engine.model.bldinf.IExtension interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IExtension (Carbide.c++ SDK API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IExtension.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExport.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf"><B>PREV CLASS</B></A>
<A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IMakefileReference.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../index.html?com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html" target="_top"><B>FRAMES</B></A>
<A HREF="IExtension.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.nokia.carbide.cpp.epoc.engine.model.bldinf</FONT>
<BR>
Interface IExtension</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IExtension</B></DL>
</PRE>
<P>
This interface represents the content of an entry in PRJ_EXTENSIONS block.
<p>
It's recommended to use a utility class (like BldInfViewPathHelpers) to interpret
and set the paths in this extension and resolve paths to actual project or filesystem
files.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf">IExtension</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#copy()">copy</A></B>()</CODE>
<BR>
Return a copy of the data</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List<IPath></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#getDependencies()">getDependencies</A></B>()</CODE>
<BR>
Access/modify the list of dependencies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map<java.lang.String,java.lang.String></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#getOptions()">getOptions</A></B>()</CODE>
<BR>
Access/modify the option map</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List<IPath></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#getSources()">getSources</A></B>()</CODE>
<BR>
Access/modify the list of project-relative sources.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#getTargetPath()">getTargetPath</A></B>()</CODE>
<BR>
Get the project-relative target path, may be null</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#getTemplatePath()">getTemplatePath</A></B>()</CODE>
<BR>
Get EPOCROOT\epoc32\tools\makefile_templates - relative path to extension makefile template.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#getToolName()">getToolName</A></B>()</CODE>
<BR>
Get the tool name, may be null</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#isValid()">isValid</A></B>()</CODE>
<BR>
Check whether the template path is set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#setTargetPath(IPath)">setTargetPath</A></B>(IPath path)</CODE>
<BR>
Set the project-relative target path, may be null</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#setTemplatePath(IPath)">setTemplatePath</A></B>(IPath path)</CODE>
<BR>
Set EPOCROOT\epoc32\tools\makefile_templates - relative path to extension makefile template.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#setToolName(java.lang.String)">setToolName</A></B>(java.lang.String toolName)</CODE>
<BR>
Set the tool name, may be null</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="isValid()"><!-- --></A><H3>
isValid</H3>
<PRE>
boolean <B>isValid</B>()</PRE>
<DL>
<DD>Check whether the template path is set.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTemplatePath()"><!-- --></A><H3>
getTemplatePath</H3>
<PRE>
IPath <B>getTemplatePath</B>()</PRE>
<DL>
<DD>Get EPOCROOT\epoc32\tools\makefile_templates - relative path to extension makefile template. As in the bld.inf, no extension will be present.
Either .mk or .meta is appended to find the paired files for the makefile.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setTemplatePath(IPath)"><!-- --></A><H3>
setTemplatePath</H3>
<PRE>
void <B>setTemplatePath</B>(IPath path)</PRE>
<DL>
<DD>Set EPOCROOT\epoc32\tools\makefile_templates - relative path to extension makefile template. As in the bld.inf, no extension should be present.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTargetPath()"><!-- --></A><H3>
getTargetPath</H3>
<PRE>
IPath <B>getTargetPath</B>()</PRE>
<DL>
<DD>Get the project-relative target path, may be null
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setTargetPath(IPath)"><!-- --></A><H3>
setTargetPath</H3>
<PRE>
void <B>setTargetPath</B>(IPath path)</PRE>
<DL>
<DD>Set the project-relative target path, may be null
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSources()"><!-- --></A><H3>
getSources</H3>
<PRE>
java.util.List<IPath> <B>getSources</B>()</PRE>
<DL>
<DD>Access/modify the list of project-relative sources.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDependencies()"><!-- --></A><H3>
getDependencies</H3>
<PRE>
java.util.List<IPath> <B>getDependencies</B>()</PRE>
<DL>
<DD>Access/modify the list of dependencies. No interpretation is performed. As in the bld.inf, no extension will be present.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getToolName()"><!-- --></A><H3>
getToolName</H3>
<PRE>
java.lang.String <B>getToolName</B>()</PRE>
<DL>
<DD>Get the tool name, may be null
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setToolName(java.lang.String)"><!-- --></A><H3>
setToolName</H3>
<PRE>
void <B>setToolName</B>(java.lang.String toolName)</PRE>
<DL>
<DD>Set the tool name, may be null
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getOptions()"><!-- --></A><H3>
getOptions</H3>
<PRE>
java.util.Map<java.lang.String,java.lang.String> <B>getOptions</B>()</PRE>
<DL>
<DD>Access/modify the option map
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="copy()"><!-- --></A><H3>
copy</H3>
<PRE>
<A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf">IExtension</A> <B>copy</B>()</PRE>
<DL>
<DD>Return a copy of the data
<P>
<DD><DL>
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IExtension.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExport.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf"><B>PREV CLASS</B></A>
<A HREF="../../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IMakefileReference.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../index.html?com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html" target="_top"><B>FRAMES</B></A>
<A HREF="IExtension.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<div id="footer">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
</BODY>
</HTML>