#include <ocview.h>

Inheritance diagram for ocf::TOcView:

Public Member Functions
	TOcView (TOcDocument &doc, TOcContainerHost ch, TOcServerHost sh, owl::TRegList regList=0, IUnknown outer=0)
	TOcView (TOcDocument &doc, owl::TRegList regList=0, IUnknown outer=0)
void	SetupWindow (HWND hWin, bool embedded=false)
virtual void	ReleaseObject ()
TOcDocument &	GetOcDocument ()
IBRootLinkable *	GetLinkable ()
Clipboard support
bool	RegisterClipFormats (owl::TRegList &regList)
bool	BrowseClipboard (TOcInitInfo &initInfo)
bool	PasteNative (TOcInitInfo &init, owl::TPoint *where=0)
bool	Paste (bool linking=false)
void	SetOcData (TOcDataProvider *ocData=0)
TOcDataProvider *	GetOcData ()
View related
owl::TPoint	GetOrigin () const
owl::TRect	GetWindowRect () const
void	ScrollWindow (int dx, int dy)
void	InvalidatePart (TOcPartChangeInfo &changeInfo)
virtual void	Rename ()
TOcLinkView *	GetDocLink (LPCTSTR name=0)
bool	IsOptionSet (owl::uint32 option) const
void	SetOption (owl::uint32 bit, bool state)
Get/Set active part
TOcPart *	GetActivePart ()
void	SetActivePart (TOcPart *part)
bool	ActivatePart (TOcPart *part)
IBDocument pass-thrus
void	EvResize ()
void	EvActivate (bool activate)
virtual void	EvClose ()
virtual bool	EvSetFocus (bool set)
bool	EnumLinks (IBLinkInfo **)
bool	BrowseLinks ()
bool	UpdateLinks ()
Object reference & lifetime managment
For internal OCF use only
owl::ulong _IFUNC	AddRef ()
owl::ulong _IFUNC	Release ()
HRESULT _IFUNC	QueryInterface (const GUID &iid, void **iface)
Protected Member Functions
owl::uint32	ForwardEvent (int eventId, const void *param)
owl::uint32	ForwardEvent (int eventId, owl::uint32 param=0)
void	Shutdown ()
HRESULT	QueryObject (const IID &iid, void **iface)
IBContains implementation for BOle to use
HRESULT _IFUNC	Init (LPCOLESTR)
HRESULT _IFUNC	GetPart (IBPart **, LPCOLESTR)
IBDataNegotiator implementation
owl::uint _IFUNC	CountFormats ()
HRESULT _IFUNC	GetFormat (owl::uint, TOcFormatInfo *)
IBWindow implementation
HWND _IFUNC	GetWindow ()
HRESULT _IFUNC	GetWindowRect (owl::TRect *r)
LPCOLESTR _IFUNC	GetWindowTitle ()
void _IFUNC	AppendWindowTitle (LPCOLESTR title)
HRESULT _IFUNC	SetStatusText (LPCOLESTR text)
HRESULT _IFUNC	RequestBorderSpace (const owl::TRect *)
HRESULT _IFUNC	SetBorderSpace (const owl::TRect *)
HRESULT _IFUNC	InsertContainerMenus (HMENU, TOcMenuWidths *)
HRESULT _IFUNC	SetFrameMenu (HMENU)
void _IFUNC	RestoreUI ()
HRESULT _IFUNC	Accelerator (MSG *)
HRESULT _IFUNC	GetAccelerators (HACCEL , int )
IBDropDest implementation
HRESULT _IFUNC	Drop (TOcInitInfo , owl::TPoint , const owl::TRect *)
void _IFUNC	DragFeedback (owl::TPoint , const owl::TRect , TOcMouseAction, owl::uint, HRESULT &hr)
HRESULT _IFUNC	Scroll (TOcScrollDir scrollDir)
HRESULT _IFUNC	GetScrollRect (owl::TRect *)
IBContainer implementation
HRESULT _IFUNC	FindDropDest (owl::TPoint , IBDropDest *)
HRESULT _IFUNC	AllowInPlace ()
HRESULT _IFUNC	BringToFront ()
Protected Attributes
IUnknown *	BDocument
IBDocument *	BDocumentI
IUnknown *	BContainer
IBRootLinkable *	BLDocumentI
TOcApp &	OcApp
TOcDocument &	OcDocument
TOcContainerHost *	ContainerHost
TOcServerHost *	ServerHost
TOcPart *	ActivePart
owl::uint32	Options
owl::TPoint	Origin
owl::TSize	Extent
owl::tstring	WinTitle
TOcFormatList	FormatList
owl::TString	OrgTitle
int	LinkFormat
owl::TRegList *	RegList
TOcDataProvider *	OcData
Friends
class _ICLASS	TOcControl
class _ICLASS	TOcControlEvent
class _ICLASS	TOcPart
class _ICLASS	TOcDataProvider
class _ICLASS	TOcLinkView

Detailed Description

The TOcView partner is a container (viewer) of a given (server/client) document.

Constructor & Destructor Documentation

ocf::TOcView::TOcView	(	TOcDocument &	doc,
		TOcContainerHost *	ch,
		TOcServerHost *	sh,
		owl::TRegList *	regList = `0`,
		IUnknown *	outer = `0`
	)

New, interface constructor.

References BContainer, BDocument, BDocumentI, BLDocumentI, ocf::TOcApp::BOleComponentCreate(), owl::TRegList::Lookup(), OcApp, OcDocument, and RegisterClipFormats().

ocf::TOcView::TOcView	(	TOcDocument &	doc,
		owl::TRegList *	regList = `0`,
		IUnknown *	outer = `0`
	)

Compatibility constructor.

References BContainer, BDocument, BDocumentI, BLDocumentI, ocf::TOcApp::BOleComponentCreate(), owl::TRegList::Lookup(), OcApp, OcDocument, and RegisterClipFormats().

Member Function Documentation

bool ocf::TOcView::ActivatePart ( TOcPart * part )

Activate a given part.

References ActivePart.

void _IFUNC ocf::TOcView::AppendWindowTitle ( LPCOLESTR title ) [protected, virtual]

Append server's doc title info to our view's window title.

Implements ocf::IBWindow.

References ContainerHost, and owl::TModule::LoadString().

uint _IFUNC ocf::TOcView::CountFormats ( ) [protected, virtual]

Format count.

Implements ocf::IBDataNegotiator.

Reimplemented in ocf::TOcRemView.

void _IFUNC ocf::TOcView::DragFeedback	(	owl::TPoint *	where,
		const owl::TRect *	objPos,
		TOcMouseAction	,
		owl::uint	,
		HRESULT &	hr
	)		`[protected, virtual]`

Provide feedback to the users drag action in our container window.

Implements ocf::IBDropDest.

Reimplemented in ocf::TOcRemView.

References ContainerHost.

HRESULT _IFUNC ocf::TOcView::Drop	(	TOcInitInfo *	initInfo,
		owl::TPoint *	where,
		const owl::TRect *	objPos
	)		`[protected, virtual]`

Drop a part onto this view. Creates the part based on initInfo, activating it as appropriate

Implements ocf::IBDropDest.

References ContainerHost, ocf::TOcDragDrop::InitInfo, OcDocument, and PasteNative().

void ocf::TOcView::EvActivate ( bool activate )

View is activated/deactivated.

References BDocumentI, and OcDocument.

void ocf::TOcView::EvClose ( ) [virtual]

View is shuting down.

Reimplemented in ocf::TOcRemView.

References BContainer, BDocument, BDocumentI, BLDocumentI, ocf::TOcDataProvider::Disconnect(), and OcData.

bool ocf::TOcView::EvSetFocus ( bool set ) [virtual]

Returns true if view keeps focus, false if the inplace server got it.

Reimplemented in ocf::TOcRemView.

References BDocumentI, and OcApp.

HRESULT _IFUNC ocf::TOcView::FindDropDest	(	owl::TPoint *	,
		IBDropDest **	dropDest
	)		`[protected, virtual]`

Locate the drop destination object. For default OC, it is just this view. Other extensions might have subtargets within the view.

Implements ocf::IBContainer.

TOcLinkView * ocf::TOcView::GetDocLink ( LPCTSTR name = 0 )

Obtain a TOcLinkView representing a moniker, the whole document by default.

References ocf::TOcLinkView::GetLinkRect(), OcDocument, ServerHost, and ocf::TOcLinkView::SetMoniker().

HRESULT _IFUNC ocf::TOcView::GetFormat	(	owl::uint	index,
		TOcFormatInfo *	fmt
	)		`[protected, virtual]`

Format retrieval.

Implements ocf::IBDataNegotiator.

Reimplemented in ocf::TOcRemView.

References CountFormats(), and LinkFormat.

TRect ocf::TOcView::GetWindowRect ( ) const

Return the client rect for the view window.

HRESULT _IFUNC ocf::TOcView::Init ( LPCOLESTR path ) [protected, virtual]

Ask the container to load document named 'path'.

Implements ocf::IBContains.

Reimplemented in ocf::TOcRemView.

References ContainerHost, OcDocument, and ocf::TOcDocument::SetName().

bool ocf::TOcView::PasteNative	(	TOcInitInfo &	init,
		owl::TPoint *	where = `0`
	)

Paste native data into the container.

References ServerHost.

HRESULT ocf::TOcView::QueryObject	(	const IID &	iid,
		void **	iface
	)		`[protected]`

Callback from TUnknown's implementation of QueryInterface.

Reimplemented in ocf::TOcxView, and ocf::TOcRemView.

References BContainer, BDocument, and GetDocLink().

bool ocf::TOcView::RegisterClipFormats ( owl::TRegList & regList )

Register the clipboard formats supported.

References OcApp.

void ocf::TOcView::ReleaseObject ( ) [virtual]

Should only be called by the owner/creator of this object. Releases host interfaces and this.

Reimplemented in ocf::TOcRemView.

References ContainerHost, and ServerHost.

HRESULT _IFUNC ocf::TOcView::Scroll ( TOcScrollDir scrollDir ) [protected, virtual]

Ask the container view window to scroll itself in a given direction. Asked by the server when dragging or working in a clipped site.

Implements ocf::IBDropDest.

References ContainerHost.

void ocf::TOcView::ScrollWindow	(	int	dx,
		int	dy
	)

Scroll this container window a give dx,dy.

void ocf::TOcView::Shutdown ( ) [protected]

Called from destructor of this class or of derived class to release helpers and host interfaces

References BContainer, BDocument, ContainerHost, and ServerHost.

Member Data Documentation

TOcPart* ocf::TOcView::ActivePart [protected]

Currently active part, if any.

IUnknown* ocf::TOcView::BContainer [protected]

Container helper object.

IUnknown* ocf::TOcView::BDocument [protected]

Document helper object.

IBDocument* ocf::TOcView::BDocumentI [protected]

Document interface on the document.

IBRootLinkable* ocf::TOcView::BLDocumentI [protected]

RootLinkable interface on the container.

TOcContainerHost* ocf::TOcView::ContainerHost [protected]

The hosting app's container object.

int ocf::TOcView::LinkFormat [protected]

adjustment for format count

TOcApp& ocf::TOcView::OcApp [protected]

Our OC application object.

TOcDataProvider* ocf::TOcView::OcData [protected]

Dataprovider representing this view.

TOcDocument& ocf::TOcView::OcDocument [protected]

Our OC document object.

owl::TString ocf::TOcView::OrgTitle [protected]

Original window title string.

TOcServerHost* ocf::TOcView::ServerHost [protected]

The hosting app's server object.

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

D:/Work/OWLNext/Subversion/branches/632/include/ocf/ocview.h
D:/Work/OWLNext/Subversion/branches/632/source/ocf/ocview.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation