Deprecated Functions
********************

The functions detailed in this section have been deprecated. They are still
available for use, but are scheduled to be removed from the API in a future
version. Most of these functions have been deprecated in order to create a
more consistently named API, but some have been deprecated as the 
functionality they provided is no longer available, obsolete, or unnecessary. 
If an alternate function is available, it will be referenced in the documentation
below.

.. oe:function:: ContourCurrentGridGet


   .. oe:api::


      unsigned int ContourCurrentGridGet()

   This function has been deprecated.

.. oe:function:: ContourCurrentGridSet


   .. oe:api::


      unsigned int ContourCurrentGridSet(unsigned int id)

   This function has been deprecated.

.. oe:function:: CreateAngleMonitor


   .. oe:api::


      unsigned int CreateAngleMonitor(const OEPropDB::OEKey &k1, 
                                      const OEPropDB::OEKey &k2, 
                                      const OEPropDB::OEKey &k3)
  
   This function has been deprecated. Please use 
   :ref:`MonitorAngleCreate <vida_MonitorAngleCreate>` instead.

.. oe:function:: CreateDistanceMonitor


   .. oe:api::


      unsigned int CreateDistanceMonitor(const OEPropDB::OEKey &k1, 
                                         const OEPropDB::OEKey &k2)

   This function has been deprecated. Please use 
   :oe:func:`MonitorDistanceCreate` instead.

.. oe:function:: CreateSphereMonitor


   .. oe:api::


      unsigned int CreateSphereMonitor(const OEPropDB::OEKey &k, 
                                       const std::string &name, 
                                       const OESystem::OEColor &c, float rad=0.0f)
      unsigned int CreateSphereMonitor(const OEPropDB::OEKey &k, 
                                       const std::string &name, float x, float y, 
                                       float z, float rad, const OESystem::OEColor &c)

   This function has been deprecated. Please use 
   :oe:func:`MonitorSphereCreate` instead.

.. oe:function:: CreateTorsionMonitor


   .. oe:api::


      unsigned int CreateTorsionMonitor(const OEPropDB::OEKey &k1, 
                                        const OEPropDB::OEKey &k2, 
                                        const OEPropDB::OEKey &k3, 
                                        const OEPropDB::OEKey &k4)

   This function has been deprecated. Please use 
   :oe:func:`MonitorTorsionCreate` instead.

.. oe:function:: CustomViewDocking
   :project: VIDA

   .. oe:api::


      void CustomViewDocking()
      void CustomViewDocking(const std::string &protein, const std::string &reference, 
                             const std::string &results="")
      void CustomViewDocking(const std::string &protein, const std::string &reference, 
                             const std::string &results, bool showRibbons, 
                             bool showLabels, bool showHBonds, bool showSurface, 
                             float residueWithin, float surfaceWithin, 
                             const std::string &surfaceColor)

   This function has been deprecated. Please use 
   :oe:func:`CustomViewFRED` instead.

.. oe:function:: DatatableCurrent


   .. oe:api::


      std::string DatatableCurrent()

   This function has been deprecated. Please use 
   :oe:func:`DatatableCurrentGet` instead.

.. oe:function:: DeleteAngleMonitor


   .. oe:api::


      void DeleteAngleMonitor(const OEPropDB::OEKey &k1, const OEPropDB::OEKey &k2, 
                              const OEPropDB::OEKey &k3)

   This function has been deprecated. Please use 
   :oe:func:`MonitorAngleDelete` instead.


.. oe:function:: DeleteDistanceMonitor


   .. oe:api::


      void DeleteDistanceMonitor(const OEPropDB::OEKey &k1, 
                                 const OEPropDB::OEKey &k2)

   This function has been deprecated. Please use 
   :oe:func:`MonitorDistanceDelete` instead.

.. oe:function:: DeleteTorsionMonitor


   .. oe:api::


      void DeleteTorsionMonitor(const OEPropDB::OEKey &k1, const OEPropDB::OEKey &k2, 
                                const OEPropDB::OEKey &k3, const OEPropDB::OEKey &k4)

   This function has been deprecated. Please use 
   :oe:func:`MonitorTorsionDelete` instead.

.. oe:function:: DeleteVisibleMonitors


   .. oe:api::


      void DeleteVisibleMonitors()
      
   This function has been deprecated. Please use 
   :oe:func:`MonitorsVisibleDelete` instead.     

.. oe:function:: ExistsAngleMonitor


   .. oe:api::


      unsigned int ExistsAngleMonitor(const OEPropDB::OEKey &k1, 
                                      const OEPropDB::OEKey &k2, 
                                      const OEPropDB::OEKey &k3)

   This function has been deprecated. Please use 
   :oe:func:`MonitorAngleExists` instead.     

.. oe:function:: ExistsDistanceMonitor


   .. oe:api::


      unsigned int ExistsDistanceMonitor(const OEPropDB::OEKey &k1, 
                                         const OEPropDB::OEKey &k2)

   This function has been deprecated. Please use 
   :oe:func:`MonitorDistanceExists` instead.     

.. oe:function:: ExistsTorsionMonitor


   .. oe:api::


      unsigned int ExistsTorsionMonitor(const OEPropDB::OEKey &k1, 
                                        const OEPropDB::OEKey &k2, 
                                        const OEPropDB::OEKey &k3, 
                                        const OEPropDB::OEKey &k4)

   This function has been deprecated. Please use 
   :oe:func:`MonitorTorsionExists` instead.

.. oe:function:: GetAtomsByScope


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetAtomsByScope(unsigned int scope)

   This function has been deprecated. Please use 
   :oe:func:`GetAtomsScoped` instead.

.. oe:function:: GetBondsByScope


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetBondsByScope(unsigned int scope)

   This function has been deprecated. Please use 
   :oe:func:`GetBondsScoped` instead.

.. oe:function:: GetContoursByScope


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetContoursByScope(unsigned int scope)

   This function has been deprecated. Please use 
   :oe:func:`GetContoursScoped` instead.

.. oe:function:: GetGridsByScope


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetGridsByScope(unsigned int scope)

   This function has been deprecated. Please use 
   :oe:func:`GetGridsScoped` instead.

.. oe:function:: GetKey


   .. oe:api::


      OEPropDB::OEKey GetKey(const OESystem::OEBase &base)
      OEPropDB::OEKey GetKey(const OESystem::OEBase &base, 
                             const OEPropDB::OEKey &parentKey)


   This function has been deprecated. Please use 
   :oe:func:`KeyGet` instead.

.. oe:function:: GetKeyType


   .. oe:api::


      std::string GetKeyType(const OEPropDB::OEKey &key)

   This function has been deprecated. Please use 
   :oe:func:`KeyTypeGet` instead.

.. oe:function:: GetKeysByScope


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetKeysByScope(unsigned int scope, 
                                                  unsigned int type)

   This function has been deprecated. Please use 
   :oe:func:`GetScoped` instead.

.. oe:function:: GetKeysForID


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetKeysForID(unsigned int id)

   This function has been deprecated. Please use 
   :oe:func:`KeysGet` instead.

.. oe:function:: GetMoleculesByScope


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetMoleculesByScope(unsigned int scope)

   This function has been deprecated. Please use 
   :oe:func:`GetMoleculesScoped` instead.

.. oe:function:: GetName


   .. oe:api::


      std::string GetName(const OEPropDB::OEKey &key)

   This function has been deprecated. Please use 
   :oe:func:`NameGet` instead.

.. oe:function:: GetPropertyType


   .. oe:api::


      unsigned int GetPropertyType(const std::string &type)

   This function has been deprecated. Please use 
   :oe:func:`PropertyTypeGet` instead.

.. oe:function:: GetSurfacesByScope


   .. oe:api::


      std::vector<OEPropDB::OEKey> GetSurfacesByScope(unsigned int scope)

   This function has been deprecated. Please use 
   :oe:func:`GetSurfacesScoped` instead.

.. oe:function:: GotoStylePage


   .. oe:api::


      void GotoStylePage(const std::string &page)

   This function has been deprecated.

.. oe:function:: InitializeObject


   .. oe:api::


      void InitializeObject(unsigned int id)

   This function has been deprecated. Please use 
   :oe:func:`Initialize` instead.

.. oe:function:: InterpreterInteractiveGet


   .. oe:api::


      bool InterpreterInteractiveGet()

   This function has been deprecated.

.. oe:function:: InterpreterInteractiveSet


   .. oe:api::


      void InterpreterInteractiveSet(bool interactive)

   This function has been deprecated.

.. oe:function:: MarkObjectsByScope


   .. oe:api::


      bool MarkObjectsByScope(unsigned int scope)

   This function has been deprecated. Please use 
   :oe:func:`MarkScoped` instead.

.. oe:function:: MarkState


   .. oe:api::


      int MarkState()
      
   This function has been deprecated. Please use 
   :oe:func:`StateMark` instead.     

.. oe:function:: MenuAddLabel


   .. oe:api::


      std::string MenuAddLabel(const std::string &menu, const std::string &name, 
                               bool last)

   This function has been deprecated. 

.. oe:function:: MenuUseTearoffsGet


   .. oe:api::


      bool MenuUseTearoffsGet()

   This function has been deprecated. 
  
.. oe:function:: MenuUseTearoffsSet


   .. oe:api::


      bool MenuUseTearoffsSet(bool b)

   This function has been deprecated. 
  
.. oe:function:: OEGetKey


   .. oe:api::


      OEPropDB::OEKey OEGetKey(const OESystem::OEBase &b)
      OEPropDB::OEKey OEGetKey(const OESystem::OEBase &b, const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`KeyGet` instead.

.. oe:function:: OEKeyToID


   .. oe:api::


      unsigned int OEKeyToID(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`KeyIDGet` instead.

.. oe:function:: OEKeyToLabelString


   .. oe:api::


      std::string OEKeyToLabelString(const OEPropDB::OEKey &k, bool full=false, 
                                     bool coords=true)

   This function has been deprecated. Please use 
   :oe:func:`LabelGet` instead.

.. oe:function:: OEKeyToParentID


   .. oe:api::


      unsigned int OEKeyToParentID(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`KeyParentIDGet` instead.

.. oe:function:: OEKeyToSourceID


   .. oe:api::


      unsigned int OEKeyToSourceID(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`KeySourceIDGet` instead.

.. oe:function:: OEPyClearActive


   .. oe:api::


      void OEPyClearActive()

   This function has been deprecated. Please use 
   :oe:func:`ClearActive` instead.

.. oe:function:: OEPyClearLocked


   .. oe:api::


      void OEPyClearLocked()

   This function has been deprecated. Please use 
   :oe:func:`ClearLocked` instead.

.. oe:function:: OEPyClearMarked


   .. oe:api::


      void OEPyClearMarked()

   This function has been deprecated. Please use 
   :oe:func:`ClearMarked` instead.

.. oe:function:: OEPyClearSelected


   .. oe:api::


      void OEPyClearSelected()

   This function has been deprecated. Please use 
   ClearSelected instead.

.. oe:function:: OEPyClearVisible


   .. oe:api::


      void OEPyClearVisible()

   This function has been deprecated. Please use 
   :oe:func:`ClearVisible` instead.

.. oe:function:: OEPyGetActive


   .. oe:api::


      OEPropDB::OEKey OEPyGetActive()

   This function has been deprecated. Please use 
   :oe:func:`ActiveKey` instead.

.. oe:function:: OEPyGetIDForKey


   .. oe:api::


      unsigned int OEPyGetIDForKey(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`KeyIDGet` instead.

.. oe:function:: OEPyGetSelectedAtoms


   .. oe:api::


      std::vector<OEPropDB::OEKey> OEPyGetSelectedAtoms()

   This function has been deprecated. Please use 
   :oe:func:`GetSelectedAtoms` instead.

.. oe:function:: OEPyHide


   .. oe:api::


      bool OEPyHide(unsigned int scope, bool value)

   This function has been deprecated. Please use 
   :oe:func:`HideScoped` instead.

.. oe:function:: OEPyHideNone


   .. oe:api::


      bool OEPyHideNone(unsigned int scope)

   This function has been deprecated. Please use 
   HideNonScoped instead.

.. oe:function:: OEPyHideOthers


   .. oe:api::


      bool OEPyHideOthers(const std::vector<OEPropDB::OEKey> &keys, bool hide)

   This function has been deprecated. Please use 
   :oe:func:`HideOthers` instead.

.. oe:function:: OEPyIsActive


   .. oe:api::


      bool OEPyIsActive(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`IsActive` instead.

.. oe:function:: OEPyIsLocked


   .. oe:api::


      bool OEPyIsLocked(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`IsLocked` instead.

.. oe:function:: OEPyIsMarked


   .. oe:api::


      bool OEPyIsMarked(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`IsMarked` instead.

.. oe:function:: OEPyIsSelected


   .. oe:api::


      bool OEPyIsSelected(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`IsSelected` instead.

.. oe:function:: OEPyIsTrulyVisible


   .. oe:api::


      bool OEPyIsTrulyVisible(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`IsTrulyVisible` instead.

.. oe:function:: OEPyIsVisible


   .. oe:api::


      bool OEPyIsVisible(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`IsVisible` instead.

.. oe:function:: OEPySetActive


   .. oe:api::


      bool OEPySetActive(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`Active` instead.

.. oe:function:: OEPySetLocked


   .. oe:api::


      bool OEPySetLocked(const OEPropDB::OEKey &k, bool state)
      bool OEPySetLocked(const std::vector<OEPropDB::OEKey> &keys, bool state)

   This function has been deprecated. Please use 
   :oe:func:`Lock` instead.

.. oe:function:: OEPySetMarked


   .. oe:api::


      bool OEPySetMarked(const OEPropDB::OEKey &k, bool state)
      bool OEPySetMarked(const std::vector<OEPropDB::OEKey> &keys, bool state)

   This function has been deprecated. Please use 
   :oe:func:`Mark` instead.

.. oe:function:: OEPySetSelected


   .. oe:api::


      bool OEPySetSelected(const OEPropDB::OEKey &k, bool state)
      bool OEPySetSelected(const std::vector<OEPropDB::OEKey> &keys, bool state)

   This function has been deprecated. Please use 
   :oe:func:`Select` instead.

.. oe:function:: OEPySetVisible


   .. oe:api::


      bool OEPySetVisible(const OEPropDB::OEKey &k, bool state)
      bool OEPySetVisible(const std::vector<OEPropDB::OEKey> &keys, bool state)

   This function has been deprecated. Please use 
   :oe:func:`Visible` instead.

.. oe:function:: ObjectNameGet


   .. oe:api::


      std::string ObjectNameGet(unsigned int id)
      std::string ObjectNameGet(const OEPropDB::OEKey &k)

   This function has been deprecated. Please use 
   :oe:func:`NameGet` instead.

.. oe:function:: ObjectNameSet


   .. oe:api::


      void ObjectNameSet(unsigned int id, const std::string &name)
      void ObjectNameSet(const OEPropDB::OEKey &k, const std::string &name)

   This function has been deprecated. Please use 
   :oe:func:`NameSet` instead.

.. oe:function:: ObservableOEKey


   .. oe:api::


      OEGUI::OEObservableBase<OEPropDB::OEKey> &
        ObservableOEKey(const std::string &name, bool create=false)

   This function has been deprecated. Please use 
   :oe:func:`ObservableKey` instead.

.. oe:function:: PopState


   .. oe:api::


      int PopState(bool load=true)

   This function has been deprecated. Please use 
   :oe:func:`StatePop` instead.

.. oe:function:: PopupAddLabel


   .. oe:api::


      std::string PopupAddLabel(const std::string &label, bool once=false)

   This function has been deprecated. 

.. oe:function:: ResponseVectMulti


   .. oe:api::


      void ResponseVectMulti(const std::string &s, 
                             const std::vector<OEInterpreter::OEMultiTypeVar> &var, 
                             bool b=false)

   This function has been deprecated. Please use 
   :oe:func:`PromptResponseVectMulti` instead.

.. oe:function:: SDataGet


   .. oe:api::


      std::string SDataGet(unsigned int id, const std::string &tag)
      std::string SDataGet(const OEPropDB::OEKey &k, const std::string &tag)

   This function has been deprecated. Please use 
   :oe:func:`SDDataGet` instead.

.. oe:function:: SDataHas


   .. oe:api::


      bool SDataHas(unsigned int id, const std::string &tag)
      bool SDataHas(const OEPropDB::OEKey &k, const std::string &tag)

   This function has been deprecated. Please use 
   :oe:func:`SDDataHas` instead.

.. oe:function:: SDataSet


   .. oe:api::


      void SDataSet(unsigned int id, const std::string &tag, const std::string &v)
      void SDataSet(const OEPropDB::OEKey &k, const std::string &tag, 
                    const std::string &v)

   This function has been deprecated. Please use 
   :oe:func:`SDDataSet` instead.

.. oe:function:: ScratchList


   .. oe:api::


      std::vector<OEPropDB::OEKey> ScratchList()

   This function has been deprecated. Please use 
   :oe:func:`ScratchGet` instead.

.. oe:function:: SpreadsheetCurrent


   .. oe:api::


      std::string SpreadsheetCurrent()

   This function has been deprecated, please use 
   :oe:func:`SpreadsheetCurrentGet` instead.

.. oe:function:: SpreadsheetDisableUpdates


   .. oe:api::


      void SpreadsheetDisableUpdates(const std::string &spreadsheet)

   This function has been deprecated.

.. oe:function:: SpreadsheetEnableUpdates


   .. oe:api::


      void SpreadsheetEnableUpdates(const std::string &spreadsheet)

   This function has been deprecated.

.. oe:function:: SpreadsheetMarkHighlighted


   .. oe:api::


      void SpreadsheetMarkHighlighted(const std::string &spreadsheet, bool marked)

   This function has been deprecated.

.. oe:function:: SpreadsheetUpdateContents


   .. oe:api::


      void SpreadsheetUpdateContents(const std::string &spreadsheet)

   This function has been deprecated.

.. oe:function:: SurfacePotentialColorAuto


   .. oe:api::


      void SurfacePotentialColorAuto()

   This function has been deprecated.

.. oe:function:: SurfacePotentialColorValuesSet


   .. oe:api::


      void SurfacePotentialColorValuesSet(float min, float mid, float max)

   This function has been deprecated.

.. oe:function:: VFCopyFile


   .. oe:api::


      bool VFCopyFile(const std::string &src, const std::string &dst)

   This function has been deprecated. 
  
.. oe:function:: VFGetMol


   .. oe:api::


      bool VFGetMol(OEChem::OEMCMolBase &m, unsigned int id)
      bool VFGetMol(OEChem::OEMCMolBase &m, const OEPropDB::OEKey &key)

   This function has been deprecated. Please use 
   :oe:func:`MoleculeGet` instead.

