C# Class Bloom.BloomFileLocator

Inheritance: Palaso.IO.FileLocator

Show file Open project: BloomBooks/BloomDesktop Class Usage Examples

Public Properties

Property	Type	Description
sTheMostRecentBloomFileLocator	BloomFileLocator

Public Methods

Method	Description
AddPath ( string path ) : void
BloomFileLocator ( CollectionSettings collectionSettings, XMatterPackFinder xMatterPackFinder, IEnumerable factorySearchPaths, IEnumerable userInstalledSearchPaths, IEnumerable afterXMatterSearchPaths = null ) : System.Collections.Generic
CloneAndCustomize ( IEnumerable addedSearchPaths ) : IFileLocator
GetBestLocalizableFileDistributedWithApplication ( bool existenceOfEnglishVersionIsOptional ) : string	This can be used to find the best localized file when there is only one file with the given name, and the file is part of the files distributed with Bloom (i.e., not something in a downloaded template).
GetBestLocalizedFile ( string pathToEnglishFile ) : string	If there is a file sitting next to the english one with the desired language, get that path. Otherwise, returns the English path.
GetBrowserDirectory ( ) : string
GetBrowserFile ( ) : string
GetFactoryBookTemplateDirectory ( string bookName ) : string
GetInstalledXMatterDirectory ( ) : string
GetOptionalBrandingFile ( string brandingNameOrFolderPath, string fileName ) : string	Gets a file in the specified branding folder
IsInstalledFileOrDirectory ( string filepath ) : bool	Check whether this file was installed with Bloom (and likely to be read-only on Linux or for allUsers install).

Protected Methods

Method	Description
GetSearchPaths ( ) : IEnumerable	These are used (as of 26 aug 2016) only by LibPalaso's FileLocator.LocateFile(). Not used by GetFileDistributedWIthApplication().

Method Details

AddPath() public method

public AddPath ( string path ) : void
path	string
return	void

BloomFileLocator() public method

public BloomFileLocator ( CollectionSettings collectionSettings, XMatterPackFinder xMatterPackFinder, IEnumerable factorySearchPaths, IEnumerable userInstalledSearchPaths, IEnumerable afterXMatterSearchPaths = null ) : System.Collections.Generic
collectionSettings	Bloom.Collection.CollectionSettings
xMatterPackFinder	Bloom.Book.XMatterPackFinder
factorySearchPaths	IEnumerable
userInstalledSearchPaths	IEnumerable
afterXMatterSearchPaths	IEnumerable
return	System.Collections.Generic

CloneAndCustomize() public method

public CloneAndCustomize ( IEnumerable addedSearchPaths ) : IFileLocator
addedSearchPaths	IEnumerable
return	IFileLocator

GetBestLocalizableFileDistributedWithApplication() public static method

This can be used to find the best localized file when there is only one file with the given name, and the file is part of the files distributed with Bloom (i.e., not something in a downloaded template).

public static GetBestLocalizableFileDistributedWithApplication ( bool existenceOfEnglishVersionIsOptional ) : string
existenceOfEnglishVersionIsOptional	bool
return	string

GetBestLocalizedFile() public static method

If there is a file sitting next to the english one with the desired language, get that path. Otherwise, returns the English path.

public static GetBestLocalizedFile ( string pathToEnglishFile ) : string
pathToEnglishFile	string
return	string

GetBrowserDirectory() public static method

public static GetBrowserDirectory ( ) : string
return	string

GetBrowserFile() public static method

public static GetBrowserFile ( ) : string
return	string

GetFactoryBookTemplateDirectory() public static method

public static GetFactoryBookTemplateDirectory ( string bookName ) : string
bookName	string
return	string

GetInstalledXMatterDirectory() public static method

public static GetInstalledXMatterDirectory ( ) : string
return	string

GetOptionalBrandingFile() public static method

Gets a file in the specified branding folder

public static GetOptionalBrandingFile ( string brandingNameOrFolderPath, string fileName ) : string
brandingNameOrFolderPath	string	Normally, the branding is just a name, which we look up in the official branding folder // but unit tests can instead provide a path to the folder. ///
fileName	string
return	string

GetSearchPaths() protected method

These are used (as of 26 aug 2016) only by LibPalaso's FileLocator.LocateFile(). Not used by GetFileDistributedWIthApplication().

protected GetSearchPaths ( ) : IEnumerable
return	IEnumerable

IsInstalledFileOrDirectory() public static method

Check whether this file was installed with Bloom (and likely to be read-only on Linux or for allUsers install).

public static IsInstalledFileOrDirectory ( string filepath ) : bool
filepath	string
return	bool

Property Details

sTheMostRecentBloomFileLocator public static property

public static BloomFileLocator,Bloom sTheMostRecentBloomFileLocator
return	BloomFileLocator