0032433: Visualization, TKService - introduce Wasm_Window implementing Aspect_Window...
[occt.git] / src / IFSelect / IFSelect_Functions.hxx
1 // Created on: 1993-07-28
2 // Created by: Christian CAILLET
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _IFSelect_Functions_HeaderFile
18 #define _IFSelect_Functions_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_CString.hxx>
25 #include <Standard_Integer.hxx>
26 #include <TColStd_HSequenceOfTransient.hxx>
27 #include <Standard_Boolean.hxx>
28 class Standard_Transient;
29 class IFSelect_WorkSession;
30 class IFSelect_Dispatch;
31
32 //! Functions gives access to all the actions which can be
33 //! commanded with the resources provided by IFSelect : especially
34 //! WorkSession and various types of Selections and Dispatches
35 //!
36 //! It works by adding functions by method Init
37 class IFSelect_Functions 
38 {
39 public:
40
41   DEFINE_STANDARD_ALLOC
42
43   //! Takes the name of an entity, either as argument,
44   //! or (if <name> is empty) on keyboard, and returns the entity
45   //! name can be a label or a number (in alphanumeric),
46   //! it is searched by NumberFromLabel from WorkSession.
47   //! If <name> doesn't match en entity, a Null Handle is returned
48   Standard_EXPORT static Handle(Standard_Transient) GiveEntity (const Handle(IFSelect_WorkSession)& WS, const Standard_CString name = "");
49   
50   //! Same as GetEntity, but returns the number in the model of the
51   //! entity. Returns 0 for null handle
52   Standard_EXPORT static Standard_Integer GiveEntityNumber (const Handle(IFSelect_WorkSession)& WS, const Standard_CString name = "");
53   
54   //! Computes a List of entities from a WorkSession and two idents,
55   //! first and second, as follows :
56   //! if <first> is a Number or Label of an entity : this entity
57   //! if <first> is the name of a Selection in <WS>, and <second>
58   //! not defined, the standard result of this Selection
59   //! if <first> is for a Selection and <second> is defined, the
60   //! standard result of this selection from the list computed
61   //! with <second> (an entity or a selection)
62   //! If <second> is erroneous, it is ignored
63   Standard_EXPORT static Handle(TColStd_HSequenceOfTransient) GiveList (const Handle(IFSelect_WorkSession)& WS, const Standard_CString first = "", const Standard_CString second = "");
64   
65   //! Evaluates and returns a Dispatch, from data of a WorkSession
66   //! if <mode> is False, searches for exact name of Dispatch in WS
67   //! Else (D), allows a parameter between brackets :
68   //! ex.: dispatch_name(parameter)
69   //! The parameter can be: an integer for DispPerCount or DispPerFiles
70   //! or the name of a Signature for DispPerSignature
71   //! Returns Null Handle if not found not well evaluated
72   Standard_EXPORT static Handle(IFSelect_Dispatch) GiveDispatch (const Handle(IFSelect_WorkSession)& WS, const Standard_CString name, const Standard_Boolean mode = Standard_True);
73   
74   //! Defines and loads all basic functions (as ActFunc)
75   Standard_EXPORT static void Init();
76
77 };
78
79 #endif // _IFSelect_Functions_HeaderFile