RalphDocument Class Reference

The RalphDocument COM object. More...

#include <ralphdoc.h>

List of all members.

Public Member Functions

virtual void OnFinalRelease ()
BOOL IsInRalphMethod ()
BOOL PassErrorToHarness (HRESULT ErrCode)
void WebAddressSelected (String_256 *InAddress)
BOOL SelectViewQuality (INT32 ViewQuality)
BOOL SelectViewMode (ViewMode Viewmode)
BOOL SelectDitherType (DitherType Dither)
BOOL SelectPaletteMode (BOOL Foreground)
void SetSelected ()
void SetStatusBar (String_256 *pNewText)
void SetStatusBar (wxString pNewText)
void SetStatusBar ()
BOOL PrintRalphView (wxDC *TheDC, DWORD X, DWORD Y, DWORD Width, DWORD Height, DWORD DPI)
BOOL CleanUpAfterAsynchDownLoad (BOOL ok)
void SetViewportRect (DocRect &Viewport)
DocRectGetViewportRect ()
RalphView * GetRalphView ()
DocumentGetRalphDocument ()
String_256 GetDocumentURL ()
String_256 GetBaseURL ()
void MakepRalphViewNULL ()

Static Public Member Functions

static BOOL SelectTool (ToolMode toolmode)
static DocumentGetImportingDoc ()
static DWORD GetImportingThreadID ()
static void OnRalphAboutToDie ()
static void SetRenderTimer (BOOL State)

Public Attributes

DitherType Dither
ToolMode Toolmode
QualityLevel Quality
ViewMode Viewmode
wxString PathString
CCAsynchDiskFileTempWriteAsynchFile
CCAsynchDiskFileTempReadAsynchFile
wxThread * pLoadThread
BOOL IsImportOK
BOOL LoadErrorHasOccured

Static Public Attributes

static Documentsm_pImportingDoc
static DWORD sm_ImportThreadID
static wxCondition * g_hAbortDownLoadEvent
static wxCondition * g_hSafeToEnterLoad
static wxCondition * WakeEvents [2]
static wxWindow * pTimerWnd
static BOOL InsideRenderLoop
static BOOL ForegroundPalette
static void * RestoreStackLimit

Protected Member Functions

 RalphDocument ()
virtual ~RalphDocument ()

Protected Attributes

LoadContext TheLoadContext
wxString CurrentStatusText
wxString DocumentURL
STDMETHOD( CreateViewWindow )(HWND ParentWnd, ViewMode Viewmode, BOOL ShowScrollers, BOOL ShowWindow, BOOL HasBorder, HWND *ViewWindow)
STDMETHOD( LoadDocument )(TCHAR *pFileToLoad)
STDMETHOD( GetVerNum )(TCHAR *pVerNum)
STDMETHOD( RenderToDC )(HDC TheDC, DWORD X, DWORD Y, DWORD Width, DWORD Height, DWORD DPI)
STDMETHOD( SetToolMode )(ToolMode toolMode)
STDMETHOD( PreviousZoom )()
STDMETHOD( ZoomToDrawing )()
STDMETHOD( ZoomToFullScale )()
STDMETHOD( SetQuality )(QualityLevel Quality)
STDMETHOD( SetDitherType )(DitherType Dither)
STDMETHOD( SetPaletteMode )(BOOL Foreground)
STDMETHOD( HasPreviousZoom )()
STDMETHOD( SetURL )(wxString InURL)
STDMETHOD( ShowScrollers )(BOOL State)
STDMETHOD( SetViewMode )(ViewMode Viewmode)
STDMETHOD( SetErrorCallback )(IErrorCallback *pCallbackInterface)
STDMETHOD( SetEventCallback )(IEventCallback *pCallbackInterface)
STDMETHOD( StartAsynchDownLoad )()
STDMETHOD( OnDataAvailable )(unsigned char *pReadBuffer, DWORD BytesRead)
STDMETHOD( EndAsynchDownLoad )(HRESULT Status)

Static Protected Attributes

static BOOL RenderTimerOn

Private Member Functions

BOOL ZoomToFullScale ()
BOOL SaveZoomAndScroll ()
BOOL RestoreZoomAndScroll ()
BOOL SetDocumentViewMode ()
BOOL StartLoadThread ()
BOOL EndAsynchDownLoad (HRESULT Status)
BOOL OnDataAvailable (unsigned char *pReadBuffer, DWORD BytesRead)

Private Attributes

DocRect ViewportRect
DocumentpDocument
RalphView * pRalphView
wxWindow * hParentWnd
BOOL DocumentViewInit
INT32 LastZoomIndex
FIXED16 LastViewScale
WorkCoord LastScrollOffset
IErrorCallbackpIErrorCallback
IEventCallbackpIEventCallback
BOOL InsideRalphMethod
wxCursor * hOldCurs

Static Private Attributes

static INT32 RalphDocCnt


Detailed Description

The RalphDocument COM object.

class RalphDocument: public CCmdTarget

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/6/96

Definition at line 232 of file ralphdoc.h.


Constructor & Destructor Documentation

RalphDocument::RalphDocument  )  [protected]
 

virtual RalphDocument::~RalphDocument  )  [protected, virtual]
 


Member Function Documentation

BOOL RalphDocument::CleanUpAfterAsynchDownLoad BOOL  ok  ) 
 

BOOL RalphDocument::EndAsynchDownLoad HRESULT  Status  )  [private]
 

String_256 RalphDocument::GetBaseURL  ) 
 

String_256 RalphDocument::GetDocumentURL  ) 
 

static Document* RalphDocument::GetImportingDoc  )  [inline, static]
 

Definition at line 299 of file ralphdoc.h.

00299                                       {
00300         //if(sm_pImportingDoc != NULL)
00301             //TRACEUSER( "Richard", _T("### GetImportingDoc() returning NON-NULL doc\n"));
00302         return sm_pImportingDoc; };

static DWORD RalphDocument::GetImportingThreadID  )  [inline, static]
 

Definition at line 303 of file ralphdoc.h.

00303                                         {
00304         //if(sm_ImportThreadID != NULL)
00305             //TRACEUSER( "Richard", _T("### GetImportingThreadID() returning NON-NULL ID\n"));
00306         return sm_ImportThreadID;};

Document* RalphDocument::GetRalphDocument  )  [inline]
 

Definition at line 292 of file ralphdoc.h.

00292 {return pDocument;};

RalphView* RalphDocument::GetRalphView  )  [inline]
 

Definition at line 290 of file ralphdoc.h.

00290 { return pRalphView; };

DocRect* RalphDocument::GetViewportRect  )  [inline]
 

Definition at line 288 of file ralphdoc.h.

00288 { return &ViewportRect; };

BOOL RalphDocument::IsInRalphMethod  )  [inline]
 

Definition at line 244 of file ralphdoc.h.

00244 { return InsideRalphMethod;};

void RalphDocument::MakepRalphViewNULL  )  [inline]
 

Definition at line 436 of file ralphdoc.h.

00436 {pRalphView = NULL;};

BOOL RalphDocument::OnDataAvailable unsigned char *  pReadBuffer,
DWORD  BytesRead
[private]
 

virtual void RalphDocument::OnFinalRelease  )  [virtual]
 

static void RalphDocument::OnRalphAboutToDie  )  [static]
 

BOOL RalphDocument::PassErrorToHarness HRESULT  ErrCode  ) 
 

BOOL RalphDocument::PrintRalphView wxDC *  TheDC,
DWORD  X,
DWORD  Y,
DWORD  Width,
DWORD  Height,
DWORD  DPI
 

BOOL RalphDocument::RestoreZoomAndScroll  )  [private]
 

BOOL RalphDocument::SaveZoomAndScroll  )  [private]
 

BOOL RalphDocument::SelectDitherType DitherType  Dither  ) 
 

BOOL RalphDocument::SelectPaletteMode BOOL  Foreground  ) 
 

static BOOL RalphDocument::SelectTool ToolMode  toolmode  )  [static]
 

BOOL RalphDocument::SelectViewMode ViewMode  Viewmode  ) 
 

BOOL RalphDocument::SelectViewQuality INT32  ViewQuality  ) 
 

BOOL RalphDocument::SetDocumentViewMode  )  [private]
 

static void RalphDocument::SetRenderTimer BOOL  State  )  [static]
 

void RalphDocument::SetSelected  ) 
 

void RalphDocument::SetStatusBar  ) 
 

void RalphDocument::SetStatusBar wxString  pNewText  ) 
 

void RalphDocument::SetStatusBar String_256 pNewText  ) 
 

void RalphDocument::SetViewportRect DocRect Viewport  )  [inline]
 

Definition at line 287 of file ralphdoc.h.

00287 { ViewportRect = Viewport; };

BOOL RalphDocument::StartLoadThread  )  [private]
 

void RalphDocument::WebAddressSelected String_256 InAddress  ) 
 

BOOL RalphDocument::ZoomToFullScale  )  [private]
 


Member Data Documentation

STDMETHOD( RalphDocument::CreateViewWindow)(HWND ParentWnd, ViewMode Viewmode, BOOL ShowScrollers, BOOL ShowWindow, BOOL HasBorder, HWND *ViewWindow) [protected]
 

wxString RalphDocument::CurrentStatusText [protected]
 

Definition at line 338 of file ralphdoc.h.

DitherType RalphDocument::Dither
 

Definition at line 266 of file ralphdoc.h.

wxString RalphDocument::DocumentURL [protected]
 

Definition at line 339 of file ralphdoc.h.

BOOL RalphDocument::DocumentViewInit [private]
 

Definition at line 398 of file ralphdoc.h.

STDMETHOD( RalphDocument::EndAsynchDownLoad)(HRESULT Status) [protected]
 

BOOL RalphDocument::ForegroundPalette [static]
 

Definition at line 430 of file ralphdoc.h.

wxCondition* RalphDocument::g_hAbortDownLoadEvent [static]
 

Definition at line 313 of file ralphdoc.h.

wxCondition* RalphDocument::g_hSafeToEnterLoad [static]
 

Definition at line 316 of file ralphdoc.h.

STDMETHOD( RalphDocument::GetVerNum)(TCHAR *pVerNum) [protected]
 

STDMETHOD( RalphDocument::HasPreviousZoom)() [protected]
 

wxCursor* RalphDocument::hOldCurs [private]
 

Definition at line 424 of file ralphdoc.h.

wxWindow* RalphDocument::hParentWnd [private]
 

Definition at line 397 of file ralphdoc.h.

BOOL RalphDocument::InsideRalphMethod [private]
 

Definition at line 414 of file ralphdoc.h.

BOOL RalphDocument::InsideRenderLoop [static]
 

Definition at line 326 of file ralphdoc.h.

BOOL RalphDocument::IsImportOK
 

Definition at line 279 of file ralphdoc.h.

WorkCoord RalphDocument::LastScrollOffset [private]
 

Definition at line 407 of file ralphdoc.h.

FIXED16 RalphDocument::LastViewScale [private]
 

Definition at line 406 of file ralphdoc.h.

INT32 RalphDocument::LastZoomIndex [private]
 

Definition at line 405 of file ralphdoc.h.

STDMETHOD( RalphDocument::LoadDocument)(TCHAR *pFileToLoad) [protected]
 

BOOL RalphDocument::LoadErrorHasOccured
 

Definition at line 280 of file ralphdoc.h.

STDMETHOD( RalphDocument::OnDataAvailable)(unsigned char *pReadBuffer, DWORD BytesRead) [protected]
 

wxString RalphDocument::PathString
 

Definition at line 273 of file ralphdoc.h.

Document* RalphDocument::pDocument [private]
 

Definition at line 394 of file ralphdoc.h.

IErrorCallback* RalphDocument::pIErrorCallback [private]
 

Definition at line 408 of file ralphdoc.h.

IEventCallback* RalphDocument::pIEventCallback [private]
 

Definition at line 409 of file ralphdoc.h.

wxThread* RalphDocument::pLoadThread
 

Definition at line 278 of file ralphdoc.h.

RalphView* RalphDocument::pRalphView [private]
 

Definition at line 396 of file ralphdoc.h.

STDMETHOD( RalphDocument::PreviousZoom)() [protected]
 

wxWindow* RalphDocument::pTimerWnd [static]
 

Definition at line 323 of file ralphdoc.h.

QualityLevel RalphDocument::Quality
 

Definition at line 268 of file ralphdoc.h.

INT32 RalphDocument::RalphDocCnt [static, private]
 

Definition at line 422 of file ralphdoc.h.

BOOL RalphDocument::RenderTimerOn [static, protected]
 

Definition at line 331 of file ralphdoc.h.

STDMETHOD( RalphDocument::RenderToDC)(HDC TheDC, DWORD X, DWORD Y, DWORD Width, DWORD Height, DWORD DPI) [protected]
 

void* RalphDocument::RestoreStackLimit [static]
 

Definition at line 432 of file ralphdoc.h.

STDMETHOD( RalphDocument::SetDitherType)(DitherType Dither) [protected]
 

STDMETHOD( RalphDocument::SetErrorCallback)(IErrorCallback *pCallbackInterface) [protected]
 

STDMETHOD( RalphDocument::SetEventCallback)(IEventCallback *pCallbackInterface) [protected]
 

STDMETHOD( RalphDocument::SetPaletteMode)(BOOL Foreground) [protected]
 

STDMETHOD( RalphDocument::SetQuality)(QualityLevel Quality) [protected]
 

STDMETHOD( RalphDocument::SetToolMode)(ToolMode toolMode) [protected]
 

STDMETHOD( RalphDocument::SetURL)(wxString InURL) [protected]
 

STDMETHOD( RalphDocument::SetViewMode)(ViewMode Viewmode) [protected]
 

STDMETHOD( RalphDocument::ShowScrollers)(BOOL State) [protected]
 

DWORD RalphDocument::sm_ImportThreadID [static]
 

Definition at line 310 of file ralphdoc.h.

Document* RalphDocument::sm_pImportingDoc [static]
 

Definition at line 306 of file ralphdoc.h.

STDMETHOD( RalphDocument::StartAsynchDownLoad)() [protected]
 

CCAsynchDiskFile* RalphDocument::TempReadAsynchFile
 

Definition at line 276 of file ralphdoc.h.

CCAsynchDiskFile* RalphDocument::TempWriteAsynchFile
 

Definition at line 275 of file ralphdoc.h.

LoadContext RalphDocument::TheLoadContext [protected]
 

Definition at line 336 of file ralphdoc.h.

ToolMode RalphDocument::Toolmode
 

Definition at line 267 of file ralphdoc.h.

ViewMode RalphDocument::Viewmode
 

Definition at line 269 of file ralphdoc.h.

DocRect RalphDocument::ViewportRect [private]
 

Definition at line 284 of file ralphdoc.h.

wxCondition* RalphDocument::WakeEvents[2] [static]
 

Definition at line 319 of file ralphdoc.h.

STDMETHOD( RalphDocument::ZoomToDrawing)() [protected]
 

STDMETHOD( RalphDocument::ZoomToFullScale)() [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Nov 10 04:00:17 2007 for Camelot by  doxygen 1.4.4