eda_doc.h File Reference

This file is part of the common library. More...

Go to the source code of this file.

Functions
bool	GetAssociatedDocument (wxWindow *aParent, const wxString &aDocName, PROJECT *aProject, SEARCH_STACK *aPaths=nullptr, EMBEDDED_FILES *aFiles=nullptr)
	Open a document (file) with the suitable browser.

Detailed Description

This file is part of the common library.

See also

common.h

Definition in file eda_doc.h.

Function Documentation

GetAssociatedDocument()

bool GetAssociatedDocument	(	wxWindow *	aParent,
		const wxString &	aDocName,
		PROJECT *	aProject,
		SEARCH_STACK *	aPaths = nullptr,
		EMBEDDED_FILES *	aFiles = nullptr
	)

Open a document (file) with the suitable browser.

Environmental variables are substituted before the document name is resolved for either browser or file. If aDocName has an associated URI handler on the system, the default handler will be launched.

Parameters

aParent	main frame.
aDocName	filename of file to open (Full filename or short filename).
aPaths	Additional paths to search for local disk datasheet files

Definition at line 62 of file eda_doc.cpp.

References _, DisplayError(), EDAfallbacks, EMBEDDED_FILES::GetTemporaryFileName(), FILEEXT::KiCadUriPrefix, mimeDatabase, OpenPDF(), ResolveUriByEnvVars(), UNIX_STRING_DIR_SEP, and WIN_STRING_DIR_SEP.

Referenced by FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), SCH_NAVIGATE_TOOL::HypertextCommand(), TEXT_BUTTON_URL::OnButtonClick(), LIB_TREE::onDetailsLink(), EE_INSPECTION_TOOL::ShowDatasheet(), FOOTPRINT_EDITOR_CONTROL::ShowDatasheet(), and COMMON_CONTROL::ShowHelp().