bmpalctrl.h

Go to the documentation of this file.
00001 // $Id: bmpalctrl.h 751 2006-03-31 15:43:49Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 // Palette control for use in the export/create bitmap copy dialog
00099 
00100 #ifndef INC_BMPALCTRL
00101 #define INC_BMPALCTRL
00102 
00103 // Implementation notes:  The palette contol displays the palette in the
00104 // bitmap export dialog.  This palette has various sort options so the user
00105 // can view the palette in diffrent ways.  To avoid having to change the actual
00106 // bitmap when the user changes the sort type, this controls comunicates with
00107 // the actual palette throught an interface class, BitmapExportPaletteInterface,
00108 // which sits between the palette from the bitmap and the palette that this
00109 // control uses (throught the member variable m_Palette).  Because of this,
00110 // when the palette is comunicating with other parts of camelot, it must take
00111 // into account this sorting and provide indexs into the palette in terms that
00112 // the caller expects (ie sorted or non sorted).
00113 
00114 #include "bmpalint.h"
00115 
00116 class BitmapExportOptions;
00117 class BmapPrevDlg;
00118 
00119 /**************************************************************************************
00120 >   class BitmapExportPaletteControl : public CC_CLASS_MEMDUMP
00121     Author:     Jonathan_Payne (Xara Group Ltd) <camelotdev@xara.com>
00122     Created:    8/11/2000
00123     Purpose:    Wraps a palette control for use in the export/create bmp copy dialog
00124 **************************************************************************************/
00125 class BitmapExportPaletteControl : public CCObject
00126 {
00127     // Declare the class for memory tracking
00128     CC_DECLARE_MEMDUMP(BitmapExportPaletteControl);
00129 private:
00130     // Data members
00131     INT32           m_MouseOverCell;    // Cell that the mouse is over (highlighed cell), -1 means none
00132     INT32           m_SelectedCell;     // Cell that is selected, -1 means none
00133 
00134     BitmapExportPaletteInterface    m_Palette;
00135 
00136     CWindowID   m_WindowID;
00137 
00138     // Constants (that are set in the constuctor as they are DPI dpenedant)
00139     INT32 m_nPixelSize;
00140     INT32 m_nCellWidthPixels;
00141     INT32 m_nCellHeightPixels;
00142     INT32 m_nCellWidth;
00143     INT32 m_nCellHeight;
00144     INT32 m_nCellsPerLine;
00145 
00146     INT32 m_NumberOfColoursAtLastRedraw; // used so we know when to redraw the background
00147 
00148 public:
00149     // Constants
00150     enum {
00151         INVALID_COLOUR_VALUE    = -1 // A value that can never be a colour index
00152     };
00153 
00154     // Constructors / Destructors
00155     BitmapExportPaletteControl();
00156     ~BitmapExportPaletteControl();
00157     void Init(CWindowID wid) { m_WindowID = wid; };
00158 
00159     // Manipulators
00160     void SetCurrentSortType(BitmapExportPaletteInterface::PaletteSortType newSortType);
00161     void SetSelectedColourToggleLocked();
00162     void SetSelectedColourWebSafe();
00163     bool SetSelectedColourToggleTransparent();
00164     void SetSelectedColourToggleDeleted();
00165 
00166     // These functions set the selected/hightlighted cell based on an index into
00167     // the real palette (so 0 is the first colour in the bitmap's palette)
00168     bool SetSelectedCell(ReDrawInfoType *pInfo, INT32 paletteIndex);
00169     bool SetHighlightedCell(ReDrawInfoType *pInfo, INT32 paletteIndex);
00170 
00171     // Access functions
00172     BitmapExportPaletteInterface::PaletteSortType GetCurrentSortType();
00173     INT32 GetSelectedColour();                                  // Find out the palette index of the selected colour
00174     INT32 GetMouseOverColour();                                 // Find out the palette index of the selected colour
00175     bool GetSelectedColourLocked();
00176     bool GetSelectedColourWebSafe();
00177     bool GetSelectedColourTransparent();
00178     bool GetSelectedColourDeleted();
00179 
00180     // Message processing funtions
00181     void MsgMouseMove(ReDrawInfoType *pInfo);
00182     bool MsgMouseLeftButtonDown(ReDrawInfoType *pInfo);
00183     void MsgMouseRightButtonUp(ReDrawInfoType *pInfo, BmapPrevDlg *pBmapPrevDlg);
00184 
00185     // Actions
00186     void Render(ReDrawInfoType *pInfo);
00187     void RenderSoon();
00188     void RedrawSelectedCell(ReDrawInfoType *pInfo);
00189 
00190 private:
00191     INT32 GetCellFromPos(INT32 x, INT32 y);
00192     void RenderGrey(DocRect *pPaletteSize, RenderRegion *pRender);
00193     void RenderPalette(DocRect *pPaletteSize, RenderRegion *pRender, INT32 controlHeight, DocRect* pClipRect);
00194     void GetRectForCell(INT32 cell, DocRect *rect, INT32 controlHeight);
00195     void InvalidateCell(ReDrawInfoType *pInfo, INT32 paletteIndex);
00196     void DrawCell(DocRect *rect, DocColour colour, INT32 flags, RenderRegion *pRender,
00197                                                 bool webSafe, bool selected);
00198     bool IsColourWebSafe(BYTE r, BYTE g, BYTE b);
00199     void MakeColourWebSafe(BYTE *pColour);
00200 
00201     // These functions set the selected/hightlighted cell based on an index into
00202     // the sorted palette (so 0 is the top left cell)
00203     bool SetSelectedCellFromSortedIndex(ReDrawInfoType *pInfo, INT32 paletteIndex);
00204     bool SetHighlightedCellFromSortedIndex(ReDrawInfoType *pInfo, INT32 paletteIndex);
00205 };
00206 
00207 #endif  // INC_BMPALCTRL

Generated on Sat Nov 10 03:44:26 2007 for Camelot by  doxygen 1.4.4