Link Viewer object for a server document. More...

#include <ocf/oclink.h>

Inheritance diagram for ocf::TOcLinkView:

Public Member Functions
	TOcLinkView (TOcView ocView, owl::TRegList regList=0, IUnknown *outer=0)

int	Detach ()
	Remove this link view from the document.

void	Invalidate (TOcInvalidate)
	Invalidate the site corresponding to this view.

void	Disconnect ()
	Disconnect from the client site.

void	GetLinkRect ()
	Get the initial size and position from the host app into our members.

void	SetMoniker (LPCTSTR name)
	Remember the name of the moniker.

owl::TString &	GetMoniker ()

owl::ulong _IFUNC	AddRef ()

owl::ulong _IFUNC	Release ()

HRESULT _IFUNC	QueryInterface (const GUID &iid, void **iface)

Public Member Functions inherited from ocf::TUnknown
	operator IUnknown & ()

	operator IUnknown * ()

IUnknown *	SetOuter (IUnknown *outer=0)

IUnknown *	GetOuter ()

unsigned long	GetRefCount ()

unsigned long	AdjustRefCount (int i)

IUnknown &	Aggregate (TUnknown &inner)

Protected Member Functions
HRESULT	QueryObject (const IID &iid, void **iface)

owl::uint _IFUNC	CountFormats ()

HRESULT _IFUNC	GetFormat (owl::uint index, TOcFormatInfo *fmt)

HANDLE _IFUNC	GetFormatData (TOcFormatInfo *)
	Request native data for pasting into client application.

HRESULT _IFUNC	Draw (HDC, const RECTL , const RECTL , TOcAspect, TOcDraw bd)
	Render the view in the DC provided.

HRESULT _IFUNC	GetPartSize (owl::TSize *)
	Return the 'size' of the document that this view in on.

HRESULT _IFUNC	Save (IStorage *, BOOL sameAsLoad, BOOL remember)
	Save the document that we are a view on.

HRESULT _IFUNC	Init (IBSite , TOcInitInfo )
	Load the associated document and activate the remote view.

HRESULT _IFUNC	Close ()
	Close the remote view window, & if canShutDown is true, try to close the server app too.

HRESULT _IFUNC	CanOpenInPlace ()
	Query to determine if this view can open in place.

HRESULT _IFUNC	SetPartSize (owl::TSize *)

HRESULT _IFUNC	SetPartPos (owl::TRect *)
	Set a new position for our document within its container.

HRESULT _IFUNC	Activate (BOOL)
	Activate this view.

HRESULT _IFUNC	Show (BOOL)
	Show/Hide the server view window.

HRESULT _IFUNC	Open (BOOL)
	Start or end open editing Work with the window Z-order and parenting.

HRESULT _IFUNC	EnumVerbs (TOcVerb *)
	Enumerate the verbs for our document.

HRESULT _IFUNC	DoVerb (owl::uint)
	Perform a verb on our document.

HWND _IFUNC	OpenInPlace (HWND)
	Open or close this view as an in-place edit session.

HRESULT _IFUNC	InsertMenus (HMENU, TOcMenuWidths *)
	Insert the server's menus into the shared menubar.

HRESULT _IFUNC	ShowTools (BOOL)
	Show or hide the tool windows used by our view.

void _IFUNC	FrameResized (const owl::TRect *, BOOL)
	A container window has resized.

HRESULT _IFUNC	DragFeedback (owl::TPoint *, BOOL)
	Let the server provide drag feedback.

HRESULT _IFUNC	GetPalette (LOGPALETTE **)
	Optional palette query for.

HRESULT _IFUNC	SetHost (IBContainer *objContainer)

HRESULT _IFUNC	DoQueryInterface (const IID &iid, void **pif)

LPOLESTR _IFUNC	GetName (TOcPartName)

Protected Member Functions inherited from ocf::TUnknown
	TUnknown ()

virtual	~TUnknown ()

IUnknown &	ThisUnknown ()

virtual HRESULT	QueryObject (const GUID &iid, void **pif)
	QueryObject used when TUnknown is in constructor/destructor.

Protected Attributes
owl::TPoint	Origin

owl::TSize	Extent

Protected Attributes inherited from ocf::TUnknown
IUnknown *	Outer

Friends
class	TOcLinkCollection

Detailed Description

Link Viewer object for a server document.

Definition at line 37 of file oclink.h.

Constructor & Destructor Documentation

◆ TOcLinkView()

ocf::TOcLinkView::TOcLinkView	(	TOcView *	ocView,
		owl::TRegList *	regList = 0,
		IUnknown *	outer = 0 )

Definition at line 21 of file oclink.cpp.

References AddRef(), ocf::amDebug, ocf::amExeModule, ocf::TOcApp::BOleComponentCreate(), ocf::cidBOleInProcSite, ocf::cidBOleSite, ocf::IBSite::Init(), ocf::TOcApp::IsOptionSet(), ocf::TOcView::OcApp, OleStr, PRECONDITION, Release(), and ocf::TUnknown::SetOuter().

Member Function Documentation

◆ Activate()

HRESULT _IFUNC ocf::TOcLinkView::Activate ( BOOL )

protectedvirtual

Activate this view.

Implements ocf::IBPart.

Definition at line 324 of file oclink.cpp.

References HR_NOERROR.

◆ AddRef()

owl::ulong _IFUNC ocf::TOcLinkView::AddRef ( )

inline

Definition at line 57 of file oclink.h.

◆ CanOpenInPlace()

HRESULT _IFUNC ocf::TOcLinkView::CanOpenInPlace ( )

protectedvirtual

Query to determine if this view can open in place.

Implements ocf::IBPart.

Definition at line 295 of file oclink.cpp.

References HR_FAIL.

◆ Close()

HRESULT _IFUNC ocf::TOcLinkView::Close ( )

protectedvirtual

Close the remote view window, & if canShutDown is true, try to close the server app too.

Implements ocf::IBPart.

Definition at line 285 of file oclink.cpp.

References ocf::TOcServerHost::EvOcViewBreakLink(), HR_NOERROR, and ocf::TOcView::ServerHost.

◆ CountFormats()

uint _IFUNC ocf::TOcLinkView::CountFormats ( )

protectedvirtual

Implements ocf::IBDataNegotiator.

Definition at line 138 of file oclink.cpp.

References ocf::TOcView::CountFormats().

◆ Detach()

int ocf::TOcLinkView::Detach ( )

Remove this link view from the document.

Definition at line 69 of file oclink.cpp.

References ocf::TOcLinkCollection::Detach(), ocf::TOcDocument::GetViews(), and ocf::TOcView::OcDocument.

◆ Disconnect()

void ocf::TOcLinkView::Disconnect ( )

Disconnect from the client site.

Definition at line 115 of file oclink.cpp.

References ocf::IBSite::Disconnect().

◆ DoQueryInterface()

HRESULT _IFUNC ocf::TOcLinkView::DoQueryInterface	(	const IID &	iid,
		void **	pif )

protectedvirtual

Implements ocf::IBPart.

Definition at line 447 of file oclink.cpp.

References PRECONDITION, and ocf::TOcView::QueryInterface().

◆ DoVerb()

HRESULT _IFUNC ocf::TOcLinkView::DoVerb ( owl::uint )

protectedvirtual

Perform a verb on our document.

Implements ocf::IBPart.

Definition at line 370 of file oclink.cpp.

References HR_FAIL.

◆ DragFeedback()

HRESULT _IFUNC ocf::TOcLinkView::DragFeedback	(	owl::TPoint *	where,
		BOOL	)

protectedvirtual

Let the server provide drag feedback.

Implements ocf::IBPart.

Definition at line 416 of file oclink.cpp.

References ocf::TOcServerHost::EvOcViewDrag(), ocf::HRFailIfZero(), and ocf::TOcView::ServerHost.

◆ Draw()

HRESULT _IFUNC ocf::TOcLinkView::Draw	(	HDC	dc,
		const RECTL *	pos,
		const RECTL *	clip,
		TOcAspect	aspect,
		TOcDraw	bd )

protectedvirtual

Render the view in the DC provided.

Should be a MetaFile Packup all the args & forward message to real view to paint

Implements ocf::IBDataProvider.

Definition at line 202 of file oclink.cpp.

References ocf::drShadingOnly, ocf::TOcServerHost::EvOcViewPaint(), Extent, GetLinkRect(), HR_NOERROR, ocf::HRFailIfZero(), owl::TRect::Normalize(), Origin, PRECONDITION, ocf::TOcView::ServerHost, and owl::TRect::SetEmpty().

◆ EnumVerbs()

HRESULT _IFUNC ocf::TOcLinkView::EnumVerbs ( TOcVerb * )

protectedvirtual

Enumerate the verbs for our document.

Implements ocf::IBPart.

Definition at line 361 of file oclink.cpp.

References HR_FAIL.

◆ FrameResized()

void _IFUNC ocf::TOcLinkView::FrameResized	(	const owl::TRect *	,
		BOOL	)

protectedvirtual

A container window has resized.

Perform any necessary adjustment of our tools.

Implements ocf::IBPart.

Definition at line 408 of file oclink.cpp.

◆ GetFormat()

HRESULT _IFUNC ocf::TOcLinkView::GetFormat	(	owl::uint	index,
		TOcFormatInfo *	fmt )

protectedvirtual

Implements ocf::IBDataNegotiator.

Definition at line 147 of file oclink.cpp.

References ocf::TOcView::GetFormat(), and PRECONDITION.

◆ GetFormatData()

HANDLE _IFUNC ocf::TOcLinkView::GetFormatData ( TOcFormatInfo * fmt )

protectedvirtual

Request native data for pasting into client application.

This is only called at paste time (not at copy time).

Implements ocf::IBDataProvider.

Definition at line 162 of file oclink.cpp.

References ocf::TOcServerHost::EvOcViewClipData(), ocf::TOcFormatList::Find(), ocf::TOcView::FormatList, PRECONDITION, and ocf::TOcView::ServerHost.

◆ GetLinkRect()

void ocf::TOcLinkView::GetLinkRect ( )

Get the initial size and position from the host app into our members.

Definition at line 180 of file oclink.cpp.

References ocf::TOcServerHost::EvOcViewPartSize(), Extent, Origin, and ocf::TOcView::ServerHost.

◆ GetMoniker()

owl::TString & ocf::TOcLinkView::GetMoniker ( )

inline

Definition at line 53 of file oclink.h.

◆ GetName()

LPOLESTR _IFUNC ocf::TOcLinkView::GetName ( TOcPartName )

protectedvirtual

Implements ocf::IBPart.

Definition at line 458 of file oclink.cpp.

◆ GetPalette()

HRESULT _IFUNC ocf::TOcLinkView::GetPalette ( LOGPALETTE ** palette )

protectedvirtual

Optional palette query for.

Implements ocf::IBPart.

Definition at line 427 of file oclink.cpp.

References ocf::TOcServerHost::EvOcViewGetPalette(), ocf::HRFailIfZero(), PRECONDITION, and ocf::TOcView::ServerHost.

◆ GetPartSize()

HRESULT _IFUNC ocf::TOcLinkView::GetPartSize ( owl::TSize * size )

protectedvirtual

Return the 'size' of the document that this view in on.

Implements ocf::IBDataProvider.

Definition at line 238 of file oclink.cpp.

References Extent, and HR_NOERROR.

◆ Init()

HRESULT _IFUNC ocf::TOcLinkView::Init	(	IBSite *	,
		TOcInitInfo *	)

protectedvirtual

Load the associated document and activate the remote view.

Implements ocf::IBPart.

Definition at line 275 of file oclink.cpp.

References HR_NOERROR.

◆ InsertMenus()

HRESULT _IFUNC ocf::TOcLinkView::InsertMenus	(	HMENU	,
		TOcMenuWidths *	)

protectedvirtual

Insert the server's menus into the shared menubar.

Implements ocf::IBPart.

Definition at line 389 of file oclink.cpp.

References HR_NOERROR.

◆ Invalidate()

void ocf::TOcLinkView::Invalidate ( TOcInvalidate invalid )

Invalidate the site corresponding to this view.

Definition at line 105 of file oclink.cpp.

References ocf::IBSite::Invalidate().

◆ Open()

HRESULT _IFUNC ocf::TOcLinkView::Open ( BOOL open )

protectedvirtual

Start or end open editing Work with the window Z-order and parenting.

Implements ocf::IBPart.

Definition at line 343 of file oclink.cpp.

References ocf::TOcView::BringToFront(), ocf::TOcServerHost::EvOcViewAttachWindow(), HR_NOERROR, ocf::TOcView::ServerHost, and TYPESAFE_DOWNCAST.

◆ OpenInPlace()

HWND _IFUNC ocf::TOcLinkView::OpenInPlace ( HWND )

protectedvirtual

Open or close this view as an in-place edit session.

If hWndParent is 0, then in-place is closing

Implements ocf::IBPart.

Definition at line 380 of file oclink.cpp.

◆ QueryInterface()

HRESULT _IFUNC ocf::TOcLinkView::QueryInterface	(	const GUID &	iid,
		void **	iface )

inline

Definition at line 59 of file oclink.h.

◆ QueryObject()

HRESULT ocf::TOcLinkView::QueryObject	(	const IID &	iid,
		void **	iface )

protected

Definition at line 78 of file oclink.cpp.

References PRECONDITION.

◆ Release()

owl::ulong _IFUNC ocf::TOcLinkView::Release ( )

inline

Definition at line 58 of file oclink.h.

◆ Save()

HRESULT _IFUNC ocf::TOcLinkView::Save	(	IStorage *	storage,
		BOOL	sameAsLoad,
		BOOL	remember )

protectedvirtual

Save the document that we are a view on.

Implements ocf::IBDataProvider.

Definition at line 248 of file oclink.cpp.

References ocf::TOcServerHost::EvOcViewSavePart(), ocf::HRFailIfZero(), PRECONDITION, ocf::TOcView::ServerHost, and owl::ToBool().

◆ SetHost()

HRESULT _IFUNC ocf::TOcLinkView::SetHost ( IBContainer * objContainer )

protectedvirtual

Implements ocf::IBPart.

Definition at line 438 of file oclink.cpp.

References HR_FAIL.

◆ SetMoniker()

void ocf::TOcLinkView::SetMoniker ( LPCTSTR name )

Remember the name of the moniker.

Definition at line 125 of file oclink.cpp.

◆ SetPartPos()

HRESULT _IFUNC ocf::TOcLinkView::SetPartPos ( owl::TRect * r )

protectedvirtual

Set a new position for our document within its container.

Implements ocf::IBPart.

Definition at line 304 of file oclink.cpp.

References HR_NOERROR, and Origin.

◆ SetPartSize()

HRESULT _IFUNC ocf::TOcLinkView::SetPartSize ( owl::TSize * size )

protectedvirtual

Implements ocf::IBPart.

Definition at line 314 of file oclink.cpp.

References Extent, and HR_NOERROR.

◆ Show()

HRESULT _IFUNC ocf::TOcLinkView::Show ( BOOL )

protectedvirtual

Show/Hide the server view window.

Implements ocf::IBPart.

Definition at line 333 of file oclink.cpp.

References HR_NOERROR.

◆ ShowTools()

HRESULT _IFUNC ocf::TOcLinkView::ShowTools ( BOOL )

protectedvirtual

Show or hide the tool windows used by our view.

Implements ocf::IBPart.

Definition at line 398 of file oclink.cpp.

References HR_NOERROR.

Friends And Related Symbol Documentation

◆ TOcLinkCollection

friend class TOcLinkCollection

friend

Definition at line 115 of file oclink.h.

Member Data Documentation

◆ Extent

owl::TSize ocf::TOcLinkView::Extent

protected

Definition at line 103 of file oclink.h.

◆ Origin

owl::TPoint ocf::TOcLinkView::Origin

protected

Definition at line 102 of file oclink.h.

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

include/ocf/oclink.h
source/ocf/oclink.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TOcLinkView()

Member Function Documentation

◆ Activate()

◆ AddRef()

◆ CanOpenInPlace()

◆ Close()

◆ CountFormats()

◆ Detach()

◆ Disconnect()

◆ DoQueryInterface()

◆ DoVerb()

◆ DragFeedback()

◆ Draw()

◆ EnumVerbs()

◆ FrameResized()

◆ GetFormat()

◆ GetFormatData()

◆ GetLinkRect()

◆ GetMoniker()

◆ GetName()

◆ GetPalette()

◆ GetPartSize()

◆ Init()

◆ InsertMenus()

◆ Invalidate()

◆ Open()

◆ OpenInPlace()

◆ QueryInterface()

◆ QueryObject()

◆ Release()

◆ Save()

◆ SetHost()

◆ SetMoniker()

◆ SetPartPos()

◆ SetPartSize()

◆ Show()

◆ ShowTools()

Friends And Related Symbol Documentation

◆ TOcLinkCollection

Member Data Documentation

◆ Extent

◆ Origin