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 COleServerDoc

CObject
   |
   +--CCmdTarget
         |
         +--CDocument
               |
               +--COleDocument
                     |
                     +--COleLinkingDoc
                           |
                           +--COleServerDoc

in AFXOLE.H

Direct Known Subclasses:: CRichEditDoc

class COleServerDoc
extends COleLinkingDoc

COleServerDoc - registered server document containing COleServerItems

Field Summary
`protected BOOL`	`m_bClosing`
`protected BOOL`	`m_bCntrVisible`
`protected DWORD`	`m_dwOrigStyle`
`protected DWORD`	`m_dwOrigStyleEx`
`protected LPOLECLIENTSITE`	`m_lpClientSite`
`protected CDocObjectServer*`	`m_pDocObjectServer`
`protected COleServerItem*`	`m_pEmbeddedItem`
`protected COleIPFrameWnd*`	`m_pInPlaceFrame`
`protected CWnd*`	`m_pOrigParent`
`protected CString`	`m_strHostObj`

Fields inherited from class COleLinkingDoc

m_pFactory, m_bDeferErrors, m_pLastException, m_dwRegister, m_lpMonikerROT, m_strMoniker, m_bVisibleLock

Fields inherited from class COleDocument

m_docItemList, m_dwNextItemNumber, m_bLastVisible, m_bCompoundFile, m_lpRootStg, m_bSameAsLoad, m_bRemember, m_ptd

Fields inherited from class CDocument

m_strTitle, m_strPathName, m_pDocTemplate, m_viewList, m_bModified, m_bAutoDelete, m_bEmbedded, messageMap

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
`COleServerDoc()`
`virtual ~COleServerDoc()`

Method Summary
`void`	`ActivateDocObject()`
`BOOL`	`ActivateInPlace()`
`virtual BOOL`	`CanCloseFrame( CFrameWnd* pFrame )`
`protected void`	`ConnectView( CWnd* pParentWnd, CView* pView )`
`protected virtual COleIPFrameWnd*`	`CreateInPlaceFrame( CWnd* pParentWnd )`
`BOOL`	`DeactivateAndUndo()`
`virtual void`	`DeleteContents()`
`protected virtual void`	`DestroyInPlaceFrame( COleIPFrameWnd* pFrameWnd )`
`BOOL`	`DiscardUndoState()`
`protected virtual HACCEL`	`GetDefaultAccelerator()`
`protected virtual HMENU`	`GetDefaultMenu()`
`protected virtual CDocObjectServer*`	`GetDocObjectServer( LPOLEDOCUMENTSITE pDocSite )`
`COleServerItem*`	`GetEmbeddedItem()`
`protected virtual BOOL`	`GetFileTypeString( CString& rString )`
`protected LPUNKNOWN`	`GetInterfaceHook( const void* piid )`
`void`	`GetItemClipRect( LPRECT lpClipRect ) const`
`void`	`GetItemPosition( LPRECT lpPosRect ) const`
`virtual LPMONIKER`	`GetMoniker( OLEGETMONIKER nAssign )`
`BOOL`	`GetZoomFactor( LPSIZE lpSizeNum = NULL, LPSIZE lpSizeDenom = NULL, LPCRECT lpPosRect = NULL ) const`
`BOOL`	`IsDocObject() const`
`BOOL`	`IsEmbedded() const`
`BOOL`	`IsInPlaceActive() const`
`protected void`	`NotifyAllItems( OLE_NOTIFICATION wNotification, DWORD dwParam )`
`void`	`NotifyChanged()`
`void`	`NotifyClosed()`
`void`	`NotifyRename( LPCTSTR lpszNewName )`
`void`	`NotifySaved()`
`protected virtual void`	`OnClose( OLECLOSE dwCloseOption )`
`virtual void`	`OnCloseDocument()`
`virtual void`	`OnDeactivate()`
`virtual void`	`OnDeactivateUI( BOOL bUndoable )`
`protected virtual void`	`OnDocWindowActivate( BOOL bActivate )`
`protected virtual HRESULT`	`OnExecOleCmd( const GUID* pguidCmdGroup, DWORD nCmdID, DWORD nCmdExecOpt, VARIANTARG* pvarargIn, VARIANTARG* pvarargOut )`
`protected afx_msg void`	`OnFileSaveCopyAs()`
`protected afx_msg void`	`OnFileUpdate()`
`protected virtual void`	`OnFrameWindowActivate( BOOL bActivate )`
`protected virtual COleServerItem*`	`OnGetEmbeddedItem()= 0`
`virtual COleServerItem*`	`OnGetLinkedItem( LPCTSTR lpszItemName )`
`protected virtual void`	`OnNewEmbedding( LPSTORAGE lpStorage )`
`protected virtual void`	`OnOpenEmbedding( LPSTORAGE lpStorage )`
`protected virtual BOOL`	`OnReactivateAndUndo()`
`virtual void`	`OnResizeBorder( LPCRECT lpRectBorder, LPOLEINPLACEUIWINDOW lpUIWindow, BOOL bFrame )`
`virtual BOOL`	`OnSaveDocument( LPCTSTR lpszPathName )`
`protected virtual void`	`OnSaveEmbedding( LPSTORAGE lpStorage )`
`protected virtual void`	`OnSetHostNames( LPCTSTR lpszHost, LPCTSTR lpszHostObj )`
`protected virtual void`	`OnSetItemRects( LPCRECT lpPosRect, LPCRECT lpClipRect )`
`protected virtual void`	`OnShowControlBars( CFrameWnd* pFrameWnd, BOOL bShow )`
`protected virtual void`	`OnShowDocument( BOOL bShow )`
`virtual BOOL`	`OnUpdateDocument()`
`protected afx_msg void`	`OnUpdateFileExit( CCmdUI* pCmdUI )`
`protected afx_msg void`	`OnUpdateFileUpdate( CCmdUI* pCmdUI )`
`void`	`RequestPositionChange( LPCRECT lpPosRect )`
`void`	`SaveEmbedding()`
`protected virtual BOOL`	`SaveModified()`
`protected BOOL`	`SaveModifiedPrompt()`
`BOOL`	`ScrollContainerBy( CSize sizeScroll )`
`void`	`UpdateAllItems( COleServerItem* pSender, LPARAM lHint = 0L, CObject* pHint = NULL, DVASPECT nDrawAspect = DVASPECT_CONTENT )`
`protected void`	`UpdateUsingHostObj( UINT nIDS, CCmdUI* pCmdUI )`

Methods inherited from class COleLinkingDoc

Register, Revoke, OnGetLinkedItem, OnFindEmbeddedItem, OnNewDocument, OnOpenDocument, OnSaveDocument, OnCloseDocument, GetContainer, GetMoniker, ReportSaveLoadException, BeginDeferErrors, EndDeferErrors, RegisterIfServerAttached, LockExternal, UpdateVisibleLock, OnShowViews, SaveToStorage

Methods inherited from class COleDocument

HasBlankItems, GetInPlaceActiveItem, GetStartPosition, GetNextItem, GetNextClientItem, GetNextServerItem, AddItem, RemoveItem, EnableCompoundFile, UpdateModifiedFlag, ApplyPrintDevice, ApplyPrintDevice, GetPrimarySelectedItem, OnShowViews, GetFirstFrame, SetPathName, DeleteContents, Serialize, PreCloseFrame, SaveModified, OnIdle, OnNewDocument, OnOpenDocument, OnSaveDocument, OnCloseDocument, CommitItems, GetMoniker, GetContainer, LoadFromStorage, SaveToStorage, GetNextItemOfKind, OnCmdMsg, OnUpdatePasteMenu, OnUpdatePasteLinkMenu, OnUpdateEditLinksMenu, OnEditLinks, OnEditConvert, OnUpdateEditChangeIcon, OnEditChangeIcon, OnUpdateObjectVerbMenu, OnFileSendMail

Methods inherited from class CDocument

GetTitle, SetTitle, GetPathName, SetPathName, GetDocTemplate, IsModified, SetModifiedFlag, AddView, RemoveView, GetFirstViewPosition, GetNextView, UpdateAllViews, OnChangedViewList, DeleteContents, OnNewDocument, OnOpenDocument, OnSaveDocument, OnCloseDocument, ReportSaveLoadException, GetFile, ReleaseFile, CanCloseFrame, SaveModified, PreCloseFrame, DoSave, DoFileSave, UpdateFrameCounts, DisconnectViews, SendInitialUpdate, GetDefaultMenu, GetDefaultAccelerator, OnIdle, OnFinalRelease, OnCmdMsg, OnFileClose, OnFileSave, OnFileSaveAs, OnFileSendMail, OnUpdateFileSendMail, GetMessageMap

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_bClosing

protected BOOL m_bClosing;

m_bCntrVisible

protected BOOL m_bCntrVisible;

m_dwOrigStyle

protected DWORD m_dwOrigStyle;

m_dwOrigStyleEx

protected DWORD m_dwOrigStyleEx;

m_lpClientSite

protected LPOLECLIENTSITE m_lpClientSite;

m_pDocObjectServer

protected CDocObjectServer* m_pDocObjectServer;

m_pEmbeddedItem

protected COleServerItem* m_pEmbeddedItem;

m_pInPlaceFrame

protected COleIPFrameWnd* m_pInPlaceFrame;

m_pOrigParent

protected CWnd* m_pOrigParent;

m_strHostObj

protected CString m_strHostObj;

Constructor Detail

COleServerDoc

public COleServerDoc();

~COleServerDoc

public virtual ~COleServerDoc();

Method Detail

ActivateDocObject

public void ActivateDocObject();

ActivateInPlace

public BOOL ActivateInPlace();

CanCloseFrame

public virtual BOOL CanCloseFrame( CFrameWnd* pFrame );

ConnectView

protected void ConnectView( CWnd* pParentWnd, CView* pView );

CreateInPlaceFrame

protected virtual COleIPFrameWnd* CreateInPlaceFrame( CWnd* pParentWnd );

DeactivateAndUndo

public BOOL DeactivateAndUndo();

DeleteContents

public virtual void DeleteContents();

DestroyInPlaceFrame

protected virtual void DestroyInPlaceFrame( COleIPFrameWnd* pFrameWnd );

DiscardUndoState

public BOOL DiscardUndoState();

GetDefaultAccelerator

protected virtual HACCEL GetDefaultAccelerator();

GetDefaultMenu

protected virtual HMENU GetDefaultMenu();

GetDocObjectServer

protected virtual CDocObjectServer* GetDocObjectServer( LPOLEDOCUMENTSITE pDocSite );

GetEmbeddedItem

public COleServerItem* GetEmbeddedItem();

GetFileTypeString

protected virtual BOOL GetFileTypeString( CString& rString );

GetInterfaceHook

protected LPUNKNOWN GetInterfaceHook( const void* piid );

GetItemClipRect

public void GetItemClipRect( LPRECT lpClipRect ) const;

GetItemPosition

public void GetItemPosition( LPRECT lpPosRect ) const;

GetMoniker

public virtual LPMONIKER GetMoniker( OLEGETMONIKER nAssign );

GetZoomFactor

public BOOL GetZoomFactor( LPSIZE lpSizeNum = NULL, LPSIZE lpSizeDenom = NULL, LPCRECT lpPosRect = NULL ) const;

IsDocObject

public BOOL IsDocObject() const;

IsEmbedded

public BOOL IsEmbedded() const;

IsInPlaceActive

public BOOL IsInPlaceActive() const;

NotifyAllItems

protected void NotifyAllItems( OLE_NOTIFICATION wNotification, DWORD dwParam );

NotifyChanged

public void NotifyChanged();

NotifyClosed

public void NotifyClosed();

NotifyRename

public void NotifyRename( LPCTSTR lpszNewName );

NotifySaved

public void NotifySaved();

OnClose

protected virtual void OnClose( OLECLOSE dwCloseOption );

OnCloseDocument

public virtual void OnCloseDocument();

OnDeactivate

public virtual void OnDeactivate();

OnDeactivateUI

public virtual void OnDeactivateUI( BOOL bUndoable );

OnDocWindowActivate

protected virtual void OnDocWindowActivate( BOOL bActivate );

OnExecOleCmd

protected virtual HRESULT OnExecOleCmd( const GUID* pguidCmdGroup, DWORD nCmdID, DWORD nCmdExecOpt, VARIANTARG* pvarargIn, VARIANTARG* pvarargOut );

OnFileSaveCopyAs

protected afx_msg void OnFileSaveCopyAs();

OnFileUpdate

protected afx_msg void OnFileUpdate();

OnFrameWindowActivate

protected virtual void OnFrameWindowActivate( BOOL bActivate );

OnGetEmbeddedItem

protected virtual COleServerItem* OnGetEmbeddedItem()= 0;

OnGetLinkedItem

public virtual COleServerItem* OnGetLinkedItem( LPCTSTR lpszItemName );

OnNewEmbedding

protected virtual void OnNewEmbedding( LPSTORAGE lpStorage );

OnOpenEmbedding

protected virtual void OnOpenEmbedding( LPSTORAGE lpStorage );

OnReactivateAndUndo

protected virtual BOOL OnReactivateAndUndo();

OnResizeBorder

public virtual void OnResizeBorder( LPCRECT lpRectBorder, LPOLEINPLACEUIWINDOW lpUIWindow, BOOL bFrame );

OnSaveDocument

public virtual BOOL OnSaveDocument( LPCTSTR lpszPathName );

OnSaveEmbedding

protected virtual void OnSaveEmbedding( LPSTORAGE lpStorage );

OnSetHostNames

protected virtual void OnSetHostNames( LPCTSTR lpszHost, LPCTSTR lpszHostObj );

OnSetItemRects

protected virtual void OnSetItemRects( LPCRECT lpPosRect, LPCRECT lpClipRect );

OnShowControlBars

protected virtual void OnShowControlBars( CFrameWnd* pFrameWnd, BOOL bShow );

OnShowDocument

protected virtual void OnShowDocument( BOOL bShow );

OnUpdateDocument

public virtual BOOL OnUpdateDocument();

OnUpdateFileExit

protected afx_msg void OnUpdateFileExit( CCmdUI* pCmdUI );

OnUpdateFileUpdate

protected afx_msg void OnUpdateFileUpdate( CCmdUI* pCmdUI );

RequestPositionChange

public void RequestPositionChange( LPCRECT lpPosRect );

SaveEmbedding

public void SaveEmbedding();

SaveModified

protected virtual BOOL SaveModified();

SaveModifiedPrompt

protected BOOL SaveModifiedPrompt();

ScrollContainerBy

public BOOL ScrollContainerBy( CSize sizeScroll );

UpdateAllItems

public void UpdateAllItems( COleServerItem* pSender, LPARAM lHint = 0L, CObject* pHint = NULL, DVASPECT nDrawAspect = DVASPECT_CONTENT );

UpdateUsingHostObj

protected void UpdateUsingHostObj( UINT nIDS, CCmdUI* pCmdUI );