iqtdoc Namespace Reference

This package contains Qt implementations related to Document/View concept. More...

Classes
class	CDocumentImportExportCommandComp
	Component used for triggering of the document import/export command from the file menu of a document based application. More...
class	CDocumentMetaInfoEditorComp
class	CDoxygenHelpFileProviderComp
class	CExtendedDocumentTemplateComp
	Extension of idoc::CSingleDocumentTemplateComp providing additional Qt-specified functionality. More...
class	CExternalOpenDocumentCommandComp
class	CHtmlHelpGuiComp
	HTML-based help viewer component. More...
class	CHtmlHelpViewerComp
class	CMainWindowGuiComp
	Standard main window component for any document-based application. More...
class	CMainWindowGuiCompBase
class	CMultiDocumentWorkspaceGuiComp
	This class is a Qt-based workspace implementation of a multi-document manager. More...
class	CSingleDocumentWorkspaceGuiComp
	Qt-based workspace implementation of a single document manager. More...
class	CSingletonDocApplicationComp
	Singleton application component. More...
class	CStaticHelpFileProviderComp
class	CUndoManagerCommandsProviderComp
class	TQtDocumentManagerWrap
	Wrapper for general functionality of a Qt based document workspace. More...

Detailed Description

This package contains Qt implementations related to Document/View concept.

The iqtdoc namespace builds on the idoc framework to provide Qt-specific implementations for creating document-based GUI applications. It includes ready-to-use components for main windows, workspaces, help systems, and document management.

This package uses the following ACF packages:

• istd - Standard utilities and base classes
• iser - Serialization framework
• icomp - Component framework
• iqt - Qt integration utilities

Key Components

Main Window and Workspace

• CMainWindowGuiComp - Complete main window with menu, toolbar, and file operations
• CSingleDocumentWorkspaceGuiComp - Workspace for single document (SDI) applications
• CMultiDocumentWorkspaceGuiComp - MDI workspace for multiple documents

Help System

• CHtmlHelpGuiComp - HTML-based help viewer component
• CHtmlHelpViewerComp - Help viewer implementation
• CStaticHelpFileProviderComp - Provides static HTML help files
• CDoxygenHelpFileProviderComp - Integrates Doxygen-generated documentation

Document Management

• CSingletonDocApplicationComp - Single instance document application
• CExtendedDocumentTemplateComp - Extended template with additional features
• TQtDocumentManagerWrap - Qt-specific document manager wrapper

Commands and UI

• CUndoManagerCommandsProviderComp - Provides undo/redo commands for UI
• CDocumentImportExportCommandComp - Import/export functionality
• CExternalOpenDocumentCommandComp - Open documents in external applications
• CDocumentMetaInfoEditorComp - Edit document metadata

Building a Qt Document Application

The typical structure of a Qt document-based application using iqtdoc:

Application
    |
    +-- CMainWindowGuiComp (main window)
         |
         +-- CSingleDocumentWorkspaceGuiComp (or Multi)
         |    |
         |    +-- Document views
         |
         +-- IDocumentManager
              |
              +-- IDocumentTemplate
                   |
                   +-- Documents

Example: Single Document Application

// Configuration for a simple text editor
CSingletonDocApplicationComp {
       // Main window with standard menus and toolbars
       MainWindow = CMainWindowGuiComp {
              ApplicationInfo = ApplicationInfo
              DocumentManager = DocumentManager
              
              // Single document workspace
              Workspace = CSingleDocumentWorkspaceGuiComp {
                     DocumentManager = DocumentManager
              }
       }
       
       // Document manager
       DocumentManager = CSingleDocumentManagerBase {
              Template = TextDocumentTemplate
       }
       
       // Document template
       TextDocumentTemplate = CSingleDocumentTemplateComp {
              DocumentTypeId = "TextDocument"
              DocumentTypeName = "Text Document"
              DocumentFactory = CTextDocumentComp
              ViewFactory = CTextEditorGuiComp
              DocumentLoader = CTextFileLoaderComp
              UndoManager = CSerializedUndoManagerComp
       }
       
       // Optional: Help system
       HelpViewer = CHtmlHelpGuiComp {
              HelpFileProvider = CDoxygenHelpFileProviderComp {
                     HelpDirectory = "doc/html"
              }
       }
}

Example: Multi-Document Application (MDI)

// Configuration for MDI application
CMultiDocumentWorkspaceGuiComp {
       DocumentManager = DocumentManager
       
       // MDI-specific settings
       ViewMode = "Tabbed"  // or "Windowed"
       IsViewCloseEnabled = true
}
 
// Use multi-document manager
CMultiDocumentManagerBase {
       Template = CompositeTemplate
}
 
// Support multiple document types
CompositeTemplate = CCompositeDocumentTemplateComp {
       Templates = [
              TextDocumentTemplate,
              ImageDocumentTemplate,
              // ... more templates
       ]
}

Help System Integration

// Get help viewer
idoc::IHelpViewer* helpViewer = GetHelpViewer();
 
// Show help for a specific context
QString contextText = "MainWindow";
helpViewer->ShowHelp(contextText, nullptr);
 
// Show help for an object
istd::IPolymorphic* obj = GetCurrentObject();
helpViewer->ShowHelp("", obj);
 
// Check help quality before showing
double quality = helpViewer->GetHelpQuality(contextText, obj);
if (quality > 0.5) {
       // Good help available
       helpViewer->ShowHelp(contextText, obj);
}

Recent Files

The main window automatically maintains a list of recently opened files:

// Recent files are automatically managed by CMainWindowGuiComp
// Configuration:
CMainWindowGuiComp {
       MaxRecentFiles = 10  // Maximum number of recent files to remember
}
 
// Recent files appear in File menu automatically

Undo/Redo UI Integration

// Undo/redo commands are automatically integrated
// into the Edit menu by CMainWindowGuiComp
 
// Provide undo manager commands to UI
CUndoManagerCommandsProviderComp {
       DocumentManager = DocumentManager
}
 
// Commands will show descriptions from undo manager

See also

idoc namespace for core document/view interfaces