MFC Documentation

home download screen shots bugs mailing list example output generated MFC docs help tools and utilities

Overview

Project

Class

Tree

Index

MFC Class Library

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

MFC
Class CDocTemplate

CObject
   |
   +--CCmdTarget
         |
         +--CDocTemplate

in AFXWIN.H

Direct Known Subclasses:: CMultiDocTemplate, CSingleDocTemplate

class CDocTemplate
extends CCmdTarget

class CDocTemplate creates documents

Inner Classes, Typedefs, and Enums
`enum`	`CDocTemplate::Confidence`
`enum`	`CDocTemplate::DocStringIndex`

Field Summary
`BOOL`	`m_bAutoDelete`
`HACCEL`	`m_hAccelEmbedding`
`HACCEL`	`m_hAccelInPlace`
`HACCEL`	`m_hAccelInPlaceServer`
`HMENU`	`m_hMenuEmbedding`
`HMENU`	`m_hMenuInPlace`
`HMENU`	`m_hMenuInPlaceServer`
`protected UINT`	`m_nIDContainerResource`
`protected UINT`	`m_nIDEmbeddingResource`
`protected UINT`	`m_nIDResource`
`protected UINT`	`m_nIDServerResource`
`CObject*`	`m_pAttachedFactory`
`protected CRuntimeClass*`	`m_pDocClass`
`protected CRuntimeClass*`	`m_pFrameClass`
`protected CRuntimeClass*`	`m_pOleFrameClass`
`protected CRuntimeClass*`	`m_pOleViewClass`
`protected CRuntimeClass*`	`m_pViewClass`
`protected CString`	`m_strDocStrings`

Fields inherited from class CCmdTarget

messageMap, commandMap, dispatchMap, connectionMap, interfaceMap, eventsinkMap, m_dwRef, m_pOuterUnknown, m_xInnerUnknown, m_xDispatch, m_bResultExpected, m_xConnPtContainer

Fields inherited from class CObject

classCObject

Constructor Summary
`protected`	`CDocTemplate( UINT nIDResource, CRuntimeClass* pDocClass, CRuntimeClass* pFrameClass, CRuntimeClass* pViewClass )`
	`virtual ~CDocTemplate()`

Method Summary
`virtual void`	`AddDocument( CDocument* pDoc )`
`virtual void`	`CloseAllDocuments( BOOL bEndSession )`
`virtual CDocument*`	`CreateNewDocument()`
`virtual CFrameWnd*`	`CreateNewFrame( CDocument* pDoc, CFrameWnd* pOther )`
`CFrameWnd*`	`CreateOleFrame( CWnd* pParentWnd, CDocument* pDoc, BOOL bCreateView )`
`virtual BOOL`	`GetDocString( CString& rString, enum CDocTemplate::DocStringIndex index ) const`
`virtual POSITION`	`GetFirstDocPosition() const = 0`
`virtual CDocument*`	`GetNextDoc( POSITION& rPos ) const = 0`
`virtual void`	`InitialUpdateFrame( CFrameWnd* pFrame, CDocument* pDoc, BOOL bMakeVisible = TRUE )`
`virtual void`	`LoadTemplate()`
`virtual CDocTemplate::Confidence`	`MatchDocType( LPCTSTR lpszPathName, CDocument*& rpDocMatch )`
`virtual BOOL`	`OnCmdMsg( UINT nID, int nCode, void* pExtra, AFX_CMDHANDLERINFO* pHandlerInfo )`
`virtual void`	`OnIdle()`
`virtual CDocument*`	`OpenDocumentFile( LPCTSTR lpszPathName, BOOL bMakeVisible = TRUE )= 0`
`virtual void`	`RemoveDocument( CDocument* pDoc )`
`virtual BOOL`	`SaveAllModified()`
`void`	`SetContainerInfo( UINT nIDOleInPlaceContainer )`
`virtual void`	`SetDefaultTitle( CDocument* pDocument )= 0`
`void`	`SetServerInfo( UINT nIDOleEmbedding, UINT nIDOleInPlaceServer = 0, CRuntimeClass* pOleFrameClass = NULL, CRuntimeClass* pOleViewClass = NULL )`

Methods inherited from class CCmdTarget

GetIDispatch, FromIDispatch, IsResultExpected, EnableAutomation, EnableConnections, BeginWaitCursor, EndWaitCursor, RestoreWaitCursor, EnumOleVerbs, DoOleVerb, OnCmdMsg, OnFinalRelease, IsInvokeAllowed, EnableTypeLib, GetTypeInfoOfGuid, GetDispatchIID, GetTypeInfoCount, GetTypeLibCache, GetTypeLib, GetNotSupported, SetNotSupported, GetRoutingView, GetRoutingFrame, GetRoutingView_, GetRoutingFrame_, GetMessageMap, GetCommandMap, GetDispatchMap, GetConnectionMap, GetInterfaceMap, GetEventSinkMap, EnableAggregation, ExternalDisconnect, GetControllingUnknown, InternalQueryInterface, InternalAddRef, InternalRelease, ExternalQueryInterface, ExternalAddRef, ExternalRelease, GetInterface, QueryAggregates, OnCreateAggregates, GetInterfaceHook, GetStandardProp, SetStandardProp, GetEntryCount, GetDispEntry, MemberIDFromName, GetStackSize, PushStackArgs, CallMemberFunc, OnEvent, GetEventSinkEntry, GetExtraConnectionPoints, GetConnectionHook

Methods inherited from class CObject

GetRuntimeClass, new, new, delete, IsSerializable, IsKindOf, Serialize

Field Detail

m_bAutoDelete

public BOOL m_bAutoDelete;

m_hAccelEmbedding

public HACCEL m_hAccelEmbedding;

m_hAccelInPlace

public HACCEL m_hAccelInPlace;

m_hAccelInPlaceServer

public HACCEL m_hAccelInPlaceServer;

m_hMenuEmbedding

public HMENU m_hMenuEmbedding;

m_hMenuInPlace

public HMENU m_hMenuInPlace;

m_hMenuInPlaceServer

public HMENU m_hMenuInPlaceServer;

m_nIDContainerResource

protected UINT m_nIDContainerResource;

m_nIDEmbeddingResource

protected UINT m_nIDEmbeddingResource;

m_nIDResource

protected UINT m_nIDResource;

m_nIDServerResource

protected UINT m_nIDServerResource;

m_pAttachedFactory

public CObject* m_pAttachedFactory;

m_pDocClass

protected CRuntimeClass* m_pDocClass;

m_pFrameClass

protected CRuntimeClass* m_pFrameClass;

m_pOleFrameClass

protected CRuntimeClass* m_pOleFrameClass;

m_pOleViewClass

protected CRuntimeClass* m_pOleViewClass;

m_pViewClass

protected CRuntimeClass* m_pViewClass;

m_strDocStrings

protected CString m_strDocStrings;

Constructor Detail

CDocTemplate

protected CDocTemplate( UINT nIDResource, CRuntimeClass* pDocClass, CRuntimeClass* pFrameClass, CRuntimeClass* pViewClass );

~CDocTemplate

public virtual ~CDocTemplate();

Method Detail

AddDocument

public virtual void AddDocument( CDocument* pDoc );

CloseAllDocuments

public virtual void CloseAllDocuments( BOOL bEndSession );

CreateNewDocument

public virtual CDocument* CreateNewDocument();

CreateNewFrame

public virtual CFrameWnd* CreateNewFrame( CDocument* pDoc, CFrameWnd* pOther );

CreateOleFrame

public CFrameWnd* CreateOleFrame( CWnd* pParentWnd, CDocument* pDoc, BOOL bCreateView );

GetDocString

public virtual BOOL GetDocString( CString& rString, enum CDocTemplate::DocStringIndex index ) const;

GetFirstDocPosition

public virtual POSITION GetFirstDocPosition() const = 0;

GetNextDoc

public virtual CDocument* GetNextDoc( POSITION& rPos ) const = 0;

InitialUpdateFrame

public virtual void InitialUpdateFrame( CFrameWnd* pFrame, CDocument* pDoc, BOOL bMakeVisible = TRUE );

LoadTemplate

public virtual void LoadTemplate();

MatchDocType

public virtual CDocTemplate::Confidence MatchDocType( LPCTSTR lpszPathName, CDocument*& rpDocMatch );

OnCmdMsg

public virtual BOOL OnCmdMsg( UINT nID, int nCode, void* pExtra, AFX_CMDHANDLERINFO* pHandlerInfo );

OnIdle

public virtual void OnIdle();

OpenDocumentFile

public virtual CDocument* OpenDocumentFile( LPCTSTR lpszPathName, BOOL bMakeVisible = TRUE )= 0;

RemoveDocument

public virtual void RemoveDocument( CDocument* pDoc );

SaveAllModified

public virtual BOOL SaveAllModified();

SetContainerInfo

public void SetContainerInfo( UINT nIDOleInPlaceContainer );

SetDefaultTitle

public virtual void SetDefaultTitle( CDocument* pDocument )= 0;

SetServerInfo

public void SetServerInfo( UINT nIDOleEmbedding, UINT nIDOleInPlaceServer = 0, CRuntimeClass* pOleFrameClass = NULL, CRuntimeClass* pOleViewClass = NULL );