optsunit.h

Go to the documentation of this file.

// $Id: optsunit.h 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============================
 */
// Header for the handling code for the unit setup tab of the options dialog box 

#ifndef INC_OPTSUNITS
#define INC_OPTSUNITS

//#include "unittype.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "dialogop.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "units.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "appprefs.h"
#include "radio.h"

class ScaleUnit;
/********************************************************************************************

>   class UnitsTab: public OptionsTabs

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    07/12/94
    Purpose:    Allows the user to define the default units that are used for displaying size
                information, font size information and general display information.
                Also, alllows them to define their own units and edit the scaling factor
                applied to the spread, layer, or whatever.
                Based on the old UnitsDlg code.             
    SeeAlso:    UnitsDlg;
    SeeAlso:    OptionsTabs; AppPrefsDlg; DocPrefsDlg;

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

class UnitsTab: public OptionsTabs
{         
    CC_DECLARE_DYNCREATE( UnitsTab )  
public:
//WEBSTER-ranbirr-13/11/96
#ifndef WEBSTER

    UnitsTab();
    ~UnitsTab();

    virtual BOOL Init();                        

    // Function to handle the messages for this tab/pane window
    virtual BOOL HandleMsg(DialogMsg* Msg);

    // Function to set up the values on this tab when being opened
    virtual BOOL InitSection();

    // Function to commit the values on this tab on ok
    virtual BOOL CommitSection();

    // Functions to handle document changing messages
    virtual BOOL GreySection();         // Called when the user has closed all documents
    virtual BOOL UngreySection();       // Called when the user has opened a document
    BOOL ChangeControlStatus(const BOOL Status); // used to grey/ungrey all controls
    virtual BOOL UpdateSection(String_256 *DocumentName);   // Called when the user has switched to a new document

    virtual CDlgResID GetPageID();      // Return section/page id system

    virtual BOOL IsDocumentOption();    // Return True if document option  

    virtual BOOL IsProgramOption();     // Return True if program option
#endif //webster
    static  ScaleUnit*      GetColourUnitPreference();
//WEBSTER-ranbirr-13/11/96
#ifndef WEBSTER
protected:
    // Lots of controlling and handling functions specific to this section
    BOOL CommitDialogValues();

    BOOL SelectCurrentUserUnit();

    BOOL InitControls();
    BOOL InitUnitListControls();

    BOOL EnableControls();

    void SetUnitToken(CGadgetID ID,UnitType ThisUnitType,INT32 Index = -1,BOOL EndOfList=FALSE);
    void ShowUnitDetails(CGadgetID ID,UnitType ThisUnitType,INT32 Index = -1,BOOL EndOfList=FALSE);

    BOOL UpdateUnitListControls();

    BOOL CreateNewUnit();
    BOOL DeleteUnit();
    BOOL ShowUnitProperties();

// Colour Unit data members...  
    ScaleUnit*      m_pOldColourUnit;   // default colour unit on entry to dialog

    RadioGroup      m_ColourUnitRadioGroup;

private:
    DocUnitList* pDocUnitList;
    UnitType     CurrentUserUnitType;

    BOOL GreyStatus;            // Remember the state that we are currently in

    // Remember the entry default units states
    UnitType OldPageUnits;      // The units used to display page measurements
    //UnitType OldScaledUnits;  // The units to display scaled measurements
    UnitType OldFontUnits;      // The units to display font measurements
#endif //webster
}; 


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

>   class UnitPropertiesDlg: public DialogOp

    Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
    Created:    20/11/95
    Purpose:    Allows the user to define the properties of a user unit. This includes such 
                details as:-
                    the name
                    the abbreviation
                    what units it is based on
                    the scaling for the base unit to this unit
                    prefix or suffix unit

    SeeAlso:    UnitsDlg;
    SeeAlso:    OptionsTabs; AppPrefsDlg; UnitsTab

********************************************************************************************/
#define OPTOKEN_UNITPROPERTIESDLG _T("UnitPropertiesDlg")

class UnitPropertiesDlg : public DialogOp
{         
    CC_DECLARE_DYNCREATE( UnitPropertiesDlg )  
public:
    UnitPropertiesDlg();                    // constructor

    void DoWithParam(OpDescriptor*, OpParam* pOpParam); // "DoWithParam" function
    void Do(OpDescriptor*);                 // "Do" function

    static BOOL Init();                     // Setup function
    BOOL Create();                          // Create this dialog
    static OpState GetState(String_256*, OpDescriptor*);
                                            // Return the state of this operation
    virtual MsgResult Message(Msg* Message);
                                            // Message handler
    
    // Set up explicit details about this dialog box such as the id and type
    static CDlgResID IDD;                   // Dialog box id
    static const CDlgMode Mode;             // Dialog box mode of operation (mode or modeless)

public:
    static BOOL InvokeDialog(UnitType CurrentUserUnitType);

private:
    BOOL InitDialog();                      // Standard set up function
    BOOL CommitDialogValues();              // Standard commit function

    UnitType     CurrentUserUnitType;       // Current unit being edited
    DocUnitList* pDocUnitList;              // Pointer to the current document unit list
    BOOL* pIsOk;                            // Pointer to the return state BOOLean

    void SetUnitToken(CGadgetID ID,UnitType ThisUnitType,INT32 Index = -1,BOOL EndOfList=FALSE);
    BOOL DisplayUserUnitDetails();          // Show the details on the current user unit
}; 

#endif // INC_OPTSUNITS

---