0022048: Visualization, AIS_InteractiveContext - single object selection should alway...

[occt.git] / src / TDocStd / TDocStd_XLinkTool.hxx

// Created on: 1998-05-12
// Created by: Isabelle GRIGNON
// Copyright (c) 1998-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _TDocStd_XLinkTool_HeaderFile
#define _TDocStd_XLinkTool_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <Standard_Boolean.hxx>
class TDF_DataSet;
class TDF_RelocationTable;
class TDF_Label;


//! This  tool class  is  used to copy  the content of
//! source label   under  target label.   Only child
//! labels and  attributes   of  source are   copied.
//! attributes located   out of source  scope are  not
//! copied by this algorithm.
//! Depending  of   the called  method  an   external
//! reference is set  in  the the target  document  to
//! registred the externallink.
//! Provide services to set, update and perform
//! external references.
//! Warning1: Nothing is provided in this class  about the
//! opportunity to copy, set a link or  update  it.
//! Such decisions must be under application control.
//! Warning2: If the document manages shapes, use after copy
//! TNaming::ChangeShapes(target,M) to make copy of
//! shapes.
class TDocStd_XLinkTool 
{
public:

  DEFINE_STANDARD_ALLOC

  
  Standard_EXPORT TDocStd_XLinkTool();
  
  //! Copies the content of the label <fromsource> to the label <intarget>.
  //! The link is registred with an XLink attribute by <intarget>
  //! label.  if  the    content  of <fromsource>   is  not
  //! self-contained,  and/or <intarget> has already an XLink
  //! attribute, an exception is raised.
  Standard_EXPORT void CopyWithLink (const TDF_Label& intarget, const TDF_Label& fromsource);
  
  //! Update the external reference set   at <L>.
  //! Example
  //! Handle(TDocStd_Document) aDoc;
  //! if
  //! (!OCAFTest::GetDocument(1,aDoc)) return 1;
  //! Handle(TDataStd_Reference) aRef;
  //! TDocStd_XLinkTool xlinktool;
  //! if
  //! (!OCAFTest::Find(aDoc,2),TDataStd_Reference::GetID(),aRef) return 1;
  //! xlinktool.UpdateLink(aRef->Label());
  //! Exceptions
  //! Standard_DomainError if <L> has no XLink attribute.
  Standard_EXPORT void UpdateLink (const TDF_Label& L);
  
  //! Copy    the   content     of    <fromsource>   under
  //! <intarget>. Noone link is registred. noone check is done.
  //! Example
  //! Handle(TDocStd_Document) DOC, XDOC;
  //! TDF_Label L, XL;
  //! TDocStd_XLinkTool xlinktool;
  //! xlinktool.Copy(L,XL);
  //! Exceptions:
  //! Standard_DomainError if the contents of
  //! fromsource are not entirely in the scope of this
  //! label, in other words, are not self-contained.
  //! !!! ==> Warning:
  //! If the document manages shapes use the next way:
  //! TDocStd_XLinkTool xlinktool;
  //! xlinktool.Copy(L,XL);
  //! TopTools_DataMapOfShapeShape M;
  //! TNaming::ChangeShapes(target,M);
  Standard_EXPORT virtual void Copy (const TDF_Label& intarget, const TDF_Label& fromsource);
  
  Standard_EXPORT Standard_Boolean IsDone() const;
  
  Standard_EXPORT Handle(TDF_DataSet) DataSet() const;
  
  Standard_EXPORT Handle(TDF_RelocationTable) RelocationTable() const;




protected:



  Standard_Boolean isDone;


private:



  Handle(TDF_DataSet) myDS;
  Handle(TDF_RelocationTable) myRT;


};







#endif // _TDocStd_XLinkTool_HeaderFile