wxCryst.h

/*  ObjCryst++ Object-Oriented Crystallographic Library
    (c) 2000-2002 Vincent Favre-Nicolin vincefn@users.sourceforge.net
        2000-2001 University of Geneva (Switzerland)
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
 
    This program is 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
/*
*  header file for the general wxCryst functions.
*
*
*/
 
#ifndef _VFN_WX_CRYST_H_
#define _VFN_WX_CRYST_H_
 
#include <string>
#include <iostream>
#include <set>
#include <map>
 
// wx headers, with or without precompilation
#include "wx/wxprec.h"
#ifdef __BORLANDC__
    #pragma hdrstop
#endif
#ifndef WX_PRECOMP
    #include "wx/wx.h"
#endif
 
#include "ObjCryst/CrystVector/CrystVector.h"
 
namespace ObjCryst
{
extern std::map<wxWindowID,std::pair<wxPoint,wxSize> > gvWindowPosition;
#if 1
class wxMultiChoiceDialog_ListBox:public wxDialog
{
  public:
    wxMultiChoiceDialog_ListBox(wxWindow* parent, const wxString& message, const wxString& caption,
                                int n, const wxString* choices);
    wxArrayInt GetSelections() const;
  private:
    wxListBox mListBox;
};
#endif
//
// Unique ID for menus incrementer
//
 
class WXCRYST_ID
{
   public:
      WXCRYST_ID();
      operator long();
   private:
      long mIndex;
      static long mCounter;
};
extern const long ID_WXOBJ_ENABLE; //These are used in ObjCryst/RefinableObj.cpp
extern const long ID_WXOBJ_DISABLE;// and defined in wxCryst/wxCryst.cpp
 
#undef VFN_CRYST_MUTEX
#ifdef VFN_CRYST_MUTEX
class CrystMutex:public wxMutex
{
   public:
      CrystMutex();
      ~CrystMutex();
      wxMutexError Lock();
      wxMutexError Unlock();
   private:
      unsigned long mNbLock;
};
#else
#define CrystMutex wxMutex
#endif
#ifndef DOXYGEN_SKIP_THIS
// constants that are shared between several classes must
// be defined here. Constants declared as "extern..." are
// not correctly used in EVT_MENU() macros etc..
enum
{
   ID_REFOBJ_MENU_OBJ=wxID_HIGHEST+1,
   ID_REFOBJ_MENU_OBJ_SAVE,
   ID_REFOBJ_MENU_OBJ_LOAD,
   ID_REFOBJ_MENU_PAR,
   ID_REFOBJ_MENU_PAR_FIXALL,
   ID_REFOBJ_MENU_PAR_UNFIXALL,
   ID_REFOBJ_MENU_PAR_RANDOMIZE,
   ID_CRYST_UPDATEUI,
   ID_WXOBJ_COLLAPSE,
   ID_WXOBJ_NAME,
   ID_WXFIELD
};
#endif
// Forward declaration
class WXCrystObjBasicList;
 
class WXCrystObjBasic: public wxWindow
{
   public:
      WXCrystObjBasic(wxWindow* parent);
      virtual ~WXCrystObjBasic();
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false)=0;
      virtual void UpdateUI(const bool mutexlock=false)=0;
      wxDEPRECATED(virtual void BottomLayout(WXCrystObjBasic *pChild));
      virtual void AddChild(WXCrystObjBasic *pChild, bool doBottomLayout=true);
      void AddedToList(WXCrystObjBasicList* list);
      void RemovedFromList(WXCrystObjBasicList* list);
      virtual bool Layout();
      virtual void SetToolTip(const wxString& tip);
   protected:
      WXCrystObjBasic *mWXCrystParent;
      bool mIsShown;
      bool mNeedUpdateUI;
      CrystMutex mMutex;
      std::set<WXCrystObjBasicList*> mvpList;
};
 
class WXCrystObjBasicList
{
   public:
      WXCrystObjBasicList();
      ~WXCrystObjBasicList();
      unsigned int GetNb()const;
      void Add(WXCrystObjBasic *);
      void Remove(WXCrystObjBasic *);
      bool Show(bool);
      void CrystUpdate(const bool updateUI=false,const bool mutexlock=false);
      void UpdateUI(const bool mutexlock=false);
      void Enable(bool enable);
   private:
      std::set<WXCrystObjBasic*> mvpWXCrystObj;
};
 
class WXFieldName;
 
class WXCrystObj: public WXCrystObjBasic
{
   public:
      WXCrystObj(wxWindow* parent,int orient=wxHORIZONTAL,bool showName=true);
      virtual ~WXCrystObj();
      void OnToggleCollapse(wxCommandEvent & WXUNUSED(event));
      virtual bool OnChangeName(const int id)=0;
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false);
      virtual void UpdateUI(const bool mutexlock=false);
      virtual void OnEnable(wxUpdateUIEvent &event);
      virtual bool Enable(bool enable);
      virtual void AddChild(WXCrystObjBasic *pChild, bool doBottomLayout=true);
   protected:
      wxBoxSizer *mpTopSizer;
      wxBoxSizer *mpSizer;
      WXFieldName *mpWXTitle;
      bool mIsExpanded;
      WXCrystObjBasicList mList;
      wxButton * mpCollapseButton;
   DECLARE_EVENT_TABLE()
};
 
class WXField: public WXCrystObjBasic
{
   public:
      WXField(wxWindow *parent,const string& label,const int field_id);
      void SetLabel(const string&);
      virtual void Revert()=0;
      virtual bool SetForegroundColour(const wxColour& colour);
      virtual void ValidateUserInput()=0;
      virtual void SetSize(int width, int height);
   protected:
      wxBoxSizer *mpSizer;
      wxStaticText *mpLabel;
      const int mId;
};
 
void WXCrystValidateAllUserInput();
 
class WXFieldString:public WXField
{
   public:
      WXFieldString(wxWindow *parent,string& st,const int field_id,
                  const int hsize=50, bool isEditable=true);
      void OnEnter(wxCommandEvent & event);
      void OnText(wxCommandEvent & WXUNUSED(event));
      void SetValue(const string&);
      const string GetValue() const;
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false);
      virtual void UpdateUI(const bool mutexlock=false);
      void Revert();
      virtual void ValidateUserInput();
      virtual void SetSize(int width, int height);
      virtual void SetToolTip(const wxString& tip);
   protected:
      string* mpString;
      string mValue;
      wxTextCtrl *mpField;
      string mValueOld;
      bool mIsSelfUpdating;
   DECLARE_EVENT_TABLE()
};
class WXFieldName:public WXField
{
   public:
      WXFieldName(wxWindow *parent,const string& label, WXCrystObj* owner,const int field_id,
                  const int hsize=50, bool isEditable=true);
      void OnEnter(wxCommandEvent & event);
      void OnText(wxCommandEvent & WXUNUSED(event));
      void SetValue(const string&);
      const string GetValue() const;
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false);
      virtual void UpdateUI(const bool mutexlock=false);
      void Revert();
      virtual void ValidateUserInput();
      virtual void SetSize(int width, int height);
      virtual void SetToolTip(const wxString& tip);
   protected:
      WXCrystObj* mpWXObj;
      string mValue;
      wxTextCtrl *mpField;
      string mValueOld;
      bool mIsSelfUpdating;
   DECLARE_EVENT_TABLE()
};
 
class WXFieldParBase:public WXField
{
   public:
      WXFieldParBase(wxWindow *parent,const string& label, const int field_id,
                     const int hsize=65);
      void OnEnter(wxCommandEvent & WXUNUSED(event));
      void OnText(wxCommandEvent & WXUNUSED(event));
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false)=0;
      virtual void Revert()=0;
      virtual void ValidateUserInput();
      virtual void SetToolTip(const wxString& tip);
      void SetFormat(const wxString &format);
   protected:
      virtual void ReadNewValue()=0;
      wxTextCtrl *mpField;
      bool mIsSelfUpdating;
      wxString mFormat;
   DECLARE_EVENT_TABLE()
};
 
template<class T>class WXFieldPar:public WXFieldParBase
{
   public:
      WXFieldPar(wxWindow *parent,const string& label, const int field_id,
                    T *par,const int hsize=65);
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false);
      virtual void UpdateUI(const bool mutexlock=false);
      virtual void Revert();
      void SetHumanValueScale(const T s);
   protected:
      virtual void ReadNewValue();
      T* mpValue;
      T mValue;
      T mValueOld;
      T mHumanScale;
};
 
class WXFieldChoice:public WXField
{
   public:
      WXFieldChoice(wxWindow *parent,const int field_id,
                            const string &name,const int hsize=80);
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false);
      virtual void UpdateUI(const bool mutexlock=false);
      void Revert();
      void SetValue(const string&);
      virtual void ValidateUserInput();
   protected:
      wxButton *mpButton;
};
 
class WXCrystMenuBar: public WXCrystObjBasic
{
   public:
      WXCrystMenuBar(wxWindow *parent, WXCrystObj* owner);
      void AddMenu(const string &name,const int menuId, const string& help="");
      wxMenu& GetMenu(const int menuId);
      void AddMenuItem(const int menuId, int id, const string& item, const string& help="",
                       const bool checkable= false);
      void AddMenuItem(const int menuId,int id, const wxString&  item,
                       wxMenu *subMenu, const wxString& helpString = _T(""));
      virtual void CrystUpdate(const bool updateUI=false,const bool mutexlock=false);
      virtual void UpdateUI(const bool mutexlock=false);
      void OnPopupMenu(wxCommandEvent & event);
      virtual void SetToolTip(const wxString& tip,long menu=0);
   protected:
      wxBoxSizer* mpSizer;
      std::map<long,pair<wxMenu *,wxButton*> > mvpMenu;
   DECLARE_EVENT_TABLE()
};
 
} //namespace
 
#endif //_VFN_WX_CRYST_H_