include/opencascade/IGESSelect_SetLabel.hxx

0001 // Created on: 1999-02-26
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESSelect_SetLabel_HeaderFile
0018 #define _IGESSelect_SetLabel_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <IGESSelect_ModelModifier.hxx>
0025 class IFSelect_ContextModif;
0026 class IGESData_IGESModel;
0027 class Interface_CopyTool;
0028 class TCollection_AsciiString;
0029
0030 //! Sets/Clears Short Label of Entities, those designated by the
0031 //! Selection. No Selection means all the file
0032 //!
0033 //! May enforce, else it sets only if no label is yet set
0034 //! Mode : 0 to clear (always enforced)
0035 //! 1 to set label to DE number (changes it if already set)
0036 class IGESSelect_SetLabel : public IGESSelect_ModelModifier
0037 {
0038
0039 public:
0040   //! Creates a SetLabel for IGESEntity
0041   //! Mode : see Purpose of the class
0042   Standard_EXPORT IGESSelect_SetLabel(const int mode, const bool enforce);
0043
0044   //! Specific action : Sets or Clears the Label
0045   Standard_EXPORT void Performing(IFSelect_ContextModif&                 ctx,
0046                                   const occ::handle<IGESData_IGESModel>& target,
0047                                   Interface_CopyTool&                    TC) const override;
0048
0049   //! Returns a text which is
0050   //! "Clear Short Label" or "Set Label to DE"
0051   //! With possible additional information " (enforced)"
0052   Standard_EXPORT TCollection_AsciiString Label() const override;
0053
0054   DEFINE_STANDARD_RTTIEXT(IGESSelect_SetLabel, IGESSelect_ModelModifier)
0055
0056 private:
0057   int  themode;
0058   bool theforce;
0059 };
0060
0061 #endif // _IGESSelect_SetLabel_HeaderFile