Inheritance diagram for MiKTeX::Packages::PackageInstaller:

Classes
struct	InitInfo
	Initialization options. More...
struct	ProgressInfo
	Progress information. More...
struct	UpdateInfo
	Update information record. More...
struct	UpgradeInfo
	Upgrade information record. More...

Public Types
enum class	Role { Application , Installer , Updater }
	Installation role. More...

Public Member Functions
virtual void	Dispose ()=0
	Releases all resources used by this package installer object.
virtual void	SetRepository (const std::string &repository)=0
virtual void	SetDownloadDirectory (const MiKTeX::Util::PathName &directory)=0
virtual void	UpdateDb (UpdateDbOptionSet options)=0
	Synchronizes the package database.
virtual void	UpdateDbAsync ()=0
virtual void	FindUpdates ()=0
	Checks for updates.
virtual void	FindUpdatesAsync ()=0
virtual std::vector< UpdateInfo >	GetUpdates ()=0
virtual void	FindUpgrades (PackageLevel packageLevel)=0
virtual void	FindUpgradesAsync (PackageLevel packageLevel)=0
virtual std::vector< UpgradeInfo >	GetUpgrades ()=0
virtual void	InstallRemove (Role role)=0
virtual void	InstallRemoveAsync (Role role)=0
virtual void	WaitForCompletion ()=0
	Waits for the started thread to complete.
virtual void	Download ()=0
virtual void	DownloadAsync ()=0
virtual ProgressInfo	GetProgressInfo ()=0
virtual void	SetCallback (PackageInstallerCallback *callback)=0
virtual void	SetFileLists (const std::vector< std::string > &toBeInstalled, const std::vector< std::string > &toBeRemoved)=0
virtual void	SetPackageLevel (PackageLevel packageLevel)=0
virtual void	SetFileList (const std::vector< std::string > &toBeInstalled)=0
virtual bool	IsRunning () const =0
virtual void	RegisterComponents (bool postInstall)=0

Member Enumeration Documentation

◆ Role

enum class MiKTeX::Packages::PackageInstaller::Role

strong

Installation role.

Enumerator
Application	Regular application.
Installer	Installer (setup) program.
Updater	Updater.

Member Function Documentation

◆ Dispose()

virtual void MiKTeX::Packages::PackageInstaller::Dispose ( )

pure virtual

Releases all resources used by this package installer object.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ Download()

virtual void MiKTeX::Packages::PackageInstaller::Download ( )

pure virtual

Downloads packages.

See also: SetDownloadDirectory; SetPackageLevel

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ DownloadAsync()

virtual void MiKTeX::Packages::PackageInstaller::DownloadAsync ( )

pure virtual

Downloads packages in a secondary thread.

See also: SetDownloadDirectory; SetPackageLevel; WaitForCompletion

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ FindUpdates()

virtual void MiKTeX::Packages::PackageInstaller::FindUpdates ( )

pure virtual

Checks for updates.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ FindUpdatesAsync()

virtual void MiKTeX::Packages::PackageInstaller::FindUpdatesAsync ( )

pure virtual

Checks for updates in a secondary thread.

See also: WaitForCompletion

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ FindUpgrades()

virtual void MiKTeX::Packages::PackageInstaller::FindUpgrades ( PackageLevel packageLevel )

pure virtual

Checks for upgradeable packages.

Parameters

packageLevel The requested package level.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ FindUpgradesAsync()

virtual void MiKTeX::Packages::PackageInstaller::FindUpgradesAsync ( PackageLevel packageLevel )

pure virtual

Checks for upgrades in a secondary thread.

See also: WaitForCompletion

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ GetProgressInfo()

virtual ProgressInfo MiKTeX::Packages::PackageInstaller::GetProgressInfo ( )

pure virtual

Gets progress information.

Returns: Returns progress information.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ GetUpdates()

virtual std::vector< UpdateInfo > MiKTeX::Packages::PackageInstaller::GetUpdates ( )

pure virtual

Gets updateable packages.

Returns: Returns collected update information records.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ GetUpgrades()

virtual std::vector< UpgradeInfo > MiKTeX::Packages::PackageInstaller::GetUpgrades ( )

pure virtual

Gets upgradeable packages.

Returns: Returns upgrade information records.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ InstallRemove()

virtual void MiKTeX::Packages::PackageInstaller::InstallRemove ( Role role )

pure virtual

Installs/removes packages.

Parameters

role	The installation role.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ InstallRemoveAsync()

virtual void MiKTeX::Packages::PackageInstaller::InstallRemoveAsync ( Role role )

pure virtual

Installs/removes packages in a secondary thread.

Parameters

role	The installation role.

See also: WaitForCompletion

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ IsRunning()

virtual bool MiKTeX::Packages::PackageInstaller::IsRunning ( ) const

pure virtual

Tests if the secondary thread is running.

Returns: Returns true, if the installer is running.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ RegisterComponents()

virtual void MiKTeX::Packages::PackageInstaller::RegisterComponents ( bool postInstall )

pure virtual

Performs post-processing tasks.

Parameters

postInstall Indicates whether this is post-install or post-uninstall.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ SetCallback()

virtual void MiKTeX::Packages::PackageInstaller::SetCallback ( PackageInstallerCallback * callback )

pure virtual

Sets the callback interface.

Parameters

callback Pointer to object implementing the interface.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ SetDownloadDirectory()

virtual void MiKTeX::Packages::PackageInstaller::SetDownloadDirectory ( const MiKTeX::Util::PathName & directory )

pure virtual

Sets the download directory for this package installer.

Parameters

directory The path to the download directory.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ SetFileList()

virtual void MiKTeX::Packages::PackageInstaller::SetFileList ( const std::vector< std::string > & toBeInstalled )

pure virtual

Sets the package lists.

Parameters

toBeInstalled Packages to be installed.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ SetFileLists()

virtual void MiKTeX::Packages::PackageInstaller::SetFileLists	(	const std::vector< std::string > &	toBeInstalled,
		const std::vector< std::string > &	toBeRemoved )

pure virtual

Sets the package lists.

Parameters

toBeInstalled	Packages to be installed.
toBeRemoved	Packages to be removed.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ SetPackageLevel()

virtual void MiKTeX::Packages::PackageInstaller::SetPackageLevel ( PackageLevel packageLevel )

pure virtual

Sets the package level.

Parameters

packageLevel The package level to set.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ SetRepository()

virtual void MiKTeX::Packages::PackageInstaller::SetRepository ( const std::string & repository )

pure virtual

Sets the package repository for this package installer object.

Parameters

repository The location of the package repository. Either an URL or an absolute path name.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ UpdateDb()

virtual void MiKTeX::Packages::PackageInstaller::UpdateDb ( UpdateDbOptionSet options )

pure virtual

Synchronizes the package database.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ UpdateDbAsync()

virtual void MiKTeX::Packages::PackageInstaller::UpdateDbAsync ( )

pure virtual

Starts the package database synchronization thread.

See also: WaitForCompletion

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

◆ WaitForCompletion()

virtual void MiKTeX::Packages::PackageInstaller::WaitForCompletion ( )

pure virtual

Waits for the started thread to complete.

Implemented in MiKTeX::Packages::internal::PackageInstallerImpl.

The documentation for this class was generated from the following files:

Libraries/MiKTeX/PackageManager/include/miktex/PackageManager/PackageInstaller.h
Libraries/MiKTeX/PackageManager/PackageInstallerImpl.cpp

Classes

Public Types

Public Member Functions

Member Enumeration Documentation

◆ Role

Member Function Documentation

◆ Dispose()

◆ Download()

◆ DownloadAsync()

◆ FindUpdates()

◆ FindUpdatesAsync()

◆ FindUpgrades()

◆ FindUpgradesAsync()

◆ GetProgressInfo()

◆ GetUpdates()

◆ GetUpgrades()

◆ InstallRemove()

◆ InstallRemoveAsync()

◆ IsRunning()

◆ RegisterComponents()

◆ SetCallback()

◆ SetDownloadDirectory()

◆ SetFileList()

◆ SetFileLists()

◆ SetPackageLevel()

◆ SetRepository()

◆ UpdateDb()

◆ UpdateDbAsync()

◆ WaitForCompletion()