Component for the preview of the file contents. More...

#include <CDocPreviewGuiComp.h>

Inheritance diagram for idocgui::CDocPreviewGuiComp:

Collaboration diagram for idocgui::CDocPreviewGuiComp:

Public Types
typedef istdgui::TDesignerGuiObserverCompBase< Ui::CDocPreviewGuiComp, ifile::IFileNameParam >	BaseClass

Public Types inherited from istdgui::TGuiComponentBase< QWidget >
typedef CGuiComponentBase	BaseClass

Public Types inherited from istdgui::CGuiComponentBase
typedef ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >	BaseClass

Public Types inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
typedef icomp::CComponentBase	BaseClass

Public Types inherited from imod::TSingleModelObserverBase< ifile::IFileNameParam >
typedef CSingleModelObserverBase	BaseClass

typedef ifile::IFileNameParam	ModelType

Public Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel	ModelType

Public Types inherited from imod::IModelEditor
enum	ChangeFlags { CF_INIT_EDITOR = 0x3720694 }
	Data model change notification flags. More...

Signals
void	LoadingFinished (QByteArray docTypeId, bool isSuccess)

Public Member Functions
	CDocPreviewGuiComp ()

Public Member Functions inherited from istdgui::TGuiComponentBase< QWidget >
	TGuiComponentBase ()

virtual QWidget *	GetQtWidget () const

Public Member Functions inherited from istdgui::CGuiComponentBase
	I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, IVisualStatus, ExtractVisualStatus)

	I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, istd::IChangeable, ExtractVisualStatus)

	I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, imod::IModel, ExtractVisualStatus)

	CGuiComponentBase ()

bool	IsGuiShown () const

bool	IsGuiCreated () const override
	Inform if GUI was initilized.

bool	CreateGui (QWidget *parentPtr) override
	Initialize GUI and connect it to the parent.

bool	DestroyGui () override
	Release GUI and disconnect it from parent.

QWidget *	GetWidget () const override
	Get access to internal QWidget object.

void	OnTryClose (bool *ignoredPtr=nullptr) override
	Called on trying to close application.

Public Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
	TVisualChangesHandlerWrap (Args &&... args)

virtual void	EnableVisualChangesHandler (bool enableLocalization=true)
	If enabled, listen to the language change event from the application context.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.

virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from istdgui::IGuiObject
Public Member Functions inherited from imod::TSingleModelObserverBase< ifile::IFileNameParam >
	TSingleModelObserverBase ()

ifile::IFileNameParam *	GetObservedObject () const
	Get instance of observed object.

ifile::IFileNameParam *	GetObjectPtr () const
	Get instance of observed object.

bool	AttachOrSetObject (ifile::IFileNameParam *objectPtr)
	Attach to model of object or set object pointer, if no connection is possible.

bool	OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
	This call back function will be called, if an observable object is about to be attached.

bool	OnModelDetached (imod::IModel *modelPtr) override
	This call back function will be called, if an observable object is about to be detached.

Public Member Functions inherited from imod::CSingleModelObserverBase
	CSingleModelObserverBase ()

virtual	~CSingleModelObserverBase ()

imod::IModel *	GetObservedModel () const
	Get access to observed model.

imod::IModel *	GetModelPtr () const
	Get access to observed model.

void	EnsureModelDetached ()
	Make sure this observer is detached.

void	SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
	Set list of ID's beeing observed.

bool	IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
	Check if specified model is attached.

void	BeforeModelChange (imod::IModel *modelPtr) override
	This function will be called before update of the observer contents occures.

void	AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
	This function will be called after update of the observer contents occures.

Public Member Functions inherited from imod::IObserver
Public Member Functions inherited from imod::IModelEditor
virtual void	UpdateEditor (const istd::IChangeable::ChangeSet &changeSet)=0
	Updates editor with model data.

virtual void	UpdateModelFromEditor () const =0
	Updates model from editor.

virtual bool	IsReadOnly () const =0
	Returns `true` if the model data can be changed.

virtual void	SetReadOnly (bool state)=0
	Set flag that the model data can be changed.

Protected Member Functions
iproc::CTaskState	UpdateObjectFromFile (const QByteArray &docTypeId, QString filePath)

void	ResetPreview ()

void	UpdateGui (const istd::IChangeable::ChangeSet &changeSet) override

void	OnGuiCreated () override
	Called just after GUI is initialized.

void	OnGuiDestroyed () override
	Called just before GUI is released.

void	OnGuiRetranslate () override
	Called from widget event filter when GUI should be retranslated.

void	OnComponentCreated () override

void	OnComponentDestroyed () override

bool	GetFileExtensions (QStringList &result, const istd::IChangeable *dataObjectPtr=nullptr, int flags=-1, bool doAppend=false) const override
	Get file extensions supported by this loader.

QString	GetTypeDescription (const QString *extensionPtr=nullptr) const override
	Get description of object type associated with single extension.

Protected Member Functions inherited from istdgui::TGuiComponentBase< QWidget >
virtual QWidget *	CreateQtWidget (QWidget *parentPtr)
	Create slave widget object.

Protected Member Functions inherited from istdgui::CGuiComponentBase
virtual void	OnGuiShown ()
	Called from widget event filter when slave widget is shown.

virtual void	OnGuiHidden ()
	Called from widget event filter when slave widget is hidden.

virtual bool	OnKeyPressed (QKeyEvent *event)
	Called from widget event filter when key is pressed.

virtual void	OnRetranslate ()
	Called when non-GUI elements (like commands) should be retranslated.

void	SetStatusIcon (const QIcon &icon)
	Set status icon;.

void	SetStatusText (const QString &text)
	Set status text;.

void	OnLanguageChanged () override

void	OnDesignSchemaChanged () override

bool	eventFilter (QObject sourcePtr, QEvent eventPtr) override

void	OnComponentCreated () override

void	OnComponentDestroyed () override

Protected Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual const IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Protected Member Functions inherited from imod::TSingleModelObserverBase< ifile::IFileNameParam >
virtual ifile::IFileNameParam *	CastFromModel (imod::IModel *modelPtr) const

Protected Member Functions inherited from imod::CSingleModelObserverBase
void	SetModelPtr (imod::IModel *modelPtr)
	Set internal model pointer to specified value.

virtual void	OnUpdate (const istd::IChangeable::ChangeSet &changeSet)
	Called on update of observed model.

Protected Member Functions inherited from ifile::IFileTypeInfo

Additional Inherited Members
Static Public Member Functions inherited from istdgui::CGuiComponentBase
static void	MakeAutoSlotConnection (const QWidget &widget, QObject &object)

Protected Types inherited from ifile::IFileTypeInfo
enum	QueryFlags { QF_LOAD = 1 << 0 , QF_SAVE = 1 << 1 , QF_FILE = 1 << 2 , QF_DIRECTORY = 1 << 3 , QF_ANONYMOUS = 1 << 4 }
	Describe detailed options of query. More...

Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Protected Attributes inherited from istdgui::CGuiComponentBase
istd::CMainThreadCaller	m_updateGuiCaller

imod::TModelWrap< VisualStatus >	m_visualStatus

Detailed Description

Component for the preview of the file contents.

The component also observers the file system changes and updates the file preview automatically, if the file was changed.

Definition at line 37 of file CDocPreviewGuiComp.h.

Member Typedef Documentation

◆ BaseClass

istdgui::TDesignerGuiObserverCompBase<Ui::CDocPreviewGuiComp, ifile::IFileNameParam> idocgui::CDocPreviewGuiComp::BaseClass

Definition at line 44 of file CDocPreviewGuiComp.h.

Constructor & Destructor Documentation

◆ CDocPreviewGuiComp()

idocgui::CDocPreviewGuiComp::CDocPreviewGuiComp ( )

Member Function Documentation

◆ GetFileExtensions()

bool idocgui::CDocPreviewGuiComp::GetFileExtensions	(	QStringList &	result,
		const istd::IChangeable *	dataObjectPtr = nullptr,
		int	flags = -1,
		bool	doAppend = false ) const

overrideprotectedvirtual

Get file extensions supported by this loader.

Parameters

result	list of extensions, e.g. {"txt", "doc"}.
dataObjectPtr	optional pointer to data object for which all possible extensions are requested. It can be nullptr if any object is meant.
flags	set of flags

See also: QueryFlags.

Parameters

doAppend if true, list of extensions should be appended to existing list.

Implements ifile::IFileTypeInfo.

◆ GetTypeDescription()

QString idocgui::CDocPreviewGuiComp::GetTypeDescription ( const QString * extensionPtr = nullptr ) const

overrideprotectedvirtual

Get description of object type associated with single extension.

Implements ifile::IFileTypeInfo.

◆ LoadingFinished

void idocgui::CDocPreviewGuiComp::LoadingFinished	(	QByteArray	docTypeId,
		bool	isSuccess )

signal

◆ OnComponentCreated()

void idocgui::CDocPreviewGuiComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnComponentDestroyed()

void idocgui::CDocPreviewGuiComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnGuiCreated()

void idocgui::CDocPreviewGuiComp::OnGuiCreated ( )

overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiDestroyed()

void idocgui::CDocPreviewGuiComp::OnGuiDestroyed ( )

overrideprotectedvirtual

Called just before GUI is released.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiRetranslate()

void idocgui::CDocPreviewGuiComp::OnGuiRetranslate ( )

overrideprotectedvirtual

Called from widget event filter when GUI should be retranslated.

Reimplemented from istdgui::CGuiComponentBase.

◆ ResetPreview()

void idocgui::CDocPreviewGuiComp::ResetPreview ( )

protected

◆ UpdateGui()

void idocgui::CDocPreviewGuiComp::UpdateGui ( const istd::IChangeable::ChangeSet & changeSet )

overrideprotected

◆ UpdateObjectFromFile()

iproc::CTaskState idocgui::CDocPreviewGuiComp::UpdateObjectFromFile	(	const QByteArray &	docTypeId,
		QString	filePath )

protected

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

idocgui/CDocPreviewGuiComp.h

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CDocPreviewGuiComp()

Member Function Documentation

◆ GetFileExtensions()

◆ GetTypeDescription()

◆ LoadingFinished

◆ OnComponentCreated()

◆ OnComponentDestroyed()

◆ OnGuiCreated()

◆ OnGuiDestroyed()

◆ OnGuiRetranslate()

◆ ResetPreview()

◆ UpdateGui()

◆ UpdateObjectFromFile()