visiattr.h

Go to the documentation of this file.
00001 // $Id: visiattr.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 
00099 #ifndef INC_VISIATTR
00100 #define INC_VISIATTR
00101 
00102 class NodeAttribute;
00103 /**************************************************************************************
00104 
00105 >   class VisibleAttribute : public VisibleListItem
00106 
00107     Author:     Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>
00108     Created:    15/10/96
00109 
00110     Purpose:    Provides a user editable attribute (of sorts)
00111 
00112 **************************************************************************************/
00113 class VisibleAttribute : public UserInterface
00114 {
00115     CC_DECLARE_MEMDUMP(VisibleAttribute)
00116 public:
00117     virtual BOOL Interact(DialogOp& Dialog)         {   return TRUE;    }   // should be in UserInterface
00118     virtual StringBase& GetText(StringBase& Description) const = 0;
00119     virtual NodeAttribute*  CreateNewAttribute() = 0;
00120 
00121     BOOL IsNew() const          {   return m_IsNew;     }
00122     void MarkAsUsed()           {   m_IsNew = FALSE;    }
00123 
00124 protected:
00125     VisibleAttribute() : m_IsNew(TRUE)  {}
00126 
00127 private:
00128     BOOL                m_IsNew;
00129 };
00130 
00131 
00132 /**************************************************************************************
00133 
00134 >   class VisibleUserAttribute : public VisibleAttribute
00135 
00136     Author:     Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>
00137     Created:    15/10/96
00138 
00139     Purpose:    Provides a user editable user attribute
00140 
00141 **************************************************************************************/
00142 class VisibleUserAttribute : public VisibleAttribute
00143 {
00144     CC_DECLARE_MEMDUMP(VisibleUserAttribute)
00145 public:
00146     VisibleUserAttribute(const StringBase& Key, const StringBase& Value);
00147 
00148 //  Pure implementations
00149     virtual BOOL Display(DialogOp& Dialog);
00150     virtual BOOL Interact(DialogOp& Dialog);
00151     virtual void Hide();
00152     virtual StringBase& GetText(StringBase& Description) const;
00153 
00154 
00155 // Data Member Access
00156     void SetLongKey(const StringBase& NewKey);
00157     void SetValue(const StringBase& NewValue)           {   m_Value = NewValue; }
00158 
00159     const StringBase& GetKey();
00160     const StringBase& GetLongKey();
00161     const StringBase& GetValue();
00162 
00163     virtual NodeAttribute*  CreateNewAttribute();
00164 
00165 private:
00166     String_64           m_Key;
00167     EditableText        m_LongKey;
00168     EditableText        m_Value;
00169 };
00170 
00171 
00172 class WizOp;
00173 /**************************************************************************************
00174 
00175 >   class VisibleTemplateAttribute : public VisibleUserAttribute
00176 
00177     Author:     Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>
00178     Created:    15/10/96
00179 
00180     Purpose:    Provides a user editable template attribute
00181 
00182 **************************************************************************************/
00183 class VisibleTemplateAttribute : public VisibleUserAttribute
00184 {
00185     CC_DECLARE_MEMDUMP(VisibleTemplateAttribute)
00186 public:
00187     VisibleTemplateAttribute(   const WizOp& Handler,
00188                                 const StringBase& Question = NullString, 
00189                                 const StringBase& Param = NullString);
00190 
00191     virtual StringBase& GetText(StringBase& Description) const;
00192     virtual BOOL Display(DialogOp& Dialog);
00193     virtual BOOL Interact(DialogOp& Dialog);
00194     virtual void Hide();
00195 
00196     virtual NodeAttribute*  CreateNewAttribute();
00197 
00198 protected:
00199 // Data Member Access
00200     const WizOp&    GetWizOp();
00201     VisibleLabel&   GetParamHint();
00202     void            SetParamHint(const StringBase& HintToShow);
00203     
00204 private:
00205     const WizOp&    m_Handler;
00206     VisibleLabel    m_ParamHint;
00207 };
00208 
00209 class WizOpStyle;
00210 /**************************************************************************************
00211 
00212 >   class VisibleStyleReference : public VisibleAttribute
00213 
00214     Author:     Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>
00215     Created:    15/10/96
00216 
00217     Purpose:    Provides a user editable style reference
00218 
00219 **************************************************************************************/
00220 class VisibleStyleReference : public VisibleAttribute
00221 {
00222     CC_DECLARE_MEMDUMP(VisibleStyleReference)
00223 
00224 public:
00225     VisibleStyleReference(const WizOpStyle& Style);
00226 
00227 
00228     virtual BOOL Display(DialogOp& Dialog);
00229     virtual BOOL Interact(DialogOp& Dialog);
00230     virtual void Hide();
00231 
00232     virtual StringBase& GetText(StringBase& Description) const;
00233     virtual NodeAttribute*  CreateNewAttribute();
00234 
00235     VisibleLabel&   GetParamHintLabel();
00236     void            SetParamHintString(const StringBase& HintToShow);
00237 
00238     EditableText&   GetParamText();
00239     void            SetParamText(const StringBase& ParamToShow);
00240 
00241     const WizOpStyle&   GetStyle();
00242 
00243 private:
00244     const WizOpStyle&   m_Style;
00245     EditableText        m_Question;
00246     VisibleLabel        m_ParamHintLabel;
00247     EditableText        m_Param;
00248 };
00249 
00250 
00251 
00252 #endif // INC_VISIATTR

Generated on Sat Nov 10 03:47:21 2007 for Camelot by  doxygen 1.4.4