Inkscape::IO::Resource Namespace Reference

Enumerations
enum	Type {   ATTRIBUTES , EXAMPLES , EXTENSIONS , FONTS ,   FONTCOLLECTIONS , ICONS , KEYS , MARKERS ,   NONE , PAINT , PALETTES , SCREENS ,   TEMPLATES , TUTORIALS , SYMBOLS , FILTERS ,   THEMES , UIS , DOCS }
enum	Domain {   SYSTEM , CREATE , CACHE , SHARED ,   USER }

Functions
gchar *	_get_path (Domain domain, Type type, char const *filename, char const *extra=nullptr)
Util::ptr_shared	get_path (Domain domain, Type type, char const *filename, char const *extra)
std::string	get_path_string (Domain domain, Type type, char const *filename, char const *extra)
std::string	get_filename (Type type, char const *filename, bool localized, bool silent)
std::string	get_filename (std::string const &path, std::string const &filename)
std::vector< std::string >	get_filenames (Type type, std::vector< const char * > const &extensions, std::vector< const char * > const &exclusions)
std::vector< std::string >	get_filenames (Domain domain, Type type, std::vector< const char * > const &extensions, std::vector< const char * > const &exclusions)
std::vector< std::string >	get_filenames (std::string path, std::vector< const char * > const &extensions, std::vector< const char * > const &exclusions)
std::vector< std::string >	get_foldernames (Type type, std::vector< const char * > const &exclusions)
std::vector< std::string >	get_foldernames (Domain domain, Type type, std::vector< const char * > const &exclusions)
std::vector< std::string >	get_foldernames (std::string const &path, std::vector< const char * > const &exclusions)
void	get_filenames_from_path (std::vector< std::string > &files, std::string const &path, std::vector< const char * > const &extensions, std::vector< const char * > const &exclusions)
void	get_foldernames_from_path (std::vector< std::string > &folders, std::string const &path, std::vector< const char * > const &exclusions)
std::string	profile_path (const char *filename)
	Get, or guess, or decide the location where the preferences.xml file should be located.
std::string	profile_path ()
std::string	shared_path (const char *filename)
std::string	shared_path ()
std::string	log_path (const char *filename)
std::string	homedir_path ()

Enumeration Type Documentation

Domain

enum Inkscape::IO::Resource::Domain

Enumerator
SYSTEM
CREATE
CACHE
SHARED
USER

Definition at line 45 of file resource.h.

Type

enum Inkscape::IO::Resource::Type

Enumerator
ATTRIBUTES
EXAMPLES
EXTENSIONS
FONTS
FONTCOLLECTIONS
ICONS
KEYS
MARKERS
NONE
PAINT
PALETTES
SCREENS
TEMPLATES
TUTORIALS
SYMBOLS
FILTERS
THEMES
UIS
DOCS

Definition at line 23 of file resource.h.

Function Documentation

_get_path()

gchar * Inkscape::IO::Resource::_get_path	(	Domain	domain,
		Type	type,
		char const *	filename,
		char const *	extra = nullptr
	)

Returns

Path. Value is in platform-native encoding (see Glib::filename_to_utf8).

Definition at line 47 of file resource.cpp.

References ATTRIBUTES, CACHE, CREATE, DOCS, EXAMPLES, EXTENSIONS, FILTERS, FONTCOLLECTIONS, FONTS, get_inkscape_datadir(), ICONS, KEYS, MARKERS, name, NONE, PAINT, PALETTES, profile_path(), SCREENS, SHARED, shared_path(), SYMBOLS, SYSTEM, TEMPLATES, THEMES, TUTORIALS, UIS, and USER.

Referenced by get_filename(), get_path(), and get_path_string().

get_filename() [1/2]

std::string Inkscape::IO::Resource::get_filename	(	std::string const &	path,
		std::string const &	filename
	)

Definition at line 238 of file resource.cpp.

References get_filename().

get_filename() [2/2]

std::string Inkscape::IO::Resource::get_filename	(	Type	type,
		char const *	filename,
		bool	localized,
		bool	silent
	)

Definition at line 170 of file resource.cpp.

References _get_path(), Inkscape::IO::file_test(), get_filename(), result, SHARED, SYSTEM, and USER.

Referenced by Inkscape::Extension::TemplatePreset::_get_icon_path(), build_menu(), Inkscape::Extension::Dependency::check(), Inkscape::UI::create_builder(), Inkscape::UI::Dialog::DialogManager::dialog_defaults(), InkscapeApplication::document_new(), end_font_face_cb(), get_filename(), get_filename(), Inkscape::UI::Dialog::get_shuffled_lines(), Inkscape::UI::Widget::get_stop_template_path(), Inkscape::Extension::Template::get_template_filename(), help_open_tutorial(), import_style_cb(), Inkscape::UI::Widget::TemplateList::init(), Inkscape::UI::Widget::MarkerComboBox::MarkerComboBox(), Inkscape::UI::Dialog::show_about(), sp_file_default_template_uri(), and Inkscape::UI::Dialog::StartScreen::StartScreen().

get_filenames() [1/3]

std::vector< std::string > Inkscape::IO::Resource::get_filenames	(	Domain	domain,
		Type	type,
		std::vector< const char * > const &	extensions,
		std::vector< const char * > const &	exclusions
	)

Definition at line 277 of file resource.cpp.

References get_filenames_from_path(), and get_path_string().

get_filenames() [2/3]

std::vector< std::string > Inkscape::IO::Resource::get_filenames	(	std::string	path,
		std::vector< const char * > const &	extensions,
		std::vector< const char * > const &	exclusions
	)

Definition at line 283 of file resource.cpp.

References get_filenames_from_path().

get_filenames() [3/3]

std::vector< std::string > Inkscape::IO::Resource::get_filenames	(	Type	type,
		std::vector< const char * > const &	extensions,
		std::vector< const char * > const &	exclusions
	)

Definition at line 267 of file resource.cpp.

References CREATE, get_filenames_from_path(), get_path_string(), SHARED, SYSTEM, and USER.

Referenced by Inkscape::Extension::Internal::Filter::Filter::filters_all_files(), Inkscape::Shortcuts::get_file_names(), Inkscape::Extension::Internal::TemplateFromFile::get_template_presets(), Inkscape::UI::Dialog::GlobalPalettes::GlobalPalettes(), Inkscape::Extension::init(), Inkscape::Extension::load_shared_extensions(), Inkscape::Extension::load_user_extensions(), and Inkscape::Colors::CMS::System::refreshProfiles().

get_filenames_from_path()

void Inkscape::IO::Resource::get_filenames_from_path	(	std::vector< std::string > &	files,
		std::string const &	path,
		std::vector< const char * > const &	extensions,
		std::vector< const char * > const &	exclusions
	)

Definition at line 331 of file resource.cpp.

References get_filenames_from_path().

Referenced by FontFactory::AddFontFilesWin32(), get_filenames(), get_filenames(), get_filenames(), get_filenames_from_path(), and Inkscape::FontCollections::init().

get_foldernames() [1/3]

std::vector< std::string > Inkscape::IO::Resource::get_foldernames	(	Domain	domain,
		Type	type,
		std::vector< const char * > const &	exclusions
	)

Definition at line 308 of file resource.cpp.

References get_foldernames_from_path(), and get_path_string().

get_foldernames() [2/3]

std::vector< std::string > Inkscape::IO::Resource::get_foldernames	(	std::string const &	path,
		std::vector< const char * > const &	exclusions
	)

Definition at line 315 of file resource.cpp.

References get_foldernames_from_path().

get_foldernames() [3/3]

std::vector< std::string > Inkscape::IO::Resource::get_foldernames	(	Type	type,
		std::vector< const char * > const &	exclusions
	)

Definition at line 298 of file resource.cpp.

References CREATE, get_foldernames_from_path(), get_path_string(), SHARED, SYSTEM, and USER.

get_foldernames_from_path()

void Inkscape::IO::Resource::get_foldernames_from_path	(	std::vector< std::string > &	folders,
		std::string const &	path,
		std::vector< const char * > const &	exclusions
	)

Definition at line 373 of file resource.cpp.

Referenced by get_foldernames(), get_foldernames(), and get_foldernames().

get_path()

Util::ptr_shared Inkscape::IO::Resource::get_path	(	Domain	domain,
		Type	type,
		char const *	filename,
		char const *	extra
	)

Definition at line 137 of file resource.cpp.

References _get_path(), result, and Inkscape::Util::share_string().

Referenced by Inkscape::UI::Dialog::add_effects(), Inkscape::UI::Dialog::FileSaveDialogImplGtk::FileSaveDialogImplGtk(), Inkscape::UI::Dialog::InkscapePreferences::initPageSystem(), Inkscape::UI::Dialog::InkscapePreferences::initPageUI(), and Inkscape::UI::Dialog::ExportPreview::resetPixels().

get_path_string()

std::string Inkscape::IO::Resource::get_path_string	(	Domain	domain,
		Type	type,
		char const *	filename,
		char const *	extra
	)

Definition at line 148 of file resource.cpp.

References _get_path(), and result.

Referenced by Inkscape::FontCollections::_read(), Inkscape::RecentlyUsedFonts::_write_recently_used_fonts(), Inkscape::UI::Dialog::add_effects(), Inkscape::Shortcuts::clear_user_shortcuts(), Inkscape::Shortcuts::export_shortcuts(), Inkscape::FontCollections::generate_filename_from_collection(), Inkscape::Shortcuts::get_file_names(), get_filenames(), get_filenames(), get_foldernames(), get_foldernames(), Inkscape::UI::Syntax::get_language_manager(), Inkscape::Shortcuts::import_shortcuts(), Inkscape::Shortcuts::init(), Inkscape::FontCollections::init(), Inkscape::RecentlyUsedFonts::init(), Inkscape::UI::ThemeContext::initialize_source_syntax_styles(), Inkscape::UI::Dialog::InkscapePreferences::initKeyboardShortcuts(), Inkscape::UI::Dialog::InkscapePreferences::initPageSystem(), Inkscape::Handles::parse_css(), Inkscape::FontCollections::remove_collection(), Inkscape::FontCollections::rename_collection(), sp_file_save_template(), and Inkscape::Shortcuts::write_user().

homedir_path()

std::string Inkscape::IO::Resource::homedir_path

(

)

Definition at line 513 of file resource.cpp.

Referenced by Inkscape::UI::Dialog::Export::prependDirectory().

log_path()

std::string Inkscape::IO::Resource::log_path

(

const char *

filename

)

Definition at line 508 of file resource.cpp.

References profile_path().

Referenced by Inkscape::Extension::Extension::error_file_open().

profile_path() [1/2]

std::string Inkscape::IO::Resource::profile_path

(

)

Definition at line 415 of file resource.cpp.

References get_user_config_dir(), mode, and name.

Referenced by _get_path(), Inkscape::Preferences::_load(), Inkscape::PaperSize::getPageSizes(), Inkscape::UI::Dialog::InkscapePreferences::initPageSystem(), Inkscape::load_cached_font_info(), log_path(), InkscapeApplication::on_handle_local_options(), Inkscape::Preferences::Preferences(), print_user_data_directory(), profile_path(), Inkscape::UI::Dialog::DialogManager::restore_dialogs_state(), Inkscape::UI::Dialog::DialogManager::save_dialogs_state(), Inkscape::save_font_cache(), Inkscape::Extension::Extension::set_environment(), and InkscapeApplication::shell().

profile_path() [2/2]

std::string Inkscape::IO::Resource::profile_path

(

const char *

filename

)

Get, or guess, or decide the location where the preferences.xml file should be located.

This also indicates where all other inkscape shared files may optionally exist.

Definition at line 407 of file resource.cpp.

References profile_path().

shared_path() [1/2]

std::string Inkscape::IO::Resource::shared_path

(

)

Definition at line 492 of file resource.cpp.

References Inkscape::Preferences::get(), Inkscape::Preferences::getString(), and InkscapeApplication::instance().

Referenced by _get_path(), and shared_path().

shared_path() [2/2]

std::string Inkscape::IO::Resource::shared_path

(

const char *

filename

)

Definition at line 487 of file resource.cpp.

References shared_path().