carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html
author fturovic <frank.turovich@nokia.com>
Tue, 27 Jul 2010 15:28:19 -0500
changeset 1704 24ac5a5cf80c
parent 0 fb279309251b
permissions -rw-r--r--
updated copyright dates and fixed some css issues

<!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>
IMultiImageSource (Carbide.c++ SDK API Reference)
</TITLE>

<META NAME="keywords" CONTENT="com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource interface">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="IMultiImageSource (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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IMultiImageSource.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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">
&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/ImageFormat.html" title="class in com.nokia.carbide.cpp.epoc.engine.image"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/ISVGSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image"><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/image/IMultiImageSource.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="IMultiImageSource.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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.image</FONT>
<BR>
Interface IMultiImageSource</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/mmp/IMMPBitmap.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.mmp">IMMPBitmap</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMultiImageSource</B></DL>
</PRE>

<P>
This interface represents a set of image sources that are built together into
 a single output. This acts as a modifiable container for such images, and
 also provides synthesized build-time information.
<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>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#canSetGeneratedHeaderFilePath()">canSetGeneratedHeaderFilePath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell whether the generated header can be set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IMultiImageSource</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#copy()">copy</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deep copy the contents into a new multi-image source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IBitmapSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IBitmapSource</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#createBitmapSource()">createBitmapSource</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create (doesn't add) a new BMP image source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/ISVGSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">ISVGSource</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#createSVGSource()">createSVGSource</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create (doesn't add) a new SVG image source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#createUnknownImageSource()">createUnknownImageSource</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create (doesn't add) an unknown image source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#findMatchingSource(IPath)">findMatchingSource</A></B>(IPath&nbsp;filePath)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Find an entry that matches the file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getDefaultGeneratedHeaderFilePath()">getDefaultGeneratedHeaderFilePath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the generated EPOCROOT-relative header filepath, even if the current
 multi-image source will not generate a header</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getGeneratedHeaderFilePath()">getGeneratedHeaderFilePath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the generated EPOCROOT-relative header filepath</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getGeneratedImageEnumerator(com.nokia.carbide.cpp.epoc.engine.image.IImageSource)">getGeneratedImageEnumerator</A></B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&nbsp;image)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the generated enumerator for the bitmap, or null for none.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getGeneratedMaskEnumerator(com.nokia.carbide.cpp.epoc.engine.image.IImageSource)">getGeneratedMaskEnumerator</A></B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&nbsp;image)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the generated enumerator for the bitmap, or null for none.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/EGeneratedHeaderFlags.html" title="enum in com.nokia.carbide.cpp.epoc.engine.model">EGeneratedHeaderFlags</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getHeaderFlags()">getHeaderFlags</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the header generation flag</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List&lt;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getSources()">getSources</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the bitmap sources, never null.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getTargetFile()">getTargetFile</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the target filename</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getTargetFilePath()">getTargetFilePath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the synthesized full path to the target file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getTargetPath()">getTargetPath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the target directory-relative path (without filename), e.g.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#hasDisallowedSources()">hasDisallowedSources</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell whether the sources contain a disallowed file type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#isBitmapSourceAllowed()">isBitmapSourceAllowed</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell whether the container allows BMP files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#isSVGSourceAllowed()">isSVGSourceAllowed</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell whether the container allows SVG files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#isValid()">isValid</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if the container is valid, e.g. initialized: must have a target file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#set(com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource)">set</A></B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IMultiImageSource</A>&nbsp;multiImageSource)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set contents from another multi-image source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#setGeneratedHeaderFilePath(IPath)">setGeneratedHeaderFilePath</A></B>(IPath&nbsp;path)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the generated EPOCROOT-relative header (starting with epoc32),
 or full path or null.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#setHeaderFlags(com.nokia.carbide.cpp.epoc.engine.model.EGeneratedHeaderFlags)">setHeaderFlags</A></B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/EGeneratedHeaderFlags.html" title="enum in com.nokia.carbide.cpp.epoc.engine.model">EGeneratedHeaderFlags</A>&nbsp;flag)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the header generation flag</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#setSources(java.util.List)">setSources</A></B>(java.util.List&lt;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&gt;&nbsp;sources)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the bitmap sources, may not be null.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#setTargetFile(java.lang.String)">setTargetFile</A></B>(java.lang.String&nbsp;name)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the target filename
 source path</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#setTargetPath(IPath)">setTargetPath</A></B>(IPath&nbsp;path)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the target directory-relative path (without filename), e.g.</TD>
</TR>
</TABLE>
&nbsp;
<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>Tell if the container is valid, e.g. initialized: must have a target file.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="copy()"><!-- --></A><H3>
copy</H3>
<PRE>
<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IMultiImageSource</A> <B>copy</B>()</PRE>
<DL>
<DD>Deep copy the contents into a new multi-image source. Does not copy
 immutable objects, but copies the sources lists and its contained image
 sources.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="set(com.nokia.carbide.cpp.epoc.engine.image.IMultiImageSource)"><!-- --></A><H3>
set</H3>
<PRE>
void <B>set</B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IMultiImageSource</A>&nbsp;multiImageSource)</PRE>
<DL>
<DD>Set contents from another multi-image source. This preserves the identity
 of the sources list, but nothing else.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>multiImageSource</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getTargetFilePath()"><!-- --></A><H3>
getTargetFilePath</H3>
<PRE>
IPath <B>getTargetFilePath</B>()</PRE>
<DL>
<DD>Get the synthesized full path to the target file. If it is a relative
 path, it's target directory-relative (e.g. "resource\\apps\\foo.mif"),
 else it's a full path on the local filesystem.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><DT><B>See Also:</B><DD><A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getTargetFile()"><CODE>getTargetFile()</CODE></A>, 
<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IMultiImageSource.html#getTargetPath()"><CODE>getTargetPath()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTargetFile()"><!-- --></A><H3>
getTargetFile</H3>
<PRE>
java.lang.String <B>getTargetFile</B>()</PRE>
<DL>
<DD>Get the target filename
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setTargetFile(java.lang.String)"><!-- --></A><H3>
setTargetFile</H3>
<PRE>
void <B>setTargetFile</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Set the target filename
 source path
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getHeaderFlags()"><!-- --></A><H3>
getHeaderFlags</H3>
<PRE>
<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/EGeneratedHeaderFlags.html" title="enum in com.nokia.carbide.cpp.epoc.engine.model">EGeneratedHeaderFlags</A> <B>getHeaderFlags</B>()</PRE>
<DL>
<DD>Get the header generation flag
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setHeaderFlags(com.nokia.carbide.cpp.epoc.engine.model.EGeneratedHeaderFlags)"><!-- --></A><H3>
setHeaderFlags</H3>
<PRE>
void <B>setHeaderFlags</B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/model/EGeneratedHeaderFlags.html" title="enum in com.nokia.carbide.cpp.epoc.engine.model">EGeneratedHeaderFlags</A>&nbsp;flag)</PRE>
<DL>
<DD>Set the header generation flag
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getTargetPath()"><!-- --></A><H3>
getTargetPath</H3>
<PRE>
IPath <B>getTargetPath</B>()</PRE>
<DL>
<DD>Get the target directory-relative path (without filename), e.g.
 "system\\apps". If a full path, it is on the local filesystem.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setTargetPath(IPath)"><!-- --></A><H3>
setTargetPath</H3>
<PRE>
void <B>setTargetPath</B>(IPath&nbsp;path)</PRE>
<DL>
<DD>Get the target directory-relative path (without filename), e.g.
 "system\\apps", or a full path on the local filesystem.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSources()"><!-- --></A><H3>
getSources</H3>
<PRE>
java.util.List&lt;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&gt; <B>getSources</B>()</PRE>
<DL>
<DD>Get the bitmap sources, never null.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setSources(java.util.List)"><!-- --></A><H3>
setSources</H3>
<PRE>
void <B>setSources</B>(java.util.List&lt;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&gt;&nbsp;sources)</PRE>
<DL>
<DD>Set the bitmap sources, may not be null.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="hasDisallowedSources()"><!-- --></A><H3>
hasDisallowedSources</H3>
<PRE>
boolean <B>hasDisallowedSources</B>()</PRE>
<DL>
<DD>Tell whether the sources contain a disallowed file type.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isBitmapSourceAllowed()"><!-- --></A><H3>
isBitmapSourceAllowed</H3>
<PRE>
boolean <B>isBitmapSourceAllowed</B>()</PRE>
<DL>
<DD>Tell whether the container allows BMP files.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isSVGSourceAllowed()"><!-- --></A><H3>
isSVGSourceAllowed</H3>
<PRE>
boolean <B>isSVGSourceAllowed</B>()</PRE>
<DL>
<DD>Tell whether the container allows SVG files.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createUnknownImageSource()"><!-- --></A><H3>
createUnknownImageSource</H3>
<PRE>
<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A> <B>createUnknownImageSource</B>()</PRE>
<DL>
<DD>Create (doesn't add) an unknown image source. These are always
 allowed.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createBitmapSource()"><!-- --></A><H3>
createBitmapSource</H3>
<PRE>
<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IBitmapSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IBitmapSource</A> <B>createBitmapSource</B>()</PRE>
<DL>
<DD>Create (doesn't add) a new BMP image source. Returns null if disallowed
 filetype.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createSVGSource()"><!-- --></A><H3>
createSVGSource</H3>
<PRE>
<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/ISVGSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">ISVGSource</A> <B>createSVGSource</B>()</PRE>
<DL>
<DD>Create (doesn't add) a new SVG image source. Returns null if disallowed
 filetype.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getGeneratedHeaderFilePath()"><!-- --></A><H3>
getGeneratedHeaderFilePath</H3>
<PRE>
IPath <B>getGeneratedHeaderFilePath</B>()</PRE>
<DL>
<DD>Get the generated EPOCROOT-relative header filepath
<P>
<DD><DL>

<DT><B>Returns:</B><DD>relative filepath (if starting with epoc32, EPOCROOT-relative),
 full path in filesystem, or null for no generated header</DL>
</DD>
</DL>
<HR>

<A NAME="canSetGeneratedHeaderFilePath()"><!-- --></A><H3>
canSetGeneratedHeaderFilePath</H3>
<PRE>
boolean <B>canSetGeneratedHeaderFilePath</B>()</PRE>
<DL>
<DD>Tell whether the generated header can be set.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setGeneratedHeaderFilePath(IPath)"><!-- --></A><H3>
setGeneratedHeaderFilePath</H3>
<PRE>
void <B>setGeneratedHeaderFilePath</B>(IPath&nbsp;path)</PRE>
<DL>
<DD>Set the generated EPOCROOT-relative header (starting with epoc32),
 or full path or null.  Forces #getHeaderFlags() to Header or NoHeader.
 <p>
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if #canSetGeneratedHeaderFilePath() returns false</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultGeneratedHeaderFilePath()"><!-- --></A><H3>
getDefaultGeneratedHeaderFilePath</H3>
<PRE>
IPath <B>getDefaultGeneratedHeaderFilePath</B>()</PRE>
<DL>
<DD>Get the generated EPOCROOT-relative header filepath, even if the current
 multi-image source will not generate a header
<P>
<DD><DL>

<DT><B>Returns:</B><DD>generated filepath (if starting with \\epoc32, EPOCROOT-relative)</DL>
</DD>
</DL>
<HR>

<A NAME="getGeneratedImageEnumerator(com.nokia.carbide.cpp.epoc.engine.image.IImageSource)"><!-- --></A><H3>
getGeneratedImageEnumerator</H3>
<PRE>
java.lang.String <B>getGeneratedImageEnumerator</B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&nbsp;image)</PRE>
<DL>
<DD>Get the generated enumerator for the bitmap, or null for none.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getGeneratedMaskEnumerator(com.nokia.carbide.cpp.epoc.engine.image.IImageSource)"><!-- --></A><H3>
getGeneratedMaskEnumerator</H3>
<PRE>
java.lang.String <B>getGeneratedMaskEnumerator</B>(<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A>&nbsp;image)</PRE>
<DL>
<DD>Get the generated enumerator for the bitmap, or null for none.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="findMatchingSource(IPath)"><!-- --></A><H3>
findMatchingSource</H3>
<PRE>
<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/IImageSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image">IImageSource</A> <B>findMatchingSource</B>(IPath&nbsp;filePath)</PRE>
<DL>
<DD>Find an entry that matches the file. This is not an exact path match, but
 a case-insensitive match of the filename, which will match the entry as
 far as the programmer is concerned (i.e. the enums will be the same).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filePath</CODE> - 
<DT><B>Returns:</B><DD>matching image source or null</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IMultiImageSource.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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">
&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/ImageFormat.html" title="class in com.nokia.carbide.cpp.epoc.engine.image"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../com/nokia/carbide/cpp/epoc/engine/image/ISVGSource.html" title="interface in com.nokia.carbide.cpp.epoc.engine.image"><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/image/IMultiImageSource.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="IMultiImageSource.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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 &copy; 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>