frameops.cpp

Go to the documentation of this file.

// $Id: frameops.cpp 1282 2006-06-09 09:46:49Z alex $
/* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
================================XARAHEADERSTART===========================
 
               Xara LX, a vector drawing and manipulation program.
                    Copyright (C) 1993-2006 Xara Group Ltd.
       Copyright on certain contributions may be held in joint with their
              respective authors. See AUTHORS file for details.

LICENSE TO USE AND MODIFY SOFTWARE
----------------------------------

This file is part of Xara LX.

Xara LX is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.

Xara LX and its component source files are distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with Xara LX (see the file GPL in the root directory of the
distribution); if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


ADDITIONAL RIGHTS
-----------------

Conditional upon your continuing compliance with the GNU General Public
License described above, Xara Group Ltd grants to you certain additional
rights. 

The additional rights are to use, modify, and distribute the software
together with the wxWidgets library, the wxXtra library, and the "CDraw"
library and any other such library that any version of Xara LX relased
by Xara Group Ltd requires in order to compile and execute, including
the static linking of that library to XaraLX. In the case of the
"CDraw" library, you may satisfy obligation under the GNU General Public
License to provide source code by providing a binary copy of the library
concerned and a copy of the license accompanying it.

Nothing in this section restricts any of the rights you have under
the GNU General Public License.


SCOPE OF LICENSE
----------------

This license applies to this program (XaraLX) and its constituent source
files only, and does not necessarily apply to other Xara products which may
in part share the same code base, and are subject to their own licensing
terms.

This license does not apply to files in the wxXtra directory, which
are built into a separate library, and are subject to the wxWindows
license contained within that directory in the file "WXXTRA-LICENSE".

This license does not apply to the binary libraries (if any) within
the "libs" directory, which are subject to a separate license contained
within that directory in the file "LIBS-LICENSE".


ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
----------------------------------------------

Subject to the terms of the GNU Public License (see above), you are
free to do whatever you like with your modifications. However, you may
(at your option) wish contribute them to Xara's source tree. You can
find details of how to do this at:
  http://www.xaraxtreme.org/developers/

Prior to contributing your modifications, you will need to complete our
contributor agreement. This can be found at:
  http://www.xaraxtreme.org/developers/contribute/

Please note that Xara will not accept modifications which modify any of
the text between the start and end of this header (marked
XARAHEADERSTART and XARAHEADEREND).


MARKS
-----

Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
designs are registered or unregistered trademarks, design-marks, and/or
service marks of Xara Group Ltd. All rights in these marks are reserved.


      Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
                        http://www.xara.com/

=================================XARAHEADEREND============================
 */

// The Frame Operations source file

/*
*/

#include "camtypes.h"
#include "frameops.h"

//#include "prevwres.h"     // _R(IDS_DISPLAY_FRAME_GALLERY) _R(IDD_ANIMATIONBAR) ...
#include "sgframe.h"        // FrameSGallery
//#include "spread.h"           // Spread - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "simon.h"            // _R(IDS_NO_DOC)
//#include "app.h"          // GetApplication() - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "fixmem.h"           // CCMalloc - in camtypes.h [AUTOMATICALLY REMOVED]
#include "prevwdlg.h"       // OPTOKEN_PREVIEWDIALOG
#include "grndbmp.h"        // GRenderBitmap
#include "filedlgs.h"       // ExportFileDialog
//#include "tim.h"          // _R(IDT_CANT_FIND_FILTER)
//#include "oilfltrs.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "nev.h"          // _R(IDN_USER_CANCELLED)
#include "layermsg.h"       // layer messages REDRAW_LAYER

//#include "accures.h"      // _R(IDN_FILTEREXT_GIF)

//#include "docview.h" - in camtypes.h [AUTOMATICALLY REMOVED]

#include "nodebmp.h"        // NodeBitmap
#include "insertnd.h"       // InsertionNode
#include "aprps.h"

// browser preview
#include "fileutil.h"       // FileUtil::GetTemporaryPathName()
#include "cbmpdata.h"       // CBitmapData

#include "palman.h"         // MakePaletteBrowserCompatible

//#include "xshelpid.h" //For the help ID

#include "gpalopt.h" // for the palette optimiser
#include "mrhbits.h"
#include "page.h"
//#include "quality.h" - in camtypes.h [AUTOMATICALLY REMOVED]

DECLARE_SOURCE("$Revision: 1282 $");

CC_IMPLEMENT_DYNCREATE(OpSelectStartFrame,  OpLayerGalChange);
CC_IMPLEMENT_DYNCREATE(OpSelectEndFrame,    OpLayerGalChange);
CC_IMPLEMENT_DYNCREATE(OpSelectPrevFrame,   OpLayerGalChange);
CC_IMPLEMENT_DYNCREATE(OpSelectNextFrame,   OpLayerGalChange);
CC_IMPLEMENT_DYNCREATE(OpCreateNewFrame,    OpLayerGalChange);
CC_IMPLEMENT_DYNCREATE(OpCopyFrame,         OpLayerGalChange);
CC_IMPLEMENT_DYNCREATE(OpDeleteFrame,       OpLayerGalChange);

CC_IMPLEMENT_DYNCREATE(OpFrameProperties, Operation);
CC_IMPLEMENT_DYNCREATE(OpAnimationProperties, Operation);


PORTNOTE("other", "Removed GrabFrameFilter, OpGrabFrame, OpGrabAllFrames")
#ifndef EXCLUDE_FROM_XARALX
CC_IMPLEMENT_DYNAMIC(GIFAnimationExportParam,   BitmapExportParam);
CC_IMPLEMENT_DYNCREATE(OpGrabFrame, Operation);
CC_IMPLEMENT_DYNCREATE(OpGrabAllFrames, OpGrabFrame);
CC_IMPLEMENT_DYNAMIC(GrabFrameFilter, MakeBitmapFilter);
CC_IMPLEMENT_DYNCREATE(OpSaveAnimatedGIF, OpGrabAllFrames);
CC_IMPLEMENT_DYNCREATE(OpBrowserPreview, OpSaveAnimatedGIF);

BOOL OpGrabAllFrames::ms_ForceRefreshOfAllFrames = FALSE;
#endif

// This will get Camelot to display the filename and linenumber of any memory allocations
// that are not released at program exit
// This line mustn't go before any CC_IMPLEMENT_... macros
#define new CAM_DEBUG_NEW


//------------------------------------------------------------------------------------------
// Methods for the OpSelectStartFrame
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpSelectStartFrame::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpSelectStartFrame operation
    Purpose:    For finding the OpSelectStartFrame's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpSelectStartFrame::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    OpState OpSt;  

    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();
        Layer * pPrevLayer = pLayer->FindPrevLayer();
        // The previous layer should really be a frame layer but we cannot guarantee that but
        // it mustn't be a guide, a page background or a background layer.
        while ( pPrevLayer && !pPrevLayer->IsPseudoFrame())
        {
            pPrevLayer = pPrevLayer->FindPrevLayer();
        }

        if (pLayer && pPrevLayer)
        {
            // Yes, so we are allowed to move to the next one
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }

    return OpSt;   
}

/********************************************************************************************

>   void OpSelectStartFrame::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to select the bottom most animation frame (i.e. layer).
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpSelectStartFrame::Do( OpDescriptor * pOpDesc )
{
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
PORTNOTE("other", "Disabled FrameSGallery")
#ifndef EXCLUDE_FROM_XARALX
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);
#endif
        // yes, so find the first layer and try to move to it
        Layer * pLayer = pSpread->FindFirstFrameLayer();
        if (pLayer)
        {
            OpLayerGalParam Param(FRAME_SELECT, pSpread);
            Param.pLayer = pLayer;
            DoWithParam(pOpDesc, (OpParam*)&Param);
        }
    }

    // End the operation, but we are calling DoWithParam() which we will assume does it for us.
    //End();

    return;
}

/********************************************************************************************
// End of OpSelectStartFrame
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpSelectEndFrame
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpSelectEndFrame::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpSelectEndFrame operation
    Purpose:    For finding the OpSelectEndFrame's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpSelectEndFrame::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    OpState OpSt;  

    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();
        // If there is an active layer and one following then we are not greyed
        Layer * pNextLayer = pLayer->FindNextLayer();
        // The next layer should really be a frame layer but we cannot guarantee that but
        // it mustn't be a guide, a page background or a background layer.
        while ( pNextLayer && !pNextLayer->IsPseudoFrame())
        {
            pNextLayer = pNextLayer->FindNextLayer();
        }

        if (pLayer && pNextLayer)
        {
            // Yes, so we are allowed to move to the previous one
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }

    return OpSt;   
}

/********************************************************************************************

>   void OpSelectEndFrame::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to select the bottom most animation frame (i.e. layer).
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpSelectEndFrame::Do( OpDescriptor * pOpDesc )
{
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
PORTNOTE("other", "Disabled FrameSGallery")
#ifndef EXCLUDE_FROM_XARALX
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);
#endif
        // yes, so find the last layer and try to move to it
        Layer * pLayer = pSpread->FindLastFrameLayer();
        if (pLayer)
        {
            OpLayerGalParam Param(FRAME_SELECT, pSpread);
            Param.pLayer = pLayer;
            DoWithParam(pOpDesc, (OpParam*)&Param);
        }
    }

    // End the operation, but we are calling DoWithParam() which we will assume does it for us.
    //End();

    return;
}

/********************************************************************************************
// End of OpSelectEndFrame
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpSelectPrevFrame
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpSelectPrevFrame::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpSelectPrevFrame operation
    Purpose:    For finding the OpSelectPrevFrame's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpSelectPrevFrame::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    //The frame movement controls on the GIF animation bar now work on frames only.
    OpState OpSt;  

#ifdef WEBSTER

    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();
        // If there is an active layer and one preceeding then we are not greyed
        Layer * pPrevLayer = pLayer->FindPrevLayer();
        // The previous layer should really be a frame layer but we cannot guarantee that but
        // it mustn't be a guide, a page background or a background layer.
        while ( pPrevLayer && !pPrevLayer->IsPseudoFrame())
        {
            pPrevLayer = pPrevLayer->FindPrevLayer();
        }
     
        if (pLayer && pPrevLayer)
        {
            // Yes, so we are allowed to move to the previous one
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }

#else
    // Are we in frame mode.
    BOOL FrameMode = IsFrameMode();

    if(FrameMode)
    {
        // Is there a selected spread?
        Spread * pSpread = Document::GetSelectedSpread();
        if (pSpread)
        {
            // yes, so check if there is an active layer
            Layer * pLayer = pSpread->FindActiveLayer();
            // If there is an active layer and one preceeding then we are not greyed
            Layer * pPrevLayer = pLayer->FindPrevLayer();
            // The previous layer should really be a frame layer but we cannot guarantee that but
            // it mustn't be a guide, a page background or a background layer.
            while ( pPrevLayer && !pPrevLayer->IsPseudoFrame())
            {
                pPrevLayer = pPrevLayer->FindPrevLayer();
            }

            if (pLayer && pPrevLayer)
            {
                // Yes, so we are allowed to move to the previous one
                OpSt.Greyed = FALSE;
            }
            else
            {
                // No, so we are greyed
                OpSt.Greyed = TRUE;
            }
        }
        else
        {
            // No selected spread, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // The document is layer based, so we are greyed.
        OpSt.Greyed = TRUE;
    }
#endif

    return OpSt;   
}

/********************************************************************************************

>   void OpSelectPrevFrame::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to select the previous animation frame (i.e. layer).
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpSelectPrevFrame::Do( OpDescriptor * pOpDesc )
{
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
PORTNOTE("other", "Disabled FrameSGallery")
#ifndef EXCLUDE_FROM_XARALX
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);
#endif
        // yes, so find the last layer and try to move to it
        Layer * pLayer = pSpread->FindActiveLayer();
        Layer * pPrevLayer = NULL;
        if (pLayer)
            pPrevLayer = pLayer->FindPrevFrameLayer();
        if (pPrevLayer)
        {
            OpLayerGalParam Param(FRAME_SELECT, pSpread);
            Param.pLayer = pPrevLayer;
            DoWithParam(pOpDesc, (OpParam*)&Param);
        }
    }

    // End the operation, but we are calling DoWithParam() which we will assume does it for us.
    //End();

    return;
}

/********************************************************************************************
// End of OpSelectPrevFrame
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpSelectNextFrame
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpSelectNextFrame::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpSelectNextFrame operation
    Purpose:    For finding the OpSelectNextFrame's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpSelectNextFrame::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    //The frame movement controls on the GIF animation bar now work on frames only.

    OpState OpSt;  

#ifdef WEBSTER

    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();
        // If there is an active layer and one following then we are not greyed
        Layer * pNextLayer = pLayer->FindNextLayer();
        // The next layer should really be a frame layer but we cannot guarantee that but
        // it mustn't be a guide, a page background or a background layer.
        while ( pNextLayer && !pNextLayer->IsPseudoFrame())
        {
            pNextLayer = pNextLayer->FindNextLayer();
        }
     
        if (pLayer && pNextLayer)
        {
            // Yes, so we are allowed to move to the previous one
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }

#else
    // Are we in frame mode.
    BOOL FrameMode = IsFrameMode();

    if(FrameMode)
    {
        // Is there a selected spread?
        Spread * pSpread = Document::GetSelectedSpread();
        if (pSpread)
        {
            // yes, so check if there is an active layer
            Layer * pLayer = pSpread->FindActiveLayer();
            // If there is an active layer and one following then we are not greyed
            Layer * pNextLayer = pLayer->FindNextLayer();
            // The next layer should really be a frame layer but we cannot guarantee that but
            // it mustn't be a guide, a page background or a background layer.
            while ( pNextLayer && !pNextLayer->IsPseudoFrame())
            {
                pNextLayer = pNextLayer->FindNextLayer();
            }

            if (pLayer && pNextLayer)
            {
                // Yes, so we are allowed to move to the previous one
                OpSt.Greyed = FALSE;
            }
            else
            {
                // No, so we are greyed
                OpSt.Greyed = TRUE;
            }
        }
        else
        {
            // No selected spread, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
            // The document is layer based, so we are greyed.
            OpSt.Greyed = TRUE;
    }
#endif

    return OpSt;   
}

/********************************************************************************************

>   void OpSelectNextFrame::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to select the next animation frame (i.e. layer).
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpSelectNextFrame::Do( OpDescriptor * pOpDesc )
{
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
PORTNOTE("other", "Disabled BrowserPreviewOptions")
#ifndef EXCLUDE_FROM_XARALX
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);
#endif
        // yes, so find the next layer and try to move to it
        Layer * pLayer = pSpread->FindActiveLayer();
        Layer * pNextLayer = NULL;
        if (pLayer)
            pNextLayer = pLayer->FindNextFrameLayer();
        if (pNextLayer)
        {
            OpLayerGalParam Param(FRAME_SELECT, pSpread);
            Param.pLayer = pNextLayer;
            DoWithParam(pOpDesc, (OpParam*)&Param);
        }
    }

    // End the operation, but we are calling DoWithParam() which we will assume does it for us.
    //End();

    return;
}

/********************************************************************************************
// End of OpSelectNextFrame
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpCreateNewFrame
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpCreateNewFrame::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpCreateNewFrame operation
    Purpose:    For finding the OpCreateNewFrame's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpCreateNewFrame::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    //The frame movement controls on the GIF animation bar now work on frames only.
    OpState OpSt;  

#ifdef WEBSTER
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // Yes, so we are allowed to move to the previous one
        OpSt.Greyed = FALSE;
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }
#else
    // Are we in frame mode.
    BOOL FrameMode = IsFrameMode();

    if(FrameMode)
    {
        // Is there a selected spread?
        Spread * pSpread = Document::GetSelectedSpread();
        if (pSpread)
        {
            // Yes, so we are allowed to move to the previous one
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No selected spread, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // The document is layer based, so we are greyed.
        OpSt.Greyed = TRUE;
    }
#endif

    return OpSt;   
}

/********************************************************************************************

>   void OpCreateNewFrame::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to create a new animation frame (i.e. layer).
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpCreateNewFrame::Do( OpDescriptor * pOpDesc )
{
PORTNOTE("other", "Disabled BrowserPreviewOptions")
#ifndef EXCLUDE_FROM_XARALX
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);
        // Use the spread as the context node
        OpLayerGalParam Param(FRAME_NEW, pSpread);
        Param.pLayer        = NULL;
        Param.pContextNode  = pSpread;
        Param.AttDir        = LASTCHILD;
        // Set up the name that is going to be applied to the frame
        String_256 NewName = FrameSGallery::CreateUniqueLayerID(pSpread);
        //String_256 NewName(_R(IDS_DEFAULTFRAMENAME));
        Param.Status.StringLayerID = NewName;
        DoWithParam(pOpDesc, (OpParam*)&Param);
    }

    // End the operation, but we are calling DoWithParam() which we will assume does it for us.
    //End();
#endif

    return;
}

/********************************************************************************************
// End of OpCreateNewFrame
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpCopyFrame
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpCopyFrame::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpCopyFrame operation
    Purpose:    For finding the OpCopyFrame's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpCopyFrame::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    //The frame movement controls on the GIF animation bar now work on frames only.
    OpState OpSt;  

#ifdef WEBSTER
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();
        // If there is an active layer then we are not greyed
        if (pLayer)
        {
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }
#else
    // Are we in frame mode.
    BOOL FrameMode = IsFrameMode();

    if(FrameMode)
    {
        // Is there a selected spread?
        Spread * pSpread = Document::GetSelectedSpread();
        if (pSpread)
        {
            // yes, so check if there is an active layer
            Layer * pLayer = pSpread->FindActiveLayer();
            // If there is an active layer then we are not greyed
            if (pLayer)
            {
                OpSt.Greyed = FALSE;
            }
            else
            {
                // No, so we are greyed
                OpSt.Greyed = TRUE;
            }
        }
        else
        {
            // No selected spread, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // The document is layer based, so we are greyed.
        OpSt.Greyed = TRUE;
    }
#endif

    return OpSt;   
}

/********************************************************************************************

>   void OpCopyFrame::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to create a new frame by copying the present one.
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpCopyFrame::Do( OpDescriptor * pOpDesc )
{
PORTNOTE("other", "Disabled FrameSGallery")
#ifndef EXCLUDE_FROM_XARALX
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);

        // yes, so check that there is a presently active layer and try to copy it
        // Use the spread as the context node
        Layer * pLayer = pSpread->FindActiveLayer();
        if (pLayer)
        {
            OpLayerGalParam Param(FRAME_COPY, pSpread);
            Param.pLayer = pLayer;
            Param.pContextNode  = pSpread;
            Param.AttDir        = LASTCHILD;
            // Set up the name that is going to be applied to the frame
            String_256 NewName = FrameSGallery::CreateUniqueLayerID(pSpread);
            //String_256 NewName(_R(IDS_DEFAULTFRAMENAME));
            Param.Status.StringLayerID = NewName;
            DoWithParam(pOpDesc, (OpParam*)&Param);
        }
    }

    // End the operation, but we are calling DoWithParam() which we will assume does it for us.
    //End();
#endif
    return;
}

/********************************************************************************************
// End of OpCopyFrame
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpDeleteFrame
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpDeleteFrame::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    23/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpDeleteFrame operation
    Purpose:    For finding the OpDeleteFrame's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpDeleteFrame::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    //The frame movement controls on the GIF animation bar now work on frames only.
    OpState OpSt;  

#ifdef WEBSTER
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();

        // Get ptr's to the next and previous frame layers.
        Layer* pNextLayer = pLayer->FindNextFrameLayer();
        Layer* pPrevLayer = pLayer->FindPrevFrameLayer();

        // If there is an active layer and a previous/next layer then we are not greyed.
        if ( pLayer && (pPrevLayer || pNextLayer) )
        {
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }
#else
    // Are we in frame mode.
    BOOL FrameMode = IsFrameMode();

    if(FrameMode)
    {
        // Is there a selected spread?
        Spread * pSpread = Document::GetSelectedSpread();
        if (pSpread)
        {
            // yes, so check if there is an active layer
            Layer * pLayer = pSpread->FindActiveLayer();

            // Get ptr's to the next and previous frame layers.
            Layer* pNextLayer = pLayer->FindNextFrameLayer();
            Layer* pPrevLayer = pLayer->FindPrevFrameLayer();

            // If there is an active layer and a previous/next layer then we are not greyed.
            if (pLayer && (pPrevLayer || pNextLayer) )
            {
                OpSt.Greyed = FALSE;
            }
            else
            {
                // No, so we are greyed
                OpSt.Greyed = TRUE;
            }
        }
        else
        {
            // No selected spread, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // We are in layer mode, so we are greyed.
        OpSt.Greyed = TRUE;
    }
#endif

    return OpSt;   
}

/********************************************************************************************

>   void OpDeleteFrame::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    23/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to create a new frame by copying the present one.
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpDeleteFrame::Do( OpDescriptor * pOpDesc )
{
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
PORTNOTE("other", "Disabled FrameSGallery")
#ifndef EXCLUDE_FROM_XARALX
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);
#endif
        // yes, so check that there is a presently active layer and try to delete it
        Layer * pLayer = pSpread->FindActiveLayer();
        if (pLayer)
        {
            OpLayerGalParam Param(FRAME_DELETE, pSpread);
            Param.pLayer = pLayer;
            DoWithParam(pOpDesc, (OpParam*)&Param);
        }
    }

    // End the operation, but we are calling DoWithParam() which we will assume does it for us.
    //End();

    return;
}

/********************************************************************************************
// End of OpDeleteFrame
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpFrameProperties
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpFrameProperties::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    29/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpFrameProperties operation
    Purpose:    For finding the OpFrameProperties's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpFrameProperties::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    //The frame movement controls on the GIF animation bar now work on frames only.
    OpState OpSt;  

#ifdef WEBSTER
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();
        // If there is an active layer and one following then we are not greyed
        if (pLayer)
        {
            // Yes, so we are allowed to move to the previous one
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }
#else
    
    BOOL FrameMode = FALSE; // Flag to determine the document mode.

    // Is there a selected spread?
    Spread* pSpread = Document::GetSelectedSpread();

    // Ensure a valid spread ptr.
    if(pSpread)
    {
        // Are there any frame layers?
        Layer* pFrameLayer = pSpread->FindFirstFrameLayer();    

        //If a frame layer exists, then this is an animation doc.
        if (pFrameLayer)
            FrameMode = TRUE;
    }
    
    if(FrameMode)
    {
        if (pSpread)
        {
            // yes, so check if there is an active layer
            Layer * pLayer = pSpread->FindActiveLayer();
            // If there is an active layer and one following then we are not greyed
            if (pLayer)
                // Yes, so we are allowed to move to the previous one
                OpSt.Greyed = FALSE;
            else
                // No, so we are greyed
                OpSt.Greyed = TRUE;
        }
        else
            // No selected spread, so we are greyed
            OpSt.Greyed = TRUE;
    }
    else
    {
        // The document is layer based, so we are greyed.
        OpSt.Greyed = TRUE;
    }
#endif
    
    return OpSt;   
}

/********************************************************************************************

>   void OpFrameProperties::Do(OpDescriptor * pOpDesc)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    29/4/97
    Inputs:     OpDescriptor (unused)
    Outputs:    -
    Returns:    -
    Purpose:    Tries to set some new animation properties.
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

void OpFrameProperties::Do( OpDescriptor * pOpDesc )
{
    // Just find the background layer and then ask our baseclass to delete it for us
    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
PORTNOTE("other", "Disabled FrameSGallery")
#ifndef EXCLUDE_FROM_XARALX
        // Check that all visible layers are actually frame layers
        FrameSGallery::EnsureFrameLayerIntegrity(pSpread);
#endif
        OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_GIFANIMPROPERTYTABS);

        if (pOpDesc != NULL)
        {
            // Select the "Frame properties tab".
            GIFAnimationPropertyTabsDlg::SetPageToOpen(GIFAnimationPropertyTabs::FramePropertiesTabNumber);

            String_256 Str;
            OpState State = pOpDesc->GetOpsState(&Str);
            if (!State.Greyed)
                pOpDesc->Invoke();
            else
            {
                GIFAnimationPropertyTabs * pTabHandler = GIFAnimationPropertyTabsDlg::GetGIFAnimationPropertiesTabs();
                if (pTabHandler)
                {
                    DialogTabOp* pDlg =  pTabHandler->GetTabbedDlg();
                    if (pDlg != NULL)
                        pDlg->Open();
                }
            }
        }
    }

    // End the operation
    End();

    return;
}

/********************************************************************************************
// End of OpFrameProperties
********************************************************************************************/

//------------------------------------------------------------------------------------------
// Methods for the OpAnimationProperties
//------------------------------------------------------------------------------------------

/********************************************************************************************

>   OpState OpAnimationProperties::GetState(String_256*, OpDescriptor*)

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    29/4/97
    Inputs:     Name of the OpDescriptor being queried
    Outputs:    The string to show to the user
    Returns:    The state of the OpAnimationProperties operation
    Purpose:    For finding the OpAnimationProperties's state. 
    Errors:     -
    SeeAlso:    -

********************************************************************************************/

OpState OpAnimationProperties::GetState(String_256 * pUIDescription, OpDescriptor * pOpDesc)
{
    //The frame movement controls on the GIF animation bar now work on frames only.
    OpState OpSt;  

#ifdef WBSTER
        // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();
    if (pSpread)
    {
        // yes, so check if there is an active layer
        Layer * pLayer = pSpread->FindActiveLayer();
        // If there is an active layer and one following then we are not greyed
        if (pLayer)
        {
            // Yes, so we are allowed to move to the previous one
            OpSt.Greyed = FALSE;
        }
        else
        {
            // No, so we are greyed
            OpSt.Greyed = TRUE;
        }
    }
    else
    {
        // No selected spread, so we are greyed
        OpSt.Greyed = TRUE;
    }   
#else
    
    BOOL FrameMode = FALSE;     // Flag to determine the document mode.

    // Is there a selected spread?
    Spread * pSpread = Document::GetSelectedSpread();

    // Ensure a valid spread ptr.
    if(pSpread)
    {
        // Are there any frame layers?
        Layer* pFrameLayer = pSpread->FindFirstFrameLayer();    

        //If a frame layer exists, then this is an animation doc.
        if (pFrameLayer)
            FrameMode = TRUE;
    }
    
    if(FrameMode)
    {
        if (pSpread)
        {
            // yes, so check if there is an active layer
            Layer * pLayer = pSpread->FindActiveLayer();

            // If there is an active layer and one following, then we are not greyed.
            if (pLayer)
            {
                // Yes, so we are allowed to move to the previous one