model_preview_manager.h File Reference

#include <vector>
#include <wx/arrstr.h>
#include <kicommon.h>

Go to the source code of this file.

Classes
struct	MODEL_PREVIEW_STATUS

Enumerations
enum class	MODEL_PREVIEW_COMPONENT_STATE { AVAILABLE , UNAVAILABLE , DAMAGED , VERSION_MISMATCH }
enum class	MODEL_PREVIEW_ENABLEMENT_STATE { ENABLED , SETUP_REQUIRED , UNKNOWN }
enum class	MODEL_PREVIEW_GUIDANCE { NONE , REPAIR_REGISTRATION , REINSTALL_KICAD , STATUS_UNAVAILABLE }

Functions
KICOMMON_API bool	ShouldPromptForModelPreviewSetup (const MODEL_PREVIEW_STATUS &aStatus, const std::vector< wxString > &aDeclinedRequirements)
KICOMMON_API void	DeclineModelPreviewRequirement (const wxString &aRequirement, std::vector< wxString > &aDeclinedRequirements)

Enumeration Type Documentation

MODEL_PREVIEW_COMPONENT_STATE

enum class MODEL_PREVIEW_COMPONENT_STATE

strong

Enumerator
AVAILABLE
UNAVAILABLE
DAMAGED
VERSION_MISMATCH

Definition at line 35 of file model_preview_manager.h.

MODEL_PREVIEW_ENABLEMENT_STATE

enum class MODEL_PREVIEW_ENABLEMENT_STATE

strong

Enumerator
ENABLED
SETUP_REQUIRED
UNKNOWN

Definition at line 43 of file model_preview_manager.h.

MODEL_PREVIEW_GUIDANCE

enum class MODEL_PREVIEW_GUIDANCE

strong

Enumerator
NONE
REPAIR_REGISTRATION
REINSTALL_KICAD
STATUS_UNAVAILABLE

Definition at line 50 of file model_preview_manager.h.

Function Documentation

DeclineModelPreviewRequirement()

KICOMMON_API void DeclineModelPreviewRequirement	(	const wxString &	aRequirement,
		std::vector< wxString > &	aDeclinedRequirements )

Definition at line 66 of file model_preview_manager.cpp.

ShouldPromptForModelPreviewSetup()

KICOMMON_API bool ShouldPromptForModelPreviewSetup	(	const MODEL_PREVIEW_STATUS &	aStatus,
		const std::vector< wxString > &	aDeclinedRequirements )

Definition at line 46 of file model_preview_manager.cpp.

References MODEL_PREVIEW_STATUS::canRepairRegistration, MODEL_PREVIEW_STATUS::enablement, MODEL_PREVIEW_STATUS::guidance, REPAIR_REGISTRATION, MODEL_PREVIEW_STATUS::requirementId, and SETUP_REQUIRED.