This class is a Qt-based workspace implementation of a document manager. More...

#include <CMultiDocumentWorkspaceGuiComp.h>

Inheritance diagram for idocgui::CMultiDocumentWorkspaceGuiComp:

Collaboration diagram for idocgui::CMultiDocumentWorkspaceGuiComp:

Public Types
enum	GroupId { GI_WINDOW = 0x300 , GI_DOCUMENT , GI_VIEW }

typedef idocgui::TQtDocumentManagerWrap< idoc::CMultiDocumentManagerBase, istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > > >	BaseClass

Public Types inherited from idocgui::TQtDocumentManagerWrap< idoc::CMultiDocumentManagerBase, istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > > >
typedef idoc::CMultiDocumentManagerBase	BaseClass

typedef BaseClass::Ids	Ids

Public Types inherited from idoc::CMultiDocumentManagerBase
enum	ModelId { MI_UNDO_MANAGER = 1 , MI_DOCUMENT }

Public Types inherited from idoc::IDocumentManager
enum	ChangeFlags { CF_DOCUMENT_RENAMED = 0x834d670 , CF_DOCUMENT_CREATED , CF_DOCUMENT_REMOVED , CF_DOCUMENT_COUNT_CHANGED , CF_VIEW_ACTIVATION_CHANGED }
	Possible changes in the mananger data model. More...

enum	OperationFlags { OF_FILE_NEW = 0x0001 , OF_FILE_OPEN = 0x0002 , OF_FILE_SAVE = 0x0004 , OF_FILE_SAVE_AS = 0x0008 , OF_KNOWN_PATH = 0x0010 }
	Flags describing possible operations. More...

typedef QMap< QString, QByteArray >	FileToTypeMap
	Map from file path to ducument type ID's.

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Types inherited from idoc::IDocumentTypesInfo
enum	SupportedFeatures { SF_NEW_DOCUMENT = 0x0001 , SF_EDIT_DOCUMENT = 0x0010 , SF_DEFAULT = 0xffff }
	Enumeration for supported types of operation with the document. More...

typedef QVector< QByteArray >	Ids

Public Types inherited from istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > >
typedef istdgui::TGuiComponentBase< QMdiArea >	BaseClass

Public Types inherited from istdgui::TGuiComponentBase< QMdiArea >
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 ibase::ICommandsProvider
enum	ChangeFlags { CF_COMMANDS = 0x62b7e8 }

Public Member Functions
	CMultiDocumentWorkspaceGuiComp ()

void	SetActiveView (istd::IPolymorphic *viewPtr) override
	Indicate that some view is active now.

const ibase::IHierarchicalCommand *	GetCommands () const override
	Get list of menu commands.

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

Public Member Functions inherited from idocgui::TQtDocumentManagerWrap< idoc::CMultiDocumentManagerBase, istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > > >
void	OnRestoreSettings (const QSettings &settings) override

void	OnSaveSettings (QSettings &settings) const override

QString	GetSaveFilePath (const QByteArray &documentTypeId, const istd::IChangeable *dataObjectPtr, const QString &currentFilePath) const override

Public Member Functions inherited from idoc::CMultiDocumentManagerBase
	CMultiDocumentManagerBase ()
	Default constructor.

virtual idoc::IUndoManager *	GetUndoManagerForDocument (const istd::IChangeable *documentPtr) const
	Return undo mananger for document `documenPtr`.

virtual int	GetDocumentsCount () const
	Get number of opened documents.

virtual istd::IChangeable &	GetDocumentFromIndex (int index, DocumentInfo *documentInfoPtr=nullptr) const
	Get document at specified index.

virtual int	GetViewsCount (int documentIndex) const
	Get number of view for specified document.

virtual istd::IPolymorphic *	GetViewFromIndex (int documentIndex, int viewIndex) const
	Get single view using its and document indices.

virtual istd::IPolymorphic *	GetActiveView () const
	Return the active document.

virtual istd::IChangeable *	GetDocumentFromView (const istd::IPolymorphic &view, DocumentInfo *documentInfoPtr=nullptr) const
	Return the document assigned to view.

virtual istd::IPolymorphic *	AddViewToDocument (const istd::IChangeable &document, const QByteArray &viewTypeId=QByteArray())
	Add a new view to the document.

virtual QByteArray	GetDocumentTypeId (const istd::IChangeable &document) const
	Get ID of document type managed by this object.

virtual bool	InsertNewDocument (const QByteArray &documentTypeId, bool createView=true, const QByteArray &viewTypeId="", istd::IChangeable *newDocumentPtr=nullptr, bool beQuiet=false, bool ignoredPtr=nullptr)
	Creates a new document with the document ID `documentTypeId`.

virtual bool	OpenDocument (const QByteArray documentTypeIdPtr, const QString fileNamePtr=nullptr, bool createView=true, const QByteArray &viewTypeId="", istd::IChangeable *documentPtr=nullptr, FileToTypeMap loadedMapPtr=nullptr, bool beQuiet=false, bool ignoredPtr=nullptr, iproc::IProgressManager progressManagerPtr=nullptr)
	Opens document(s) from the file list.

virtual bool	SaveDocument (int documentIndex=-1, bool requestFileName=false, FileToTypeMap savedMapPtr=nullptr, bool beQuiet=false, bool ignoredPtr=nullptr, iproc::IProgressManager *progressManagerPtr=nullptr)
	Save document.

virtual bool	SaveDirtyDocuments (bool beQuiet=false, bool *ignoredPtr=nullptr)
	Ask user (optional) and save all dirty (changed) documents.

virtual bool	CloseDocument (int documentIndex=-1, bool beQuiet=false, bool *ignoredPtr=nullptr)
	Close document and all its views.

virtual bool	CloseView (istd::IPolymorphic viewPtr=nullptr, bool beQuiet=false, bool ignoredPtr=nullptr)
	Close view.

Public Member Functions inherited from idoc::CTmplBasedDocumentManagerBase
	CTmplBasedDocumentManagerBase ()

virtual int	GetAllowedOperationFlags (const istd::IPolymorphic *viewPtr=nullptr) const
	Get flags of allowed operations.

virtual bool	IsFeatureSupported (int featureFlags, const QByteArray &documentTypeId) const
	Return `true`, if the feature(s) is supported by this document template.

virtual Ids	GetDocumentTypeIds () const
	Get list of supported document ID's can be created for specified file.

virtual QString	GetDocumentTypeName (const QByteArray &documentTypeId) const
	Get human readable name of some document type ID.

virtual ifile::IFileTypeInfo *	GetDocumentFileTypeInfo (const QByteArray &documentTypeId) const
	Get file type information object for some selected document type.

virtual Ids	GetDocumentTypeIdsForFile (const QString &filePath) const
	Get list of supported document ID's can be created for specified file.

virtual QString	GetDefaultDirectory (const QString &sugestedDir="", const QByteArray *documentTypeIdPtr=nullptr) const
	Return default directory for specified document type.

Public Member Functions inherited from idoc::IDocumentManager
Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from idoc::IDocumentTypesInfo
Public Member Functions inherited from istdgui::TGuiComponentBase< QMdiArea >
	TGuiComponentBase ()

virtual QMdiArea *	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.

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

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 ibase::ICommandsProvider

Protected Slots
void	OnWindowActivated (QMdiSubWindow *window)

void	OnCloseAllViews ()

Protected Member Functions
void	UpdateAllTitles ()
	Update titles of views or all views of specified document.

istdgui::IGuiObject *	GetViewFromWidget (const QWidget &widget) const
	Find view object associated with specified Qt widget.

int	GetDocumentIndexFromWidget (const QWidget &widget) const
	Find index of document associated with specified Qt widget.

virtual void	CreateConnections ()
	Creates signal/slot connnections for the implementation.

void	OnViewsCountChanged ()
	Called when number of windows changed.

istd::IChangeable *	OpenSingleDocument (const QString &filePath, bool createView, const QByteArray &viewTypeId, QByteArray &documentTypeId, bool beQuiet, bool ignoredPtr, iproc::IProgressManager progressManagerPtr) override
	Open single document using its file path.

bool	eventFilter (QObject sourcePtr, QEvent eventPtr) override

void	OnRestoreSettings (const QSettings &settings) override

void	OnSaveSettings (QSettings &settings) const override

void	CloseAllDocuments () override

QStringList	GetOpenFilePaths (const QByteArray *documentTypeIdPtr=nullptr) const override
	Gets open file names.

void	OnViewRegistered (istd::IPolymorphic *viewPtr, const SingleDocumentData &documentData) override
	Called after view is registered.

void	OnViewRemoved (istd::IPolymorphic *viewPtr) override
	Called before view is removed.

bool	QueryDocumentSave (const SingleDocumentData &info, bool *ignoredPtr) override
	Query user if this document should be saved.

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

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

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

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

void	OnComponentCreated () override

void	OnEndChanges (const ChangeSet &changeSet) override
	Callback function for end change event.

Protected Member Functions inherited from idocgui::TQtDocumentManagerWrap< idoc::CMultiDocumentManagerBase, istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > > >
QStringList	CreateFileDialogFilters (const QByteArray documentTypeIdPtr, const istd::IChangeable dataObjectPtr, int flags) const
	Creates the filter for the file selection dialog.

void	UpdateLastDirectory (const QString &filePath) const

virtual QStringList	GetOpenFilePathesFromDialog (const QByteArray *documentTypeIdPtr) const

Protected Member Functions inherited from idoc::CMultiDocumentManagerBase
SingleDocumentData &	GetSingleDocumentData (int index) const
	Get internal document data object.

SingleDocumentData *	GetActiveDocumentInfo () const
	Get document info assigned to active view.

SingleDocumentData *	GetDocumentInfoFromView (const istd::IPolymorphic &view) const
	Get document info assigned to specified view.

SingleDocumentData *	GetDocumentInfoFromPath (const QString &filePath) const
	Get document info assigned to specified file.

int	GetDocumentIndex (const SingleDocumentData &document) const
	Get position index of the given document in the document list.

virtual std::unique_ptr< SingleDocumentData >	CreateUnregisteredDocument (const QByteArray &documentTypeId, bool createView, const QByteArray &viewTypeId, bool initialize, bool beQuiet, bool *ignoredPtr) const
	Create instance of specified document without attaching to this manager.

bool	RegisterDocument (SingleDocumentData *documentPtr)
	Register (attach) created document as new working document.

bool	SerializeOpenDocumentList (iser::IArchive &archive)
	Serializes open documents information.

virtual void	OnDocumentSaved ()
	Execute after document saved.

Protected Member Functions inherited from idoc::CTmplBasedDocumentManagerBase
virtual const idoc::IDocumentTemplate *	GetDocumentTemplate () const

void	SetDocumentTemplate (const idoc::IDocumentTemplate *documentTemplatePtr)

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

Protected Member Functions inherited from istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > >
bool	CreateGui (QWidget *parentPtr) override

bool	DestroyGui () override

Protected Member Functions inherited from istdgui::TGuiComponentBase< QMdiArea >
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.

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	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.

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

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

Protected Types inherited from idoc::CMultiDocumentManagerBase
typedef std::unique_ptr< istd::IChangeable >	DocumentPtr

typedef std::unique_ptr< idoc::IUndoManager >	UndoManagerPtr

typedef std::unique_ptr< istd::IPolymorphic >	ViewPtr

typedef std::vector< ViewInfo >	Views

typedef istd::TPointerVector< SingleDocumentData >	DocumentInfos

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 idoc::CMultiDocumentManagerBase
DocumentInfos	m_documentInfos

istd::IPolymorphic *	m_activeViewPtr

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

imod::TModelWrap< VisualStatus >	m_visualStatus

Detailed Description

This class is a Qt-based workspace implementation of a document manager.

Definition at line 33 of file CMultiDocumentWorkspaceGuiComp.h.

Member Typedef Documentation

◆ BaseClass

idocgui::TQtDocumentManagerWrap< idoc::CMultiDocumentManagerBase, istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase<QMdiArea> > > idocgui::CMultiDocumentWorkspaceGuiComp::BaseClass

Definition at line 46 of file CMultiDocumentWorkspaceGuiComp.h.

Member Enumeration Documentation

◆ GroupId

enum idocgui::CMultiDocumentWorkspaceGuiComp::GroupId

Enumerator
GI_WINDOW
GI_DOCUMENT
GI_VIEW

Definition at line 66 of file CMultiDocumentWorkspaceGuiComp.h.

Constructor & Destructor Documentation

◆ CMultiDocumentWorkspaceGuiComp()

idocgui::CMultiDocumentWorkspaceGuiComp::CMultiDocumentWorkspaceGuiComp ( )

Member Function Documentation

◆ CloseAllDocuments()

void idocgui::CMultiDocumentWorkspaceGuiComp::CloseAllDocuments ( )

overrideprotectedvirtual

Reimplemented from idoc::CMultiDocumentManagerBase.

◆ CreateConnections()

virtual void idocgui::CMultiDocumentWorkspaceGuiComp::CreateConnections ( )

protectedvirtual

Creates signal/slot connnections for the implementation.

◆ eventFilter()

bool idocgui::CMultiDocumentWorkspaceGuiComp::eventFilter	(	QObject *	sourcePtr,
		QEvent *	eventPtr )

overrideprotected

◆ GetCommands()

const ibase::IHierarchicalCommand * idocgui::CMultiDocumentWorkspaceGuiComp::GetCommands ( ) const

overridevirtual

Get list of menu commands.

These commands will be integrated in global menu system, independent from actual selected view. For support of normal pull down menu, depth of this tree structure should be at least 3.

Reimplemented from ibase::ICommandsProvider.

◆ GetDocumentIndexFromWidget()

int idocgui::CMultiDocumentWorkspaceGuiComp::GetDocumentIndexFromWidget ( const QWidget & widget ) const

protected

Find index of document associated with specified Qt widget.

Parameters

widget Qt widget representing view.

Returns: index of document or negative value if nothing is found.

◆ GetOpenFilePaths()

QStringList idocgui::CMultiDocumentWorkspaceGuiComp::GetOpenFilePaths ( const QByteArray * documentTypeIdPtr = nullptr ) const

overrideprotectedvirtual

Gets open file names.

Implements idoc::CMultiDocumentManagerBase.

◆ GetViewFromWidget()

istdgui::IGuiObject * idocgui::CMultiDocumentWorkspaceGuiComp::GetViewFromWidget ( const QWidget & widget ) const

protected

Find view object associated with specified Qt widget.

Parameters

widget Qt widget representing view.

Returns: associated view or nullptr if nothing is found.

◆ OnCloseAllViews

void idocgui::CMultiDocumentWorkspaceGuiComp::OnCloseAllViews ( )

protectedslot

◆ OnComponentCreated()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from istdgui::CGuiComponentBase.

◆ OnEndChanges()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnEndChanges ( const ChangeSet & changeSet )

overrideprotectedvirtual

Callback function for end change event.

Reimplemented from istd::IChangeable.

◆ OnGuiCreated()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnGuiCreated ( )

overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiDestroyed()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnGuiDestroyed ( )

overrideprotectedvirtual

Called just before GUI is released.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnGuiRetranslate()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnGuiRetranslate ( )

overrideprotectedvirtual

Called from widget event filter when GUI should be retranslated.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnRestoreSettings()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnRestoreSettings ( const QSettings & settings )

overrideprotectedvirtual

Implements istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > >.

◆ OnRetranslate()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnRetranslate ( )

overrideprotectedvirtual

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

Reimplemented from istdgui::CGuiComponentBase.

◆ OnSaveSettings()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnSaveSettings ( QSettings & settings ) const

overrideprotectedvirtual

Implements istdgui::TRestorableGuiWrap< istdgui::TGuiComponentBase< QMdiArea > >.

◆ OnTryClose()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnTryClose ( bool * ignoredPtr = nullptr )

overridevirtual

Called on trying to close application.

Parameters

ignoredPtr if it is not nullptr, ignoring of close is allowed. In this case implementation should set pointed value to true.

Reimplemented from istdgui::CGuiComponentBase.

◆ OnViewRegistered()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnViewRegistered	(	istd::IPolymorphic *	viewPtr,
		const SingleDocumentData &	documentData )

overrideprotectedvirtual

Called after view is registered.

Implements idoc::CMultiDocumentManagerBase.

◆ OnViewRemoved()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnViewRemoved ( istd::IPolymorphic * viewPtr )

overrideprotectedvirtual

Called before view is removed.

Implements idoc::CMultiDocumentManagerBase.

◆ OnViewsCountChanged()

void idocgui::CMultiDocumentWorkspaceGuiComp::OnViewsCountChanged ( )

protected

Called when number of windows changed.

◆ OnWindowActivated

void idocgui::CMultiDocumentWorkspaceGuiComp::OnWindowActivated ( QMdiSubWindow * window )

protectedslot

◆ OpenSingleDocument()

istd::IChangeable * idocgui::CMultiDocumentWorkspaceGuiComp::OpenSingleDocument	(	const QString &	filePath,
		bool	createView,
		const QByteArray &	viewTypeId,
		QByteArray &	documentTypeId,
		bool	beQuiet,
		bool *	ignoredPtr,
		iproc::IProgressManager *	progressManagerPtr )

overrideprotectedvirtual

Open single document using its file path.

Parameters

filePath	file path.
createView	if true, instance of view will be created.
viewTypeId	optional view type ID should be created.
documentTypeId	output parameter returning loaded ducument type ID.

Returns: instance of created document or nullptr if error is occured.

Reimplemented from idoc::CMultiDocumentManagerBase.

◆ QueryDocumentSave()

bool idocgui::CMultiDocumentWorkspaceGuiComp::QueryDocumentSave	(	const SingleDocumentData &	info,
		bool *	ignoredPtr )

overrideprotectedvirtual

Query user if this document should be saved.

Parameters

info	document info of document will be closed.
ignoredPtr	optional return flag indicating that user ignored this close operation.

Implements idoc::CMultiDocumentManagerBase.

◆ SetActiveView()

void idocgui::CMultiDocumentWorkspaceGuiComp::SetActiveView ( istd::IPolymorphic * viewPtr )

overridevirtual

Indicate that some view is active now.

Reimplemented from idoc::CMultiDocumentManagerBase.

◆ UpdateAllTitles()

void idocgui::CMultiDocumentWorkspaceGuiComp::UpdateAllTitles ( )

protected

Update titles of views or all views of specified document.

Parameters

optional document object, if you want to update only views of single document.

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

idocgui/CMultiDocumentWorkspaceGuiComp.h

Public Types

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ GroupId

Constructor & Destructor Documentation

◆ CMultiDocumentWorkspaceGuiComp()

Member Function Documentation

◆ CloseAllDocuments()

◆ CreateConnections()

◆ eventFilter()

◆ GetCommands()

◆ GetDocumentIndexFromWidget()

◆ GetOpenFilePaths()

◆ GetViewFromWidget()

◆ OnCloseAllViews

◆ OnComponentCreated()

◆ OnEndChanges()

◆ OnGuiCreated()

◆ OnGuiDestroyed()

◆ OnGuiRetranslate()

◆ OnRestoreSettings()

◆ OnRetranslate()

◆ OnSaveSettings()

◆ OnTryClose()

◆ OnViewRegistered()

◆ OnViewRemoved()

◆ OnViewsCountChanged()

◆ OnWindowActivated

◆ OpenSingleDocument()

◆ QueryDocumentSave()

◆ SetActiveView()

◆ UpdateAllTitles()