HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HUSD_EditCollections.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019 Side Effects Software Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef __HUSD_EditCollections_h__
19 #define __HUSD_EditCollections_h__
20 
21 #include "HUSD_API.h"
22 #include "HUSD_DataHandle.h"
23 #include <UT/UT_StringHolder.h>
24 
25 class HUSD_FindPrims;
26 
28 {
29 public:
32 
33  bool createCollection(const UT_StringRef &primpath,
34  const UT_StringRef &collectionname,
35  const UT_StringRef &expansionrule,
36  const HUSD_FindPrims &includeprims,
37  const HUSD_FindPrims &excludeprims,
38  bool setexcludes,
39  bool createprim,
40  bool forceapply = true);
41 
42  bool createCollection(const UT_StringRef &primpath,
43  const UT_StringRef &collectionname,
44  const UT_StringRef &expansionrule,
45  const HUSD_FindPrims &includeprims,
46  bool createprim,
47  bool forceapply = true);
48 
49  // Note, use HUSDmakeCollectionPath() to obtain collection path, if needed.
50  bool setCollectionExpansionRule(
51  const UT_StringRef &collectionpath,
52  const UT_StringRef &expansionrule);
53  bool setCollectionIncludes(
54  const UT_StringRef &collectionpath,
55  const UT_StringArray &paths);
56  bool addCollectionInclude(
57  const UT_StringRef &collectionpath,
58  const UT_StringRef &path);
59  bool setCollectionExcludes(
60  const UT_StringRef &collectionpath,
61  const UT_StringArray &paths);
62  bool addCollectionExclude(
63  const UT_StringRef &collectionpath,
64  const UT_StringRef &path);
65 
66  // Set an icon for use in our tree views.
67  bool setCollectionIcon(
68  const UT_StringRef &collectionpath,
69  const UT_StringHolder &icon);
70 
71 private:
72  HUSD_AutoWriteLock &myWriteLock;
73 };
74 
75 #endif
76 
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define HUSD_API
Definition: HUSD_API.h:32