property.h

Go to the documentation of this file.
00001 // $Id: property.h 1282 2006-06-09 09:46: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 // 
00099 // Header file for AppPrefs.cpp
00100 //
00101 // 
00102 
00103 #ifndef INC_PropertyTabsS
00104 #define INC_PropertyTabsS
00105 
00106 //#include "dialogop.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00107 //#include "unittype.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00108 //#include "units.h"        // units e.g. Millimeters - in camtypes.h [AUTOMATICALLY REMOVED]
00109 
00110 /********************************************************************************************
00111 
00112 >   class PropertyTabs : public ListItem
00113 
00114     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> 
00115     Created:    28/9/94
00116     Purpose:    These encompass some useful functionality which is required to get a property
00117                 dialog tab up and running. This is the baseclass and should always be derived
00118                 off from. Tabs currently available are:-
00119                     - layer properties dialog box
00120 
00121     SeeAlso:    LayerPropertyTabs
00122 
00123 ********************************************************************************************/
00124 
00125 class CCAPI PropertyTabs : public ListItem
00126 {
00127     CC_DECLARE_DYNAMIC(PropertyTabs);
00128 
00129 public:
00130     PropertyTabs();                         // Constructor
00131 
00132     virtual BOOL Init();                    // Initialisation
00133 
00134     // Function to declare a tab handling class to the property tabs system
00135 //  static BOOL DeclarePropertyTab(PropertyTabs *pProperty);
00136 //  static BOOL UndeclarePropertyTab(PropertyTabs *pProperty);
00137 //
00138 //  static PropertyTabs *GetFirst();
00139 //  static PropertyTabs *GetNext(PropertyTabs*);
00140 
00141     virtual BOOL SetUpDocUnits();                   // function to set up CurrentPageUnits
00142 
00143     static Document * pScopeDocument;               // current document (for message broadcasts) 
00144 
00145     virtual void SetCurrentDocAndSpread(Document *pDoc);    // set up the spread that we are currently workign on
00146     virtual void SetDefaultUnits();                         // set up our default display units
00147 
00148     //MsgResult HandleMessage(Msg* Message);
00149     virtual DialogTabOp * GetTabbedDlg()            = 0;    // return pointer to the main dialog box
00150 
00151     //virtual BOOL SetTabbedDlg(DialogTabOp * pDlg) = 0;    // return pointer to the main dialog box
00152 
00153     // Overridable by the tab section handlers. These are the must be specified functions
00154     // and so are pure.
00155     virtual CDlgResID GetPageID()                   = 0;    // Return section/page id system
00156     virtual BOOL InitSection()                      = 0;    // Called when page first opened
00157     virtual BOOL CommitSection()                    = 0;    // Called when ok action is required
00158     virtual BOOL HandleMsg(DialogMsg* Msg)          = 0;    // Called when messages arrive
00159 
00160     // Public access to the current layer.
00161     virtual void SetActiveLayer(Layer * pNewLayer);
00162     virtual Layer * GetActiveLayer();
00163 
00164     // Public access to the guide layer.
00165     virtual Layer * GetGuideLayer();
00166 
00167     // Public access to the current layer.
00168     virtual void SetCurrentLayer(Layer * pNewLayer);
00169     virtual Layer * GetCurrentLayer();
00170 
00171     // Some special handlers for things like new default units being specified or the last
00172     // document being closed.
00173     // These are the virtual handlers which each tab should specify, if not required then
00174     // these base class definitions can be used.
00175     virtual BOOL NewUnitsInSection();           // Called when new default units chosen
00176     virtual BOOL GreySection();                 // Called when the user has closed all documents
00177     virtual BOOL UngreySection();               // Called when the user has opened a document
00178     virtual BOOL UpdateSection();               // Called when the user has switched to a new document
00179 
00180     // Virtual functions used to indicate that details on the current spread and current layer need updating
00181     virtual BOOL UpdateSpreadSection();         // Called when the user has switched to a new spread
00182     virtual BOOL UpdateLayerSection();          // Called when the user has switched to a new layer
00183     virtual BOOL UpdateGuidelineSection();      // Called when the user has changed guidelines on the active layer
00184 
00185     // Colour list functions
00186     virtual BOOL ColourListChanged(Document* pDoc);
00187 
00188     // Some functions to determine whether this particular property tab is required.
00189     virtual BOOL IsPropertyRequired();          // Return True if required
00190 
00191 
00192     // Functions for getting the message and appply now state for this tabbed dialog box
00193     virtual BOOL GetApplyNowState()                     = 0;    // Get current state of ApplyNow flag
00194     virtual BOOL SetApplyNowState(BOOL NewState)        = 0;    // set new state for ApplyNow 
00195 
00196     virtual BOOL SetInitMessageState(BOOL NewState)     = 0;    // set new state of InitMessage
00197     virtual BOOL GetInitMessageState()                  = 0;    // get current state of InitMessage
00198 
00199     virtual BOOL GreyApplyNow();                        // grey the apply now button
00200     virtual BOOL UngreyApplyNow();                      // grey the apply now button
00201 
00202     virtual BOOL SetOkState(BOOL Val);                  // Set the state of the OK button on the tabbed dialog.
00203 
00204     Spread* GetSpread()                                 { return  pSpread; }
00205 
00206 protected:
00207     // Allow the options tabs access but nobody else to these useful variables
00208     static Document *pDocument;                 // The document we are working on
00209     static Spread   *pSpread;                   // The spread we are working on 
00210 
00211     static UnitType CurrentPageUnits;           // The units used to display page measurements
00212 
00213 private:
00214     static Layer    *pActiveLayer;              // The active layer we are working on 
00215     static Layer    *pCurrentLayer;             // pointer to the layer to be used,
00216 
00217     // The list of property tabs that is understood.
00218     //static List PropertyTabsList;     // list of available tab handlers
00219 };
00220 
00221 #endif  // INC_PropertyTabsS
00222 
00223 

Generated on Sat Nov 10 03:46:37 2007 for Camelot by  doxygen 1.4.4