OWLNext    7.0
Borland's Object Windows Library for the modern age
Loading...
Searching...
No Matches
ocf::TOcxView Class Reference

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

#include <ocf/occtrl.h>

Inheritance diagram for ocf::TOcxView:
ocf::TOcView ocf::TUnknown ocf::IBContainer ocf::IBContains ocf::IBDropDest ocf::IBWindow ocf::IBDataConsumer ocf::IBDataNegotiator

Public Member Functions

 TOcxView (TOcDocument &doc, owl::TRegList *regList=0, IUnknown *outer=0)
 TOcxView Class Implementation.
 ~TOcxView ()
HRESULT QueryObject (const IID &iidiid, void **iface)
void SetBackColor (long Color)
void SetForeColor (long Color)
void SetLocaleID (long LocaleId)
void SetMessageReflect (bool MsgRef)
void SetTextAlign (short Align)
void SetUserMode (bool Mode)
void SetUIDead (bool Dead)
void SetShowGrabHandles (bool Handles)
void SetSupportsMnemonics (bool Mnem)
void SetShowHatching (bool Hatch)
void SetDisplayAsDefault (bool Disp)
void SetDisplayName (owl::TString &Name)
void SetScaleUnits (owl::TString &ScaleUnits)
void SetFont (IDispatch *pFontDisp)
Public Member Functions inherited from ocf::TOcView
 TOcView (TOcDocument &doc, TOcContainerHost *ch, TOcServerHost *sh, owl::TRegList *regList=0, IUnknown *outer=0)
 New, interface constructor.
 TOcView (TOcDocument &doc, owl::TRegList *regList=0, IUnknown *outer=0)
 Compatibility constructor.
void SetupWindow (HWND hWin, bool embedded=false)
virtual void ReleaseObject ()
 Should only be called by the owner/creator of this object.
TOcDocument & GetOcDocument ()
IBRootLinkable * GetLinkable ()
bool RegisterClipFormats (owl::TRegList &regList)
 Register the clipboard formats supported.
bool BrowseClipboard (TOcInitInfo &initInfo)
bool PasteNative (TOcInitInfo &init, owl::TPoint *where=0)
 Paste native data into the container.
bool Paste (bool linking=false)
void SetOcData (TOcDataProvider *ocData=0)
TOcDataProvider * GetOcData ()
owl::TPoint GetOrigin () const
owl::TRect GetWindowRect () const
 Return the client rect for the view window.
void ScrollWindow (int dx, int dy)
 Scroll this container window a give dx,dy.
void InvalidatePart (TOcPartChangeInfo &changeInfo)
virtual void Rename ()
TOcLinkView * GetDocLink (LPCTSTR name=0)
 Obtain a TOcLinkView representing a moniker, the whole document by default.
bool IsOptionSet (owl::uint32 option) const
void SetOption (owl::uint32 bit, bool state)
TOcPart * GetActivePart ()
void SetActivePart (TOcPart *part)
bool ActivatePart (TOcPart *part)
 Activate a given part.
void EvResize ()
void EvActivate (bool activate)
 View is activated/deactivated.
virtual void EvClose ()
 View is shuting down.
virtual bool EvSetFocus (bool set)
 Returns true if view keeps focus, false if the inplace server got it.
bool EnumLinks (IBLinkInfo **)
bool BrowseLinks ()
bool UpdateLinks ()
owl::ulong _IFUNC AddRef ()
owl::ulong _IFUNC Release ()
HRESULT _IFUNC QueryInterface (const GUID &iidiid, 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

long GetBackColor ()
long GetForeColor ()
long GetLocaleID ()
bool GetMessageReflect ()
short GetTextAlign ()
bool GetUserMode ()
bool GetUIDead ()
bool GetShowGrabHandles ()
bool GetSupportsMnemonics ()
bool GetShowHatching ()
bool GetDisplayAsDefault ()
owl::TString & GetDisplayName ()
owl::TString & GetScaleUnits ()
IDispatch * GetFont ()
void SetAmbBackColor (long Color)
void SetAmbForeColor (long Color)
void SetAmbLocaleID (long LocaleId)
void SetAmbMessageReflect (bool MsgRef)
void SetAmbTextAlign (short Align)
void SetAmbUserMode (bool Mode)
void SetAmbUIDead (bool Dead)
void SetAmbShowGrabHandles (bool Handles)
void SetAmbSupportsMnemonics (bool Mnem)
void SetAmbShowHatching (bool Hatch)
void SetAmbDisplayAsDefault (bool Disp)
void SetAmbDisplayName (owl::TString &Name)
void SetAmbScaleUnits (owl::TString &ScaleUnits)
void SetAmbFont (IDispatch *pFontDisp)
void AmbientChanged (DISPID dispid)
long GetAmbientValue (long AmbientMsg, long Default)
Protected Member Functions inherited from ocf::TOcView
owl::TResult ForwardEvent (int eventId, const void *param)
owl::TResult ForwardEvent (int eventId, owl::TParam2 param=0)
 ~TOcView ()
void Shutdown ()
 Called from destructor of this class or of derived class to release helpers and host interfaces.
HRESULT QueryObject (const IID &iidiid, void **iface)
 Callback from TUnknown's implementation of QueryInterface.
HRESULT _IFUNC Init (LPCOLESTR)
 Ask the container to load document named 'path'.
HRESULT _IFUNC GetPart (IBPart **, LPCOLESTR)
owl::uint _IFUNC CountFormats ()
 Format count.
HRESULT _IFUNC GetFormat (owl::uint, TOcFormatInfo *)
 Format retrieval.
HWND _IFUNC GetWindow ()
HRESULT _IFUNC GetWindowRect (owl::TRect *r)
LPCOLESTR _IFUNC GetWindowTitle ()
void _IFUNC AppendWindowTitle (LPCOLESTR title)
 Append server's doc title info to our view's window 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 *)
HRESULT _IFUNC Drop (TOcInitInfo *, owl::TPoint *, const owl::TRect *)
 Drop a part onto this view.
void _IFUNC DragFeedback (owl::TPoint *, const owl::TRect *, TOcMouseAction, owl::uint, HRESULT &hr)
 Provide feedback to the users drag action in our container window.
HRESULT _IFUNC Scroll (TOcScrollDir scrollDir)
 Ask the container view window to scroll itself in a given direction.
HRESULT _IFUNC GetScrollRect (owl::TRect *)
HRESULT _IFUNC FindDropDest (owl::TPoint *, IBDropDest **)
 Locate the drop destination object.
HRESULT _IFUNC AllowInPlace ()
HRESULT _IFUNC BringToFront ()
Protected Member Functions inherited from ocf::TUnknown
 TUnknown ()
virtual ~TUnknown ()
IUnknown & ThisUnknown ()
virtual HRESULT QueryObject (const GUID &iidiid, void **pif)
 QueryObject used when TUnknown is in constructor/destructor.

Protected Attributes

TServedObject * pIAmbients
owl::TString * pBlankString
Protected Attributes inherited from ocf::TOcView
IUnknown * BDocument
 Document helper object.
IBDocument * BDocumentI
 Document interface on the document.
IUnknown * BContainer
 Container helper object.
IBRootLinkable * BLDocumentI
 RootLinkable interface on the container.
TOcApp & OcApp
 Our OC application object.
TOcDocument & OcDocument
 Our OC document object.
TOcContainerHost * ContainerHost
 The hosting app's container object.
TOcServerHost * ServerHost
 The hosting app's server object.
TOcPart * ActivePart
 Currently active part, if any.
owl::uint32 Options
owl::TPoint Origin
owl::TSize Extent
owl::tstring WinTitle
TOcFormatList FormatList
owl::TString OrgTitle
 Original window title string.
int LinkFormat
 adjustment for format count
owl::TRegList * RegList
TOcDataProvider * OcData
 Dataprovider representing this view.
Protected Attributes inherited from ocf::TUnknown
IUnknown * Outer

Detailed Description

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

Definition at line 273 of file occtrl.h.

Constructor & Destructor Documentation

◆ TOcxView()

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

TOcxView Class Implementation.

Definition at line 706 of file occtrl.cpp.

References ocf::TOcView::TOcView(), ocf::TServedObject::AddRef(), ocf::TAppDescriptor::CreateAutoObject(), ocf::GetAppDescriptor(), ocf::TOcApp::GetRegistrar(), ocf::TOcView::OcApp, pBlankString, and pIAmbients.

◆ ~TOcxView()

ocf::TOcxView::~TOcxView ( )

Definition at line 729 of file occtrl.cpp.

References pBlankString, pIAmbients, and ocf::TServedObject::Release().

Member Function Documentation

◆ AmbientChanged()

void ocf::TOcxView::AmbientChanged ( DISPID dispid)
protected

Definition at line 1039 of file occtrl.cpp.

References ocf::IBControl::AmbientChanged(), ocf::TOcDocument::GetParts(), ocf::TOcView::OcDocument, ocf::TOcPart::QueryInterface(), and ocf::TOcView::TOcPart.

◆ GetAmbientValue()

long ocf::TOcxView::GetAmbientValue ( long AmbientMsg,
long Default )
protected

Definition at line 1064 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent().

◆ GetBackColor()

long ocf::TOcxView::GetBackColor ( )
protected

Definition at line 935 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETBACKCOLOR.

◆ GetDisplayAsDefault()

bool ocf::TOcxView::GetDisplayAsDefault ( )
protected

Definition at line 998 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETDISPLAYASDEFAULT.

◆ GetDisplayName()

TString & ocf::TOcxView::GetDisplayName ( )
protected

Definition at line 1012 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), OC_AMBIENT_GETDISPLAYNAME, and pBlankString.

◆ GetFont()

IDispatch * ocf::TOcxView::GetFont ( )
protected

Definition at line 1028 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_GETFONT.

◆ GetForeColor()

long ocf::TOcxView::GetForeColor ( )
protected

Definition at line 942 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETFORECOLOR.

◆ GetLocaleID()

long ocf::TOcxView::GetLocaleID ( )
protected

Definition at line 949 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETLOCALEID.

◆ GetMessageReflect()

bool ocf::TOcxView::GetMessageReflect ( )
protected

Definition at line 956 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETMESSAGEREFLECT.

◆ GetScaleUnits()

TString & ocf::TOcxView::GetScaleUnits ( )
protected

Definition at line 1020 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), OC_AMBIENT_GETSCALEUNITS, and pBlankString.

◆ GetShowGrabHandles()

bool ocf::TOcxView::GetShowGrabHandles ( )
protected

Definition at line 984 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETSHOWGRABHANDLES.

◆ GetShowHatching()

bool ocf::TOcxView::GetShowHatching ( )
protected

Definition at line 991 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETSHOWHATCHING.

◆ GetSupportsMnemonics()

bool ocf::TOcxView::GetSupportsMnemonics ( )
protected

Definition at line 1005 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETSUPPORTSMNEMONICS.

◆ GetTextAlign()

short ocf::TOcxView::GetTextAlign ( )
protected

Definition at line 963 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETTEXTALIGN.

◆ GetUIDead()

bool ocf::TOcxView::GetUIDead ( )
protected

Definition at line 977 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETUIDEAD.

◆ GetUserMode()

bool ocf::TOcxView::GetUserMode ( )
protected

Definition at line 970 of file occtrl.cpp.

References GetAmbientValue(), and OC_AMBIENT_GETUSERMODE.

◆ QueryObject()

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

Definition at line 740 of file occtrl.cpp.

References ocf::HRSucceeded(), pIAmbients, PRECONDITION, ocf::TOcView::QueryObject(), and ocf::TServedObject::QueryObject().

◆ SetAmbBackColor()

void ocf::TOcxView::SetAmbBackColor ( long Color)
protected

Definition at line 851 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETBACKCOLOR.

◆ SetAmbDisplayAsDefault()

void ocf::TOcxView::SetAmbDisplayAsDefault ( bool Disp)
protected

Definition at line 911 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETDISPLAYASDEFAULT.

◆ SetAmbDisplayName()

void ocf::TOcxView::SetAmbDisplayName ( owl::TString & Name)
protected

Definition at line 917 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETDISPLAYNAME.

◆ SetAmbFont()

void ocf::TOcxView::SetAmbFont ( IDispatch * pFontDisp)
protected

Definition at line 929 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETFONT.

◆ SetAmbForeColor()

void ocf::TOcxView::SetAmbForeColor ( long Color)
protected

Definition at line 857 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETFORECOLOR.

◆ SetAmbLocaleID()

void ocf::TOcxView::SetAmbLocaleID ( long LocaleId)
protected

Definition at line 863 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETLOCALEID.

◆ SetAmbMessageReflect()

void ocf::TOcxView::SetAmbMessageReflect ( bool MsgRef)
protected

Definition at line 869 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETMESSAGEREFLECT.

◆ SetAmbScaleUnits()

void ocf::TOcxView::SetAmbScaleUnits ( owl::TString & ScaleUnits)
protected

Definition at line 923 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETSCALEUNITS.

◆ SetAmbShowGrabHandles()

void ocf::TOcxView::SetAmbShowGrabHandles ( bool Handles)
protected

Definition at line 893 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETSHOWGRABHANDLES.

◆ SetAmbShowHatching()

void ocf::TOcxView::SetAmbShowHatching ( bool Hatch)
protected

Definition at line 905 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETSHOWHATCHING.

◆ SetAmbSupportsMnemonics()

void ocf::TOcxView::SetAmbSupportsMnemonics ( bool Mnem)
protected

Definition at line 899 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETSUPPORTSMNEMONICS.

◆ SetAmbTextAlign()

void ocf::TOcxView::SetAmbTextAlign ( short Align)
protected

Definition at line 875 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETTEXTALIGN.

◆ SetAmbUIDead()

void ocf::TOcxView::SetAmbUIDead ( bool Dead)
protected

Definition at line 887 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETUIDEAD.

◆ SetAmbUserMode()

void ocf::TOcxView::SetAmbUserMode ( bool Mode)
protected

Definition at line 881 of file occtrl.cpp.

References ocf::TOcView::ForwardEvent(), and OC_AMBIENT_SETUSERMODE.

◆ SetBackColor()

void ocf::TOcxView::SetBackColor ( long Color)

Definition at line 764 of file occtrl.cpp.

References AmbientChanged().

◆ SetDisplayAsDefault()

void ocf::TOcxView::SetDisplayAsDefault ( bool Disp)

Definition at line 824 of file occtrl.cpp.

References AmbientChanged().

◆ SetDisplayName()

void ocf::TOcxView::SetDisplayName ( owl::TString & Name)

Definition at line 830 of file occtrl.cpp.

References AmbientChanged().

◆ SetFont()

void ocf::TOcxView::SetFont ( IDispatch * pFontDisp)

Definition at line 844 of file occtrl.cpp.

References AmbientChanged().

◆ SetForeColor()

void ocf::TOcxView::SetForeColor ( long Color)

Definition at line 770 of file occtrl.cpp.

References AmbientChanged().

◆ SetLocaleID()

void ocf::TOcxView::SetLocaleID ( long LocaleId)

Definition at line 776 of file occtrl.cpp.

References AmbientChanged().

◆ SetMessageReflect()

void ocf::TOcxView::SetMessageReflect ( bool MsgRef)

Definition at line 782 of file occtrl.cpp.

References AmbientChanged().

◆ SetScaleUnits()

void ocf::TOcxView::SetScaleUnits ( owl::TString & ScaleUnits)

Definition at line 837 of file occtrl.cpp.

References AmbientChanged().

◆ SetShowGrabHandles()

void ocf::TOcxView::SetShowGrabHandles ( bool Handles)

Definition at line 806 of file occtrl.cpp.

References AmbientChanged().

◆ SetShowHatching()

void ocf::TOcxView::SetShowHatching ( bool Hatch)

Definition at line 818 of file occtrl.cpp.

References AmbientChanged().

◆ SetSupportsMnemonics()

void ocf::TOcxView::SetSupportsMnemonics ( bool Mnem)

Definition at line 812 of file occtrl.cpp.

References AmbientChanged().

◆ SetTextAlign()

void ocf::TOcxView::SetTextAlign ( short Align)

Definition at line 788 of file occtrl.cpp.

References AmbientChanged().

◆ SetUIDead()

void ocf::TOcxView::SetUIDead ( bool Dead)

Definition at line 800 of file occtrl.cpp.

References AmbientChanged().

◆ SetUserMode()

void ocf::TOcxView::SetUserMode ( bool Mode)

Definition at line 794 of file occtrl.cpp.

References AmbientChanged().

Member Data Documentation

◆ pBlankString

owl::TString* ocf::TOcxView::pBlankString
protected

Definition at line 333 of file occtrl.h.

◆ pIAmbients

TServedObject* ocf::TOcxView::pIAmbients
protected

Definition at line 332 of file occtrl.h.

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