PreviewDialog Class Reference

#include <prevwdlg.h>

Inheritance diagram for PreviewDialog:

List of all members.

Public Member Functions
	PreviewDialog ()
	Constructs a Preview Dialog.
	~PreviewDialog ()
	Destructor.
virtual void	DoWithParam (OpDescriptor *pOpDesc, OpParam *pParam)
	Creates and shows a Preview dialog.
virtual MsgResult	Message (Msg *Message)
	Handles all the Preview dialog's messages.
virtual BOOL	OnIdleEvent (void)
	Used to detect when the mouse has stopped moving Therefore allows us to implement bubble help for the Preview Dialog.
void	UpdateBubbleHelp (void)
	Called for Idle events to provide bubble help for the Preview Dialog.
BOOL	SetBitmapList (BitmapExportParam *pParam, BOOL SetSlider=TRUE)
	If we need to regenerate our bitmaps while the Preview dialog is open, this function allows us to update our list.
BOOL	SetRegeneratedBitmapInList (GIFAnimationExportParam *pParam)
	If we need to regenerate a SINGLE bitmap while the Preview dialog is open, this function allows us to update our Bitmap list.
BOOL	SetBitmapToListTail (GIFAnimationExportParam *pParam)
	If we need to (re)generate asingle bitmap while the Preview dialog is open, this function allows us to add the Bitmap to the Tail of the list.
BOOL	GetPlayAnimation ()
void	SetPlayAnimation (BOOL Value)
INT32	GetBitmapListSize ()
void	SetDlgState (BOOL State)
BOOL	GetDlgState ()
void	SetDocumentAboutToDie (BOOL Val)
void	SetGeneratedFrameLayers (BOOL Val)
BOOL	GetGeneratedFrameLayers ()
void	SetCurrentItem (INT32 Num)
INT32	GetCurrentItem ()
INT32	GetSliderPosition ()
void	SetSliderPosition (INT32 Position)
	Set the slider to its correct position.
void	SelectCurrentBitmap (UINT32 Position)
	Moves the current item to where the slider has been positioned.
void	RestartTimer ()
	If for some reason the timer was stopped, this function will re-start it.
BOOL	ReInitDialog ()
	Will reset the initial dialog values. Should be used on an already open dialog box.
BOOL	StopPreviewing ()
	Puts the dialog into a stopped state ready to grab the frames or frame.
BOOL	SetDialogToIdleState ()
	Ensures that the the dialog is set into an idle state showing a cross in the preview section.
BOOL	SelectCurrentFrame (const UINT32 Position)
	Tries to set the current frame to be displayed and ensure that associated items are set e.g. the slider.
void	SetDelay (UINT32 newDelay)
Static Public Member Functions
static BOOL	Init ()
	Creates an OpDescriptor for a Preview Dialog.
static BOOL	GetStatusLineText (String_256 *Result)
static OpState	GetState (String_256 *, OpDescriptor *)
	Returns the OpState of the Preview dialogue operation.
static BOOL	GetAnimationPropertiesChanged ()
static void	SetAnimationPropertiesChanged (const BOOL Val)
static PreviewDialog *	GetPreviewDialog ()
static void	ToggleViaBitmapGallery (BOOL val)
Static Public Attributes
static const UINT32	IDD = _R(IDD_PREVIEWDIALOG)
static const CDlgMode	Mode = MODELESS
Protected Member Functions
void	RenderControl (ReDrawInfoType *pExtraInfo)
	Renders the current bitmap into the control. This actually consists of:- Render slabbed in border Render items before present bitmap in list to set up background Render current bitmap.
void	GridLockRect (DocRect *TheRect, INT32 GridSize)
	GridLocks all 4 coordinates of the rectangle using HalfGridLock Note: stolen from ColourEditDlg rendering routines.
INT32	HalfGridLock (INT32 Position, INT32 GridSize)
	Grid-locks a given plotting poisition to lie over a grid (usually the output device-pixel grid). The result is shifted by half the grid size to grid-lock to the _center_ of a pixel rather than the edges. Note: stolen from ColourEditDlg rendering routines.
BOOL	InitDialog ()
	Sets initial dialog values.
BOOL	SetUpCallBack ()
	Sets up the call back for this dialog box so that we get timer events and so can animate the bitmap on display.
BOOL	DoRegenerateFrames ()
	While previewing an animation, if the Reset button is clicked we need to regrab all the frames. This function invokes the correct Op.
void	SetPreviewDialogToIdleState (ReDrawInfoType *pExtraInfo)
	If the preview animation dialog is open, and the user does any of the following:- Changes the current doc. Closes the current doc. Opens a new doc. Then we stop playing the current animation, and set the dialog to a grey background with a cross in the centre.
KernelBitmap *	GetBitmapItem (INT32 Index)
	Returns the specified bitmap.
KernelBitmap *	GetCurrentBitmap (BOOL GetDetails=TRUE)
	Returns the current bitmap which we should be using.
Layer *	GetLayerItem (INT32 Index)
	Returns the specified layer.
Layer *	GetCurrentLayer ()
	Returns the current layer.
void	IncrementCurrentBitmap ()
	Moves the current item to be the next bitmap in the list. If we reach the end of the list, it then becomes the first item in the list.
void	DecrementCurrentBitmap ()
	Moves the current item to be the previous bitmap in the list. If we reach the start of the list, it then becomes the last item in the list.
UINT32	GetDelayForCurrentBitmap ()
	Returns the delay in centiseconds for the current bitmap.
void	SelectFirstBitmap ()
	Selects the first bitmap in our list.
void	SelectLastBitmap ()
	Selects the last bitmap in our list.
BOOL	SetDlgStateAfterDocChange ()
	If the Preview dialog is open before and after a doument change, then play the animation and set the correct state of the controls.
BOOL	SetDlgStateAfterRefresh ()
	When the preview dlg is open, if the refresh button is clicked, this function refreshes the current state of the dialog.
void	PreviewDlgPlay ()
	After the play button has been clicked, this functions plays the animation and sets the correct state of the controls.
void	PreviewDlgStop ()
	After the Stop button has been cllicked, this functions Stops the animation and sets the correct state of the controls.
void	PreviewNextFrame ()
	After the preview next frame button is clicked, if the animation was playing this function stops tha animation, and selects the next frame.
void	PreviewPreviousFrame ()
	After the Preview previous frame button is cllicked, if the animation was playing this function stops tha animation, and selects the previous frame.
void	SetSliderPosition ()
	This functiion deals with clicks on the Preview dialog slider control.
BOOL	ResizeDialogToFitAnimation ()
	Tries to resize the dialog to fit the animation in the preview control.
BOOL	RedrawBitmap (KernelBitmap *pBitmapToUse, DocRect *pVirtualSize)
	Redraws the specified bitmap into the render region.
BOOL	RedrawCross (DocRect *pVirtualSize, DialogColourInfo *pRedrawColours, INT32 PixelSize)
	Redraws the specified bitmap into the render region.
void	OnTimer ()
	This callback function is called when the new frame in the GIF should be displayed. It resets the timer to generate an event for the subsequent frame.
Static Protected Member Functions
static TCHAR *	HelpCallbackHandler (wxWindow *Window, UINT32 Item, void *UserData)
	Help callback handler to provide bubble help for the POreview Diaolg.
static BOOL	GetStatusLineText (PreviewDialog *pPrvDlg, UINT32 GadgetID, String_256 *Result)
Protected Attributes
List	m_BitmapList
INT32	m_BitmapListSize
INT32	m_CurrentItem
RenderRegion *	m_pRender
INT32	m_SliderPosition
BOOL	m_PlayAnimation
BOOL	m_DisplayNextFrame
BOOL	m_DisplayPreviousFrame
BOOL	m_DocumentAboutToDie
BOOL	m_SetPreviewDlgToIdleState
BOOL	m_GeneratedFrameLayers
GIFDisposalMethod	m_DisposalMethod
GIFDisposalMethod	m_CurrentDisposalMethod
DocRect	m_AnimationRect
INT32	m_CurrentLoopCount
INT32	m_RequiredLoopCount
PreviewTimer	m_Timer
Static Protected Attributes
static BOOL	viaBitmapGallery = FALSE
static UINT32	m_Delay = 0
static BOOL	m_AnimationPropertiesChanged = FALSE
static PreviewDialog *	m_pPreviewDialog = NULL
Private Member Functions
	CC_DECLARE_DYNCREATE (PreviewDialog)
Classes
class	PreviewTimer

---

Detailed Description

Definition at line 157 of file prevwdlg.h.

---

Constructor & Destructor Documentation

PreviewDialog::PreviewDialog (   )

Constructs a Preview Dialog. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/4/97 Definition at line 243 of file prevwdlg.cpp. : DialogOp(PreviewDialog::IDD, PreviewDialog::Mode), m_Timer(this) { m_BitmapListSize = 0; m_CurrentItem = 0; m_pPreviewDialog = this; m_pRender = NULL; m_PlayAnimation = TRUE; m_DisplayNextFrame = FALSE; m_DisplayPreviousFrame = FALSE; m_SliderPosition = m_BitmapListSize; m_DocumentAboutToDie = FALSE; m_SetPreviewDlgToIdleState = FALSE; m_GeneratedFrameLayers = FALSE; m_DisposalMethod = GDM_BACKTOBACK; m_CurrentDisposalMethod = GDM_BACKTOBACK; m_AnimationRect.MakeEmpty(); // Reset the loop counts m_CurrentLoopCount = 0; // The loop that we are currently on (default to start) m_RequiredLoopCount = 0; // The loop count that we must reach (default for ever) //viaBitmapGallery = FALSE; // THIS MUST ALREADY HAVE BEEN SET TO THE CORRECT // VALUE !!!!! // Get the input focus for bubble help. GetApplication()->RegisterIdleProcessor(IDLEPRIORITY_HIGH, this); }

PreviewDialog::~PreviewDialog (   )

Destructor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/4/97 Definition at line 282 of file prevwdlg.cpp. { // clean out the render region, if allocated if (m_pRender) { // Delete the render region and its (dialog) view // Do it by hand as StopRender should have been called already delete m_pRender->GetRenderView(); delete m_pRender; // DestroyGRenderRegion(m_pRender); m_pRender = NULL; } // Clean out the list of bitmaps that we were animating m_BitmapList.DeleteAll(); // kill the static link to this dialog box m_pPreviewDialog = NULL; // The dialog has been destroyed, remove the input focus. GetApplication()->RemoveIdleProcessor(IDLEPRIORITY_HIGH, this); }

---

Member Function Documentation

PreviewDialog::CC_DECLARE_DYNCREATE (  PreviewDialog   )  [private]

void PreviewDialog::DecrementCurrentBitmap (   )  [protected]

Moves the current item to be the previous bitmap in the list. If we reach the start of the list, it then becomes the last item in the list. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 14/05/97 Definition at line 1637 of file prevwdlg.cpp. { // Local flag to test whether to increment the slider position. // BOOL SliderPositionReset = FALSE; // Decrement the bitmap if the user has eitther clicked Play or Previous frame. if(m_PlayAnimation || m_DisplayPreviousFrame) { m_CurrentItem--; // Moving backwards so do what????? m_DisposalMethod = GDM_BACKTOBACK; // Activate the slider if we have more than 1 bitmap. if(m_BitmapListSize > 1) { // Increment the slider. m_SliderPosition++; // If the slider is at the start, then set it to the end. if(m_SliderPosition >= m_BitmapListSize + 1) m_SliderPosition = 1; } // Set the slider to the correct position. SetSliderPosition(m_SliderPosition); } // If we reach the start of the list then wrap around to the end. if (m_CurrentItem < 0) m_CurrentItem = (m_BitmapListSize-1); }

BOOL PreviewDialog::DoRegenerateFrames (   )  [protected]

While previewing an animation, if the Reset button is clicked we need to regrab all the frames. This function invokes the correct Op. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 21/05/97 Parameters: -  [INPUTS] Returns: True if worked ok, False otherwise Definition at line 2473 of file prevwdlg.cpp. { // When in stop mode, we should try and regrab the frame being displayed // When in play mode, we should grab the entire animation // If we were in stand by mode then grab the active frame. PORTNOTE("other", "Disabled BrowserPreviewOptions") #ifndef EXCLUDE_FROM_XARALX // Return false if the document is empty. String_256 ShadeReason; OpState State = OpGrabAllFrames::GetState(&ShadeReason, NULL); if (State.Greyed) { if(!m_SetPreviewDlgToIdleState) //Set the dlg to an idle state. m_SetPreviewDlgToIdleState = TRUE; // Force the gadget to be repainted. m_pPreviewDialog->InvalidateGadget(_R(IDC_REDRAW_ME)); return FALSE; } #endif // Temp flags to remember whether the animation was playing/How may layers existed // before all the frames were regenerated. BOOL AnimationPlaying = FALSE; //UINT32 PreRefreshNumberOfLayers = m_BitmapListSize; BOOL IdleState = m_SetPreviewDlgToIdleState; // If we are not in an idle state already then ensure that we are playing we are stopped if (!m_SetPreviewDlgToIdleState) { // Stop the animation. if (m_PlayAnimation) { StopPreviewing(); AnimationPlaying = TRUE; } } // Set the dlg idle flag back to false. m_SetPreviewDlgToIdleState = FALSE; // Are we in single bitmap mode? BOOL SingleBitmapMode = (m_BitmapListSize == 1); // If we were playing or idle then grab all frames //if (AnimationPlaying || IdleState) // If we are in an idle state or we are in multiple bitmap mode then // refresh = grab all frames if (IdleState || !SingleBitmapMode) { // If we were playing or idle then ensure that we restart in play mode if (AnimationPlaying || IdleState) m_PlayAnimation = TRUE; else m_PlayAnimation = FALSE; OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_GRABALLFRAMES); if (pOpDesc != NULL) pOpDesc->Invoke(); else { ERROR3("Couldn't find OPTOKEN_FRAME_GRABALLFRAMES op descriptor"); } } else { // We were showing a single frame so try and refresh this layer // and show it again. Layer * pLayerToRefresh = NULL; KernelBitmap * pBitmap = GetCurrentBitmap(); if (pBitmap != NULL) { // Search through the layers for this bitmap and then try and regenerate it // If we don't find it then regnerate the active layer Spread * pSpread = Document::GetSelectedSpread(); if (pSpread) { Layer * pLayer = pSpread->FindFirstFrameLayer(); BOOL Found = FALSE; while (pLayer != NULL && !Found) { KernelBitmap * pLayerBitmap = pLayer->GetGeneratedBitmap(); if (pLayerBitmap == pBitmap) { pLayerToRefresh = pLayer; Found = TRUE; } pLayer = pLayer->FindNextFrameLayer(); } } } // Ensure that we restart in stop mode m_PlayAnimation = FALSE; OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_GRABFRAME); // Pass in pLayerToRefresh as a possible layer to refresh if (pOpDesc != NULL) { OpParam Param; Param.Param1 = (void *)pLayerToRefresh; pOpDesc->Invoke(&Param); } else { ERROR3("Couldn't find OPTOKEN_FRAME_GRABALLFRAMES op descriptor"); } } // The ops should call us back to set everything up. // We will just ensure that these are set correctly // Set the flags to the correct state. m_DocumentAboutToDie = FALSE; m_SetPreviewDlgToIdleState = FALSE; // Reset the loop counts m_CurrentLoopCount = 0; // The loop that we are currently on (default to start) m_RequiredLoopCount = 0; // The loop count that we must reach (default for ever) // Through a document change, the timer may not be ticking. // If it has been stopped, then re-start. RestartTimer(); return TRUE; }

void PreviewDialog::DoWithParam (  OpDescriptor *  pOpDesc, OpParam *  pParam )  [virtual]

Creates and shows a Preview dialog. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/4/97 Parameters: pOpDesc  The OpDescriptor being invoked [INPUTS] pParam The parameters being passed in Reimplemented from Operation. Definition at line 1961 of file prevwdlg.cpp. { TRACEUSER( "Neville", _T("PreviewDialog::DoWithParam\n")); // Check out the parameter that we should be being passed if (pParam == NULL) { ERROR2RAW("OpMenuExport::DoWithParam bad params"); FailAndExecute(); End(); return; } BitmapExportParam* pExportParam = (BitmapExportParam*) pParam; ERROR3IF(!pExportParam->IS_KIND_OF(BitmapExportParam), "OpParam passed is not a BitmapExportParam"); if (pExportParam->GetBitmapCount() == 0) { ERROR2RAW("OpMenuExport::DoWithParam no bitmaps to preview"); FailAndExecute(); End(); return; } // Take a copy of the list of bitmaps passed in // Don't set the slider position as we haven't constructed the dialog yet! SetBitmapList(pExportParam, FALSE); // Has more than one frame layer been generated. if(m_BitmapListSize > 1) m_GeneratedFrameLayers = TRUE; // Force the dialog box to be created. // If it is non-modal it must be opened if the create works ok. // If it is modal then don't call the open if (Create()) { // If dialog is not Modal do this now // Otherwise set up happens in the message handler if (Mode == MODELESS) { // Try to resize the dialog box so that the current animation fits ResizeDialogToFitAnimation(); // Set the initial control values InitDialog(); // If modeless then call open Open() Open(); // Set up the call back so we get timer events SetUpCallBack(); } } else { TRACE( _T("Failed to create Render Demo Dialog\n")); // Could not create the dialog box so call inform error InformError(); // Show user the error End(); // End the operation } return; }

static BOOL PreviewDialog::GetAnimationPropertiesChanged (   )  [inline, static]

Definition at line 180 of file prevwdlg.h. { return m_AnimationPropertiesChanged; }

KernelBitmap * PreviewDialog::GetBitmapItem (  INT32  Index  )  [protected]

Returns the specified bitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/6/97 Parameters: Index  the index of the bitmap in the list to get [INPUTS] Definition at line 1437 of file prevwdlg.cpp. { // If beyond the end of the list or the start then return nothing found if (Index >= m_BitmapListSize || Index < 0) return NULL; // Search through the list for the nth item AnimatedBitmapItem * pCurrentItem = (AnimatedBitmapItem *)m_BitmapList.GetHead(); INT32 Count = 0; while (pCurrentItem) { if (Count == Index) { return pCurrentItem->GetBitmap(); } Count ++; // Get the next item in the list pCurrentItem = (AnimatedBitmapItem *)m_BitmapList.GetNext(pCurrentItem); } // Nothing found return NULL; }

INT32 PreviewDialog::GetBitmapListSize (   )  [inline]

Definition at line 192 of file prevwdlg.h. { return m_BitmapListSize; }

KernelBitmap * PreviewDialog::GetCurrentBitmap (  BOOL  GetDetails = TRUE  )  [protected]

Returns the current bitmap which we should be using. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/4/97 Definition at line 1473 of file prevwdlg.cpp. { KernelBitmap * pBitmapToUse = NULL; // If beyond the end of the list then wrap around to the start if (m_CurrentItem >= m_BitmapListSize) m_CurrentItem = 0; // Search through the list for the nth item AnimatedBitmapItem * pCurrentItem = (AnimatedBitmapItem *)m_BitmapList.GetHead(); INT32 Count = 0; while (pCurrentItem) { if (Count == m_CurrentItem) { pBitmapToUse = pCurrentItem->GetBitmap(); break; } Count ++; // Get the next item in the list pCurrentItem = (AnimatedBitmapItem *)m_BitmapList.GetNext(pCurrentItem); } // Note the disposal method for this bitmap for the next time around if (pBitmapToUse && GetDetails) { m_CurrentDisposalMethod = pBitmapToUse->GetAnimationRestoreType(); // Set up the frame/layer name control to be the bitmap name String_256 Name = pBitmapToUse->GetName(); SetStringGadgetValue(_R(IDC_PREVIEW_FRAMENAME), Name); } return pBitmapToUse; }

INT32 PreviewDialog::GetCurrentItem (   )  [inline]

Definition at line 199 of file prevwdlg.h. { return m_CurrentItem; }

Layer * PreviewDialog::GetCurrentLayer (   )  [protected]

Returns the current layer. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/6/97 Definition at line 1379 of file prevwdlg.cpp. { // If beyond the end of the list then wrap around to the start if (m_CurrentItem >= m_BitmapListSize) m_CurrentItem = 0; // get the item associated with this index return GetLayerItem(m_CurrentItem); }

UINT32 PreviewDialog::GetDelayForCurrentBitmap (   )  [protected]

Returns the delay in centiseconds for the current bitmap. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 14/4/97 Returns: Delay in centiseconds. Definition at line 1878 of file prevwdlg.cpp. { if (!viaBitmapGallery) { UINT32 Delay = 0; KernelBitmap * pBitmap = GetCurrentBitmap(FALSE); if (pBitmap) { // Ask the bitmap for its stored delay Delay = pBitmap->GetDelay(); // If the delay specified is zero then use the default if (Delay == 0) Delay = 10; } return Delay; } else { return (100); // we wan't a longer delay .... } }

BOOL PreviewDialog::GetDlgState (   )  [inline]

Definition at line 194 of file prevwdlg.h. { return m_SetPreviewDlgToIdleState; }

BOOL PreviewDialog::GetGeneratedFrameLayers (   )  [inline]

Definition at line 197 of file prevwdlg.h. { return m_GeneratedFrameLayers; }

Layer * PreviewDialog::GetLayerItem (  INT32  Index  )  [protected]

Returns the specified layer. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/6/97 Parameters: Index  the index of the layer in the list to get [INPUTS] Definition at line 1400 of file prevwdlg.cpp. { // If beyond the end of the list or the start then return nothing found if (Index >= m_BitmapListSize || Index < 0) return NULL; // Search through the list for the nth item AnimatedBitmapItem * pCurrentItem = (AnimatedBitmapItem *)m_BitmapList.GetHead(); INT32 Count = 0; while (pCurrentItem) { if (Count == Index) { return pCurrentItem->GetLayer(); } Count ++; // Get the next item in the list pCurrentItem = (AnimatedBitmapItem *)m_BitmapList.GetNext(pCurrentItem); } // Nothing found return NULL; }

BOOL PreviewDialog::GetPlayAnimation (   )  [inline]

Definition at line 190 of file prevwdlg.h. { return m_PlayAnimation; }

static PreviewDialog* PreviewDialog::GetPreviewDialog (   )  [inline, static]

Definition at line 187 of file prevwdlg.h. { return m_pPreviewDialog; }

INT32 PreviewDialog::GetSliderPosition (   )  [inline]

Definition at line 200 of file prevwdlg.h. { return m_SliderPosition; }

OpState PreviewDialog::GetState (  String_256 *  , OpDescriptor *  )  [static]

Returns the OpState of the Preview dialogue operation. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/4/97 Definition at line 1912 of file prevwdlg.cpp. { return OpState(FALSE, FALSE); }

BOOL PreviewDialog::GetStatusLineText (  PreviewDialog *  pPrvDlg, UINT32  GadgetID, String_256 *  Result )  [static, protected]

Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 21/05/97 Parameters: pPrvDlg  - Points to the current Preview Dialog. [INPUTS] GadgetID - indicates the gadget for which you want status bar help. If  return value is TRUE, Result is updated with an appropriate help string. [OUTPUTS] Returns: - Definition at line 2440 of file prevwdlg.cpp. { if (GadgetID == _R(IDC_PREVIEW_PLAY)) { *Result = String_256(_R(IDS_PREVIEWST_PLAY)); } else if (GadgetID == _R(IDC_PREVIEW_STOP)) { *Result = String_256(_R(IDS_PREVIEWST_STOP)); } else if (GadgetID == _R(IDC_PREVIEW_NEXTFRAME)) { *Result = String_256(_R(IDS_PREVIEW_NEXTFRAME)); } else if (GadgetID == _R(IDC_PREVIEW_PREVFRAME)) { *Result = String_256(_R(IDS_PREVIEW_PREVFRAME)); } return TRUE; }

BOOL PreviewDialog::GetStatusLineText (  String_256 *  Result  )  [static]

Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason code) Date: 21/05/97 Parameters: *Result  - The String to recieve the status line text. [INPUTS] Outputs The Status Line string to use, or NULL if not available. Returns TRUE if successful, else false. Definition at line 2371 of file prevwdlg.cpp. { PORTNOTE("other", "Disabled bitmap preview dialog live status text") #ifndef EXCLUDE_FROM_XARALX ERROR3IF(Result == NULL, "Illegal NULL param"); PreviewDialog* pPreviewDlg = m_pPreviewDialog; if (pPreviewDlg == NULL) return(FALSE); // Find the main editor window CWindowID TheWindow = (CWindowID)pPreviewDlg->WindowID; if (TheWindow == NULL) return(FALSE); // Get the cursor position in screen coords POINT TempPos; if (!::GetCursorPos(&TempPos)) return(FALSE); // Convert to client coords in the main window ScreenToClient(TheWindow, &TempPos); // See if this is over the main window or any child, get it's CWindowID CPoint Pos(TempPos); CWindowID WindowUnderPointer = ::ChildWindowFromPoint(TheWindow, Pos); if (WindowUnderPointer == NULL) return(FALSE); // Make sure that hidden windows do not provide status help! INT32 WindowStyle = ::GetWindowLong(WindowUnderPointer, GWL_STYLE); if ((WindowStyle & WS_VISIBLE) == 0) return(FALSE); // If the pointer is over main window background, return standard help if (WindowUnderPointer == TheWindow) return(GetStatusLineText(pPreviewDlg, 0, Result)); // Otherwise, see if we can find help for the specific gadget CWindowID hGadget; INT32 i = 0; while (BubbleHelp[i].Gadget != NULL) { hGadget = GetDlgItem(TheWindow, BubbleHelp[i].Gadget); if (WindowUnderPointer == hGadget && GetStatusLineText(pPreviewDlg, BubbleHelp[i].Gadget, Result)) return(TRUE); i++; } return FALSE; #else return TRUE; #endif }

void PreviewDialog::GridLockRect (  DocRect *  TheRect, INT32  GridSize )  [protected]

GridLocks all 4 coordinates of the rectangle using HalfGridLock Note: stolen from ColourEditDlg rendering routines. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> from Jason code in coldlog.cpp Date: 28/7/97 Parameters: TheRect  - A MILLIPOINT DocRect to be grid-locked [INPUTS] GridSize - the size of the grid to lock to, in millipoints TheRect  is updated as appropriate [OUTPUTS] Definition at line 1361 of file prevwdlg.cpp. { TheRect->lo.x = HalfGridLock(TheRect->lo.x, GridSize); TheRect->lo.y = HalfGridLock(TheRect->lo.y, GridSize); TheRect->hi.x = HalfGridLock(TheRect->hi.x, GridSize); TheRect->hi.y = HalfGridLock(TheRect->hi.y, GridSize); }

INT32 PreviewDialog::HalfGridLock (  INT32  Position, INT32  GridSize )  [inline, protected]

Grid-locks a given plotting poisition to lie over a grid (usually the output device-pixel grid). The result is shifted by half the grid size to grid-lock to the _center_ of a pixel rather than the edges. Note: stolen from ColourEditDlg rendering routines. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> from Jason code in coldlog.cpp Date: 28/7/97 Parameters: Position  - The X/Y position, in millipoints [INPUTS] GridSize - the size of the grid to lock to, in millipoints Returns: Position, locked (by rounding) to a grid of the given size, and offset by half a grid. Definition at line 1317 of file prevwdlg.cpp. { // By truncating down to the nearest grid point, and adding half the grid value, // we achieve rounding to the nearest offset-grid position. // NOTE: // The original algorithm incorrectly rounded negative numbers towards // zero. Negative numbers should be rounded towards negative infinity. // The algorithm has been corrected by always rounding a positive number // and restoring the original sign of the number after rounding. BOOL bNegative = FALSE; // Assume the number is positive if (Position < 0) // If the number if not positive { // note the fact and make positive bNegative = TRUE; Position = -Position; } Position -= Position % GridSize; Position += GridSize / 2; if (bNegative) // If the number was negative Position = -Position; // restore the sign return (Position); }

TCHAR * PreviewDialog::HelpCallbackHandler (  wxWindow *  Window, UINT32  Item, void *  UserData )  [static, protected]

Help callback handler to provide bubble help for the POreview Diaolg. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> (Based onn Jason code) Date: 21/05/97 Parameters: Window  - The window to get help for [INPUTS] Item - The control to get help for UserData - User-supplied data (not used) Returns: The bubble help string to use, or NULL if no help is available. Definition at line 2316 of file prevwdlg.cpp. { static String_256 HelpStringStore; BOOL ReturnVal = FALSE; PreviewDialog* pPreviewDlg = m_pPreviewDialog; if (pPreviewDlg == NULL) return(NULL); if (Item == _R(IDC_PREVIEW_PLAY)) { HelpStringStore = String_256(_R(IDS_PREVIEWBH_PLAY)); ReturnVal = TRUE; } else if (Item == _R(IDC_PREVIEW_STOP)) { HelpStringStore = String_256(_R(IDS_PREVIEWBH_STOP)); ReturnVal = TRUE; } else if (Item == _R(IDC_PREVIEW_NEXTFRAME)) { HelpStringStore = String_256(_R(IDS_PREVIEWBH_NEXTFRAME)); ReturnVal = TRUE; } else if (Item == _R(IDC_PREVIEW_PREVFRAME)) { HelpStringStore = String_256(_R(IDS_PREVIEWBH_PREVFRAME)); ReturnVal = TRUE; } else if (Item == _R(IDC_PREVIEW_SLIDER)) { HelpStringStore = String_256(_R(IDS_PREVIEWBH_SLIDER)); ReturnVal = TRUE; } if (ReturnVal) return((TCHAR *) HelpStringStore); return(NULL); }

void PreviewDialog::IncrementCurrentBitmap (   )  [protected]

Moves the current item to be the next bitmap in the list. If we reach the end of the list, it then becomes the first item in the list. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/4/97 Definition at line 1523 of file prevwdlg.cpp. { // Local flag to test whether to increment the slider position. // BOOL SliderPositionReset = FALSE; // Increment the Bitmap if the user has clicked either Play or NextFrame. if (m_PlayAnimation || m_DisplayNextFrame ) { m_CurrentItem++; // Moving forward so note the current disposal method as the new one m_DisposalMethod = m_CurrentDisposalMethod; // Only activate the slider if we have more than 1 bitmap. if(m_BitmapListSize > 1) { // Decrement the slider. m_SliderPosition--; // If the slider is set to the end, place it back at the start. if (m_SliderPosition <= 0) m_SliderPosition = m_BitmapListSize; } // Set the slider to the correct position. SetSliderPosition(m_SliderPosition); }