palmenu.cpp

Go to the documentation of this file.

// $Id: palmenu.cpp 1088 2006-05-16 16:56:32Z luke $
/* @@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============================
 */

#include "camtypes.h"
#include "palmenu.h"
//#include "bmpreres.h"
#include "bmpalctrl.h"
#include "bmapprev.h"

DECLARE_SOURCE("$Revision: 1088 $");

//  An implementation to match the declaration in the header file.
CC_IMPLEMENT_DYNCREATE(OpPalettePopupCommand, Operation)

//  Initialise the static variable.
BitmapExportPaletteControl *OpPalettePopupCommand::m_pPaletteControl = 0;
BmapPrevDlg *OpPalettePopupCommand::m_pBmapPrevDlg = 0;

//  This will get Camelot to display the filename and linenumber of any memory allocations
//  that are not released at program exit
#define new CAM_DEBUG_NEW


/******************************************************************************************
>   INT32 PaletteContextMenu :: Build()
    Author:     Alex_Price (Xara Group Ltd) <camelotdev@xara.com>
    Created:    09/08/99
    Inputs:     -
    Returns:    TRUE if everything went OK, and FALSE otherwise.
    Purpose:    This function builds the menu.
******************************************************************************************/
BOOL PaletteContextMenu::Build()
{
    //  Use this variable to hold the status of the menu build. If it goes FALSE, 
    //  then something went wrong.
    BOOL ok = TRUE;

    //  Add all the menu items, together with separators.
    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_LOCKED );
    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_WEB_SAFE );
    if( ok )
        ok = ok && BuildCommand( OPTOKEN_PALETTE_TRANSPARENT_BACKGROUND );
    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_TRANSPARENT, TRUE );


    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_RESTORE );
    if( ok )
        ok = ok && BuildCommand( OPTOKEN_PALETTE_DELETE, TRUE);

    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_SYSTEM_COLOURS, TRUE );

    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_SORT_BY_USE );
    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_SORT_BY_LUMINANCE );
    if( ok ) 
        ok = ok && BuildCommand( OPTOKEN_PALETTE_SORT_BY_HUE );

    return ok;
}

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

>   static BOOL OpPreviewPopupCommand::InitPolymorphicCommand( TCHAR *OpToken, UINT32 MenuTextID )
 
    Author:     Alex_Price (Xara Group Ltd) <camelotdev@xara.com>

    Created:    09/08/99

    Inputs:     OpToken - the token of a menu operation
                MenuTextID - the resource string of the menu command.

    Returns:    TRUE if everything went OK, and FALSE otherwise.

    Purpose:    This function registers a menu operation.

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

BOOL OpPalettePopupCommand::InitPolymorphicCommand( TCHAR *OpToken, UINT32 MenuTextID )
{
    return(RegisterOpDescriptor(0,                                  // Tool ID 
                                MenuTextID,                         // String resource ID
                                CC_RUNTIME_CLASS(OpPalettePopupCommand),// Runtime class
                                OpToken,                            // Token string
                                OpPalettePopupCommand::GetCommandState, // GetState function
                                0,                                  // help ID
                                0,                                  // bubble help
                                0,                                  // resource ID
                                0,                                  // control ID
                                SYSTEMBAR_ILLEGAL,                  // Bar ID
                                FALSE,                              // Receive system messages
                                FALSE,                              // Smart duplicate operation
                                TRUE,                               // Clean operation
                                NULL,                               // No vertical counterpart
                                0,                                  // String for one copy only error
                                DONT_GREY_WHEN_SELECT_INSIDE        // Auto state flags
                                ));
}


/******************************************************************************************
>   BOOL OpPalettePopupCommand::Init(BitmapExportPaletteControl *)
    Author:     Alex_Price (Xara Group Ltd) <camelotdev@xara.com>
    Created:    09/08/99
    Inputs:     -
    Returns:    TRUE if everything went OK, and FALSE otherwise.
    Purpose:    This function registers all the menu operations by calling InitPolymorphicCommand
******************************************************************************************/
BOOL OpPalettePopupCommand::Init(BitmapExportPaletteControl *pPaletteControl, BmapPrevDlg *pBmapPrevDlg)
{
    m_pPaletteControl   = pPaletteControl;
    m_pBmapPrevDlg      = pBmapPrevDlg;

    InitPolymorphicCommand( OPTOKEN_PALETTE_LOCKED,                 _R(IDS_MENU_LOCKED) );
    InitPolymorphicCommand( OPTOKEN_PALETTE_WEB_SAFE,               _R(IDS_MENU_WEB_SAFE) );
    InitPolymorphicCommand( OPTOKEN_PALETTE_TRANSPARENT_BACKGROUND, _R(IDS_MENU_TRANSPARENT_BACK) );
    InitPolymorphicCommand( OPTOKEN_PALETTE_TRANSPARENT,            _R(IDS_MENU_TRANSPARENT) );

    InitPolymorphicCommand( OPTOKEN_PALETTE_RESTORE,                _R(IDS_MENU_RESTORE) );
    InitPolymorphicCommand( OPTOKEN_PALETTE_DELETE,                 _R(IDS_MENU_DELETE) );

    InitPolymorphicCommand( OPTOKEN_PALETTE_SYSTEM_COLOURS,         _R(IDS_MENU_SYSTEM_COLOURS) );

    InitPolymorphicCommand( OPTOKEN_PALETTE_SORT_BY_USE,            _R(IDS_MENU_SORT_BY_USE) );
    InitPolymorphicCommand( OPTOKEN_PALETTE_SORT_BY_LUMINANCE,      _R(IDS_MENU_SORT_BY_LUMINANCE) );
    InitPolymorphicCommand( OPTOKEN_PALETTE_SORT_BY_HUE,            _R(IDS_MENU_SORT_BY_HUE) );

    return TRUE;
}               


/******************************************************************************************
>   OpState OpPalettePopupCommand::GetCommandState(String_256 *UIDescription, OpDescriptor *pOpDesc)
    Author:     Alex_Price (Xara Group Ltd) <camelotdev@xara.com>
    Created:    09/08/99
    Inputs:     UIDescription - ?
                pOpDesc - ?
    Returns:    The state of the OpPreviewPopupCommand operation for the given OpDescriptor
    Purpose:    Handles the putting of tick marks, and greying out of menu items in the menu.
******************************************************************************************/
OpState OpPalettePopupCommand::GetCommandState( String_256 *UIDescription, OpDescriptor *pOpDesc )
{
    OpState OpSt;
    OpSt.Greyed = FALSE;

    //  Get the properties of the colour under consideration
    BOOL bLocked                = m_pPaletteControl->GetSelectedColourLocked();
    BOOL bDeleted               = m_pPaletteControl->GetSelectedColourDeleted();
    BOOL bWebSafe               = m_pPaletteControl->GetSelectedColourWebSafe();
    BOOL bTransparentBackground = BmapPrevDlg::m_pExportOptions->IsBackgroundTransparent();
    BOOL bTransparent           = m_pPaletteControl->GetSelectedColourTransparent();
    BOOL bSupportsTransp        = BmapPrevDlg::m_pExportOptions->GetSupportsTransparency();

    //  Locked menu item
    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_LOCKED ) )
    {
        if (bDeleted)
            OpSt.Greyed = TRUE;
        else if (bLocked)
            OpSt.Ticked = TRUE;
    }

    //  WebSafe menu item
    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_WEB_SAFE ) )
    {
        if (bTransparent || bDeleted || bWebSafe)
            OpSt.Greyed = TRUE;
    }

    //  Background transparent menu item
    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_TRANSPARENT_BACKGROUND ) )
    {
        if (bDeleted || !bSupportsTransp)
            OpSt.Greyed = TRUE;
        else if (bTransparentBackground)
            OpSt.Ticked = TRUE;
    }

    //  Transparent menu item
    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_TRANSPARENT ) )
    {
        if (bDeleted || !bSupportsTransp)
            OpSt.Greyed = TRUE;
        else if (bTransparent)
            OpSt.Ticked = TRUE;
    }

    //  Delete menu item
    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_DELETE ) )
    {
        if(bDeleted)
            OpSt.RemoveFromMenu = TRUE;
    }

    //  Restore menu item
    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_RESTORE ) )
    {
        if(!bDeleted)
            OpSt.RemoveFromMenu = TRUE;
    }

    //  The 'Sort by...' menu items.
    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_SORT_BY_USE ) )
        if (m_pPaletteControl->GetCurrentSortType() == BitmapExportPaletteInterface::SORT_USE)
            OpSt.Ticked = TRUE;

    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_SORT_BY_LUMINANCE ) )
        if (m_pPaletteControl->GetCurrentSortType() == BitmapExportPaletteInterface::SORT_LUMINANCE)
            OpSt.Ticked = TRUE;

    if( pOpDesc->Token == String_256( OPTOKEN_PALETTE_SORT_BY_HUE ) )
        if (m_pPaletteControl->GetCurrentSortType() == BitmapExportPaletteInterface::SORT_HUE)
            OpSt.Ticked = TRUE;

    //  Tick it if the 'System Colours' button is pressed in
//  if( ( pOpDesc->Token == String_256( OPTOKEN_PALETTE_SYSTEM_COLOURS ) ))
//      if (BmapPrevDlg::IsU
//              ( m_pDialog->IsSystemColours() ) )
//          OpSt.Ticked = TRUE;

    return OpSt; 
}


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

>   virtual void OpPreviewPopupCommand::Do( OpDescriptor* pOpDesc )
 
    Author:     Alex_Price (Xara Group Ltd) <camelotdev@xara.com>

    Created:    09/08/99

    Inputs:     pOpDesc - ?

    Returns:    -

    Purpose:    Handles the menu selection

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

void OpPalettePopupCommand::Do( OpDescriptor* pOpDesc )
{  
    ERROR3IF(!m_pPaletteControl,    "Help, I am the palette right click menu and I can't talk to the palette");
    ERROR3IF(!m_pBmapPrevDlg,       "Help, I am the palette right click menu and I can't talk to the preview dialog");

    //  Get the token of the item selected by the user.
    String_256 s(pOpDesc->Token);


    if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_LOCKED))
         m_pPaletteControl->SetSelectedColourToggleLocked();
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_WEB_SAFE))
        m_pPaletteControl->SetSelectedColourWebSafe();
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_TRANSPARENT_BACKGROUND))
    {
        BmapPrevDlg::m_pExportOptions->SetBackgroundTransparency(!BmapPrevDlg::m_pExportOptions->IsBackgroundTransparent());
        m_pBmapPrevDlg->DoPreview();
    }
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_TRANSPARENT))
        m_pPaletteControl->SetSelectedColourToggleTransparent();
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_DELETE))
        m_pPaletteControl->SetSelectedColourToggleDeleted();
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_RESTORE))
        m_pPaletteControl->SetSelectedColourToggleDeleted();
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_SYSTEM_COLOURS))
        BmapPrevDlg::m_pExportOptions->SetToUseSystemPalette(!BmapPrevDlg::m_pExportOptions->IsUsingSystemPalette());
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_SORT_BY_USE))
    {
        m_pPaletteControl->SetCurrentSortType(BitmapExportPaletteInterface::SORT_USE);
        m_pPaletteControl->RenderSoon();
    }
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_SORT_BY_LUMINANCE))
    {
        m_pPaletteControl->SetCurrentSortType(BitmapExportPaletteInterface::SORT_LUMINANCE);
        m_pPaletteControl->RenderSoon();
    }
    else if (s.IsIdentical((TCHAR *)OPTOKEN_PALETTE_SORT_BY_HUE))
    {
        m_pPaletteControl->SetCurrentSortType(BitmapExportPaletteInterface::SORT_HUE);
        m_pPaletteControl->RenderSoon();
    }

    BmapPrevDlg::m_pExportOptions->InvalidatePalette();
    m_pBmapPrevDlg->UpdateCurrentTab();
    m_pBmapPrevDlg->DoPreview();

    End();
}

---