|
Carbide.c++ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMultiImageSource
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.
Method Summary | |
---|---|
boolean |
canSetGeneratedHeaderFilePath()
Tell whether the generated header can be set. |
IMultiImageSource |
copy()
Deep copy the contents into a new multi-image source. |
IBitmapSource |
createBitmapSource()
Create (doesn't add) a new BMP image source. |
ISVGSource |
createSVGSource()
Create (doesn't add) a new SVG image source. |
IImageSource |
createUnknownImageSource()
Create (doesn't add) an unknown image source. |
IImageSource |
findMatchingSource(IPath filePath)
Find an entry that matches the file. |
IPath |
getDefaultGeneratedHeaderFilePath()
Get the generated EPOCROOT-relative header filepath, even if the current multi-image source will not generate a header |
IPath |
getGeneratedHeaderFilePath()
Get the generated EPOCROOT-relative header filepath |
java.lang.String |
getGeneratedImageEnumerator(IImageSource image)
Get the generated enumerator for the bitmap, or null for none. |
java.lang.String |
getGeneratedMaskEnumerator(IImageSource image)
Get the generated enumerator for the bitmap, or null for none. |
EGeneratedHeaderFlags |
getHeaderFlags()
Get the header generation flag |
java.util.List<IImageSource> |
getSources()
Get the bitmap sources, never null. |
java.lang.String |
getTargetFile()
Get the target filename |
IPath |
getTargetFilePath()
Get the synthesized full path to the target file. |
IPath |
getTargetPath()
Get the target directory-relative path (without filename), e.g. |
boolean |
hasDisallowedSources()
Tell whether the sources contain a disallowed file type. |
boolean |
isBitmapSourceAllowed()
Tell whether the container allows BMP files. |
boolean |
isSVGSourceAllowed()
Tell whether the container allows SVG files. |
boolean |
isValid()
Tell if the container is valid, e.g. initialized: must have a target file. |
void |
set(IMultiImageSource multiImageSource)
Set contents from another multi-image source. |
void |
setGeneratedHeaderFilePath(IPath path)
Set the generated EPOCROOT-relative header (starting with epoc32), or full path or null. |
void |
setHeaderFlags(EGeneratedHeaderFlags flag)
Set the header generation flag |
void |
setSources(java.util.List<IImageSource> sources)
Set the bitmap sources, may not be null. |
void |
setTargetFile(java.lang.String name)
Set the target filename source path |
void |
setTargetPath(IPath path)
Get the target directory-relative path (without filename), e.g. |
Method Detail |
---|
boolean isValid()
IMultiImageSource copy()
void set(IMultiImageSource multiImageSource)
multiImageSource
- IPath getTargetFilePath()
getTargetFile()
,
getTargetPath()
java.lang.String getTargetFile()
void setTargetFile(java.lang.String name)
EGeneratedHeaderFlags getHeaderFlags()
void setHeaderFlags(EGeneratedHeaderFlags flag)
IPath getTargetPath()
void setTargetPath(IPath path)
java.util.List<IImageSource> getSources()
void setSources(java.util.List<IImageSource> sources)
boolean hasDisallowedSources()
boolean isBitmapSourceAllowed()
boolean isSVGSourceAllowed()
IImageSource createUnknownImageSource()
IBitmapSource createBitmapSource()
ISVGSource createSVGSource()
IPath getGeneratedHeaderFilePath()
boolean canSetGeneratedHeaderFilePath()
void setGeneratedHeaderFilePath(IPath path)
java.lang.UnsupportedOperationException
- if #canSetGeneratedHeaderFilePath() returns falseIPath getDefaultGeneratedHeaderFilePath()
java.lang.String getGeneratedImageEnumerator(IImageSource image)
java.lang.String getGeneratedMaskEnumerator(IImageSource image)
IImageSource findMatchingSource(IPath filePath)
filePath
-
|
Carbide.c++ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |