UI component for visualization of file system contents. More...

#include <CFileSystemExplorerGuiComp.h>

Inheritance diagram for ifilegui::CFileSystemExplorerGuiComp:

Collaboration diagram for ifilegui::CFileSystemExplorerGuiComp:

Public Types
typedef istdgui::TDesignerGuiObserverCompBase< Ui::CFileSystemExplorerGuiComp, 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...

Public Member Functions
	CFileSystemExplorerGuiComp ()

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 Types
enum	ModelIds { MID_ROOT , MID_FILTER }

Protected Member Functions
QStringList	GetDefaultFilters () const
	Get default list of filters.

void	InvalidateFileSystemModel (const QString &currentFilePath)

void	UpdateFileRoot ()

void	UpdateFileFilter ()

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

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

void	OnModelChanged (int modelId, const istd::IChangeable::ChangeSet &changeSet) override
	Called when some model observed by dispatcher will be changed.

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.

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

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

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 imod::CMultiModelDispatcherBase
bool	RegisterModel (IModel *modelPtr, int modelId=0, const istd::IChangeable::ChangeSet &relevantFlags=istd::IChangeable::GetAllChanges())
	Register the data model to be observed.

void	UnregisterModel (int modelId=0)
	Unregister the data model object.

void	UnregisterAllModels ()
	Unregister all observed data objects.

template<class Object >
Object *	GetObjectAt (int modelId) const
	Get concrete object instance of the obsered model.

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

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

UI component for visualization of file system contents.

CFileSystemExplorerGuiComp is implemented as an observer of IFileNameParam. Connected to model, this component will show the file system item, provided by the data model. Model data will be changed, if the the user selects a supported file item in the file system view.

Definition at line 39 of file CFileSystemExplorerGuiComp.h.

Member Typedef Documentation

◆ BaseClass

istdgui::TDesignerGuiObserverCompBase< Ui::CFileSystemExplorerGuiComp, ifile::IFileNameParam> ifilegui::CFileSystemExplorerGuiComp::BaseClass

Definition at line 46 of file CFileSystemExplorerGuiComp.h.

Member Enumeration Documentation

◆ ModelIds

enum ifilegui::CFileSystemExplorerGuiComp::ModelIds

protected

Enumerator
MID_ROOT
MID_FILTER

Definition at line 64 of file CFileSystemExplorerGuiComp.h.

Constructor & Destructor Documentation

◆ CFileSystemExplorerGuiComp()

ifilegui::CFileSystemExplorerGuiComp::CFileSystemExplorerGuiComp ( )

Member Function Documentation

◆ GetDefaultFilters()

QStringList ifilegui::CFileSystemExplorerGuiComp::GetDefaultFilters ( ) const

protected

Get default list of filters.

This list will be created using component parameters.

◆ InvalidateFileSystemModel()

void ifilegui::CFileSystemExplorerGuiComp::InvalidateFileSystemModel ( const QString & currentFilePath )

protected

◆ OnGuiCreated()

void ifilegui::CFileSystemExplorerGuiComp::OnGuiCreated ( )

overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnModelChanged()

void ifilegui::CFileSystemExplorerGuiComp::OnModelChanged	(	int	modelId,
		const istd::IChangeable::ChangeSet &	changeSet )

overrideprotectedvirtual

Called when some model observed by dispatcher will be changed.

Implements imod::CMultiModelDispatcherBase.

◆ UpdateFileFilter()

void ifilegui::CFileSystemExplorerGuiComp::UpdateFileFilter ( )

protected

◆ UpdateFileRoot()

void ifilegui::CFileSystemExplorerGuiComp::UpdateFileRoot ( )

protected

◆ UpdateGui()

void ifilegui::CFileSystemExplorerGuiComp::UpdateGui ( const istd::IChangeable::ChangeSet & changeSet )

overrideprotected

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

ifilegui/CFileSystemExplorerGuiComp.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ ModelIds

Constructor & Destructor Documentation

◆ CFileSystemExplorerGuiComp()

Member Function Documentation

◆ GetDefaultFilters()

◆ InvalidateFileSystemModel()

◆ OnGuiCreated()

◆ OnModelChanged()

◆ UpdateFileFilter()

◆ UpdateFileRoot()

◆ UpdateGui()