SnipRunLog.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef _SnipRunLog_
#define _SnipRunLog_

// Interface includes:

// Forward declarations:
class PMString;
class ITextControlData;
class ICounterControlData;
class IPMStream;

class SnipRunLog
{
 friend class SnipRunPanelWidgetObserver;
protected:
 SnipRunLog(const WidgetID& logPanelWidgetID, const WidgetID& logWidgetID, const WidgetID& scrollBarWidgetID);

public:
 static SnipRunLog* Instance();

 static void DeleteInstance();

 virtual ~SnipRunLog();

 void Log(const PMString& message);

 void Clear();

 void UpdateTextControl();

 void SaveLog(InterfacePtr<IPMStream> stream);

 bool16 GetTrace() const {return fTrace;}

 
 void SetTrace(bool16 traceState) {fTrace = traceState;}
 
 static SnipRunLog* PeekAtSnipRunLog() {return fSnipRunLog;}

 void Resize();

 void ResizeComplete();

private:
 void ScrollToTop();
 void ScrollToBottom();
 // return false if the view cannot be initialised (say the panel is hidden)
 bool16 InitPanelView();
 void DetachPanelView();
 static SnipRunLog* fSnipRunLog;
 InterfacePtr<ITextControlData> fLogTextControlData;
 InterfacePtr<ICounterControlData> fScrollBarCounterData;
 PMString fLog;
 bool16 fTrace;
 WidgetID fLogWidgetID;
 WidgetID fLogPanelWidgetID;
 WidgetID fScrollBarWidgetID;

 bool16 fPanelInit;
 bool16 fResizeInProgress;
 PMString fSavedLog;
};

extern void SNIPLOG(const char* str, ...);

extern void SNIPLOG_ASSERT_FAIL(const char* str, ...);

#endif // _SnipRunLog_