OpBrowserPreview Class Reference

Performs an operation to preview the animation in a browser. More...

#include <frameops.h>

Inheritance diagram for OpBrowserPreview:

List of all members.

Static Public Member Functions
static BOOL	RemoveTempFile ()
	For finding the OpBrowserPreview's state. For cleaning up any temp file useage that we may have made. This should be called in the DeInit during program shut down.
Protected Member Functions
virtual BOOL	GetFileNameFromUser ()
	Gives the operation chance to get the filename from the user. In this version we need to override the OpSaveAnimation's version so that we do nothing.
virtual BOOL	SaveOrShowTheAnimation (PreviewDialog *pPreviewDialog, BitmapExportParam *pExportParam)
	Tries to actually do the preview operation required. In this case we just save the animation out to a temporary file and then fire up the browser with an html wrapper which references that file.
Private Member Functions
	CC_DECLARE_DYNCREATE (OpBrowserPreview)
Static Private Attributes
static PathName	m_TempPath

---

Detailed Description

Performs an operation to preview the animation in a browser.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>

Date:

29/4/97

See also:

-

Definition at line 680 of file frameops.h.

---

Member Function Documentation

OpBrowserPreview::CC_DECLARE_DYNCREATE (  OpBrowserPreview   )  [private]

BOOL OpBrowserPreview::GetFileNameFromUser (   )  [protected, virtual]

Gives the operation chance to get the filename from the user. In this version we need to override the OpSaveAnimation's version so that we do nothing. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/97 Returns: True if worked ok, False otherwise Reimplemented from OpSaveAnimatedGIF. Definition at line 4785 of file frameops.cpp. { // This version, do nothing return TRUE; }

BOOL OpBrowserPreview::RemoveTempFile (   )  [static]

For finding the OpBrowserPreview's state. For cleaning up any temp file useage that we may have made. This should be called in the DeInit during program shut down. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/7/97 Returns: True if worked correctly, False otherwise. Definition at line 5021 of file frameops.cpp. { // If we have used the m_TempPath during this session then ensure that we have cleaned up // any temp files String_256 Filename; Filename = m_TempPath.GetPath(); if (!Filename.IsEmpty() && m_TempPath.IsValid()) { FileUtil::DeleteFile(&m_TempPath); } return TRUE; }

BOOL OpBrowserPreview::SaveOrShowTheAnimation (  PreviewDialog *  pPreviewDialog, BitmapExportParam *  pExportParam )  [protected, virtual]

Tries to actually do the preview operation required. In this case we just save the animation out to a temporary file and then fire up the browser with an html wrapper which references that file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 4/8/97 Parameters: pPreviewDialog  the preview dialog box, if open [INPUTS] pExportParam the export param which we will use Returns: True if worked ok, False otherwise ------------------------------------ Reimplemented from OpSaveAnimatedGIF. Definition at line 4806 of file frameops.cpp. { // A bit of checking on parameters if (pExportParam != NULL) { ERROR3IF(!pExportParam->IS_KIND_OF(BitmapExportParam), "OpParam passed is not a BitmapExportParam"); if (pExportParam->GetBitmapCount() == 0) { ERROR2RAW("OpSaveAnimatedGIF::DoWithParam no bitmaps to export"); return FALSE; } } else { ERROR2RAW("OpSaveAnimatedGIF::DoWithParam bad params!"); return FALSE; } // Go and preview it in a browser. // Get our saving filter if (m_pBitmapFilter == NULL) m_pBitmapFilter = new GrabFrameFilter(); if (m_pBitmapFilter == NULL) { InformError(_R(IDT_CANT_FIND_FILTER)); return FALSE; } // create a disk file CCDiskFile TempDiskFile(1024, FALSE, TRUE); // Ensure that if we have been using a previous temp file then // it is cleaned up RemoveTempFile(); // Create the required unique temporary of the correct filetype String_32 ExtStr(_R(IDN_FILTEREXT_GIF)); ExtStr.toLower(); if (!FileUtil::GetTemporaryPathName(ExtStr, &m_TempPath)) return FALSE; // Ensure that we have the correct extension on the filename we have allocated EnsureFileType(&m_TempPath); // First off, we have to try and open the file CCDiskFile DiskFile(1024, FALSE, TRUE); BOOL ExportedOk = TRUE; try { // Export bitmaps supressing the filename so that the user does not see the temp filename ExportedOk = m_pBitmapFilter->DoExportBitmaps(this, &TempDiskFile, &m_TempPath, &m_ExportParams, TRUE); if (!ExportedOk) { // Something went a bit wrong - tell the user what it was. // Supress the error if it was the 'user has cancelled one' if (Error::GetErrorNumber() != _R(IDN_USER_CANCELLED)) { InformError(); m_pBitmapFilter->DeleteExportFile(&DiskFile); } else { // otherwise remove the error so it won't get reported Error::ClearError(); } } // close the file if (DiskFile.isOpen()) DiskFile.close(); } // See if there was a file io error catch(CFileException) { // Report the error if no one else did if (Error::GetErrorNumber() != _R(IDN_USER_CANCELLED)) { InformError(); } else Error::ClearError(); // otherwise remove the error so it won't get reported // Make sure that the file is closed and deleted try { // First try and delete it (tries to close it first) if (m_pBitmapFilter) m_pBitmapFilter->DeleteExportFile(&DiskFile); // Double check to make sure it is closed. if (DiskFile.isOpen()) DiskFile.close(); } catch(CFileException) { // Failed to close the file - not much we can do about it really } // Fail ExportedOk = FALSE; } // Now we have the file, we can go and preview it in the browser // Allocate our preview class, must keep it around as destruction causes // it to clean up the temp files, which is bad if this is before it has // had a chance to fire up the browser! if (m_pBitmapData == NULL) { m_pBitmapData = new BitmapPreviewData; if (m_pBitmapData == NULL) return FALSE; } // Now a static pointer as otherwise the temp file is deleted too quickly MakeBitmapExportOptions * pBmpOptions = NULL; // Recover the options from the filter that it saved during the preparation of the bitmaps // They are helpfully vaped by now! So, we took a copy during GetExportOptions // But if all the frame are already captured then we will not have any options pBmpOptions = m_pBitmapFilter->GetCurrentExportOptionsCopy(); BOOL MadeBitmapOptions = FALSE; if (pBmpOptions == NULL) { // Get the filter to set up the bitmap options for us (Use out public version of CreateExportOptions) pBmpOptions = m_pBitmapFilter->MakeExportOptions(); // Use our public interface onto the GetExportOptions protected function if (pBmpOptions != NULL) { MadeBitmapOptions = TRUE; m_pBitmapFilter->SetupExportOptions(pBmpOptions, m_pSpread); } } ERROR2IF(pBmpOptions == NULL,FALSE,"OpBrowserPreview::PreviewAnimation No current bitmap options"); // Get the first bitmap in the list, this will give us the size of the animation KernelBitmap* pTheBitmap = pExportParam->GetBitmap(0); // Get the filesize that we have exported UINT32 FileSize = TempDiskFile.Size(); // tell the options about the temp file that we are using pBmpOptions->SetPathName(&m_TempPath); // This is our copy of the BitmapExportParam m_pBitmapData->SetNewBitmap(pTheBitmap, FileSize, pBmpOptions); // Set up the options that we require /* BrowserBackground Bgr = BROWSER_BGR_DOC; //BROWSER_BGR_CHECKER; BOOL ShowInfo = TRUE; BOOL GenerateImagemap = FALSE; */ // Get the values from our global variables. BrowserBackground Bgr = PreviewInBrowserTab::g_Background; BOOL ShowInfo = PreviewInBrowserTab::g_InfoInHtmlStub; BOOL GenerateImagemap = FALSE; BrowserPreviewOptions PreviewOptions(Bgr, ShowInfo, GenerateImagemap); //BrowserPreviewOptions PreviewOptions(PreviewInBrowserTab::GetBrowserOptions()); // tell it what spread to use when getting the document background PreviewOptions.SetSpread(m_pSpread); // This should actually preview it in the browser m_pBitmapData->GenerateHTMLStub(PreviewOptions); // Clean out the filter we created delete m_pBitmapFilter; m_pBitmapFilter = NULL; if (MadeBitmapOptions && pBmpOptions != NULL) delete pBmpOptions; return ExportedOk; }

---

Member Data Documentation

PathName OpBrowserPreview::m_TempPath [static, private]

end of OpSaveAnimatedGIF Definition at line 695 of file frameops.h.

---

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

• Kernel/frameops.h (r1785/r1282)
• Kernel/frameops.cpp (r1785/r1282)

---