LayOut C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
autotextdefinition.h
Go to the documentation of this file.
1 // Copyright 2016-2022 Trimble Inc. All Rights Reserved.
2 // This file is intended for public distribution.
3 
4 #ifndef LAYOUT_MODEL_AUTOTEXTDEFINITION_H_
5 #define LAYOUT_MODEL_AUTOTEXTDEFINITION_H_
6 
7 #include <LayOutAPI/common.h>
8 #include <LayOutAPI/model/defs.h>
9 
21 typedef enum {
22  LOAutoTextDefinitionType_File = 0,
23  LOAutoTextDefinitionType_PageName,
24  LOAutoTextDefinitionType_PageNumber,
25  LOAutoTextDefinitionType_CustomText,
26  LOAutoTextDefinitionType_DateCurrent,
27  LOAutoTextDefinitionType_DateCreated,
28  LOAutoTextDefinitionType_DateModified,
29  LOAutoTextDefinitionType_DatePublished,
30 
31  // Mandatory types
32  LOAutoTextDefinitionType_ModelGroupName,
33  LOAutoTextDefinitionType_ModelComponentInstanceName,
34  LOAutoTextDefinitionType_ModelComponentDefinitionName,
35  LOAutoTextDefinitionType_ModelComponentDescription,
36  LOAutoTextDefinitionType_ModelVolume,
37  LOAutoTextDefinitionType_ModelFaceArea,
38  LOAutoTextDefinitionType_ModelEdgeLength,
39  LOAutoTextDefinitionType_ModelCoordinates,
40  LOAutoTextDefinitionType_ModelDynamicComponentAttribute,
41  LOAutoTextDefinitionType_ModelClassifierAttribute,
42  LOAutoTextDefinitionType_ModelComponentInstanceAttribute,
43  LOAutoTextDefinitionType_ModelComponentDefinitionAttribute,
44 
45  // @since LayOut 2022.0, API 7.0
46  LOAutoTextDefinitionType_ModelSceneName,
47  LOAutoTextDefinitionType_ModelSceneDescription,
48  LOAutoTextDefinitionType_ModelScale,
49  LOAutoTextDefinitionType_ModelSectionName,
50  LOAutoTextDefinitionType_ModelSectionSymbol,
51  LOAutoTextDefinitionType_PageCount,
52  LOAutoTextDefinitionType_Sequence,
53  LOAutoTextDefinitionType_ModelRatio,
54 
55  // Must be last to give us a count of the number of types.
56  LOAutoTextDefinitionType_Count
57 } LOAutoTextDefinitionType;
58 
64 typedef enum {
65  LOAutoTextDefinitionNumberingStyle_Arabic = 0,
66  LOAutoTextDefinitionNumberingStyle_ArabicPadded,
67  LOAutoTextDefinitionNumberingStyle_UCAlpha,
68  LOAutoTextDefinitionNumberingStyle_LCAlpha,
69  LOAutoTextDefinitionNumberingStyle_UCRoman,
70  LOAutoTextDefinitionNumberingStyle_LCRoman,
71 
72  // Must be last to give us a count of styles.
73  LOAutoTextDefinitionNumberingStyle_Count
74 } LOAutoTextDefinitionNumberingStyle;
75 
81 typedef enum {
82  LOAutoTextDefinitionSequenceType_PerDocument = 0,
83  LOAutoTextDefinitionSequenceType_PerPage,
84 
85  // Must be last to give us a count of sequence types.
86  LOAutoTextDefinitionSequenceType_Count
87 } LOAutoTextDefinitionSequenceType;
88 
89 #ifdef __cplusplus
90 extern "C" {
91 #endif // __cplusplus
92 
103 LO_RESULT LOAutoTextDefinitionGetType(
104  LOAutoTextDefinitionRef autotext, LOAutoTextDefinitionType* type);
105 
118 LO_RESULT LOAutoTextDefinitionGetMandatory(LOAutoTextDefinitionRef autotext, bool* is_mandatory);
119 
130 LO_RESULT LOAutoTextDefinitionGetDocument(
131  LOAutoTextDefinitionRef autotext, LODocumentRef* document);
132 
143 LO_RESULT LOAutoTextDefinitionGetName(LOAutoTextDefinitionRef autotext, SUStringRef* name);
144 
157 LO_RESULT LOAutoTextDefinitionSetName(LOAutoTextDefinitionRef autotext, const char* name);
158 
169 LO_RESULT LOAutoTextDefinitionGetTag(LOAutoTextDefinitionRef autotext, SUStringRef* tag);
170 
181 LO_RESULT LOAutoTextDefinitionGetIndex(LOAutoTextDefinitionRef autotext, size_t* index);
182 
194 LO_RESULT LOAutoTextDefinitionGetCustomText(
195  LOAutoTextDefinitionRef autotext, SUStringRef* custom_text);
196 
207 LO_RESULT LOAutoTextDefinitionSetCustomText(
208  LOAutoTextDefinitionRef autotext, const char* custom_text);
209 
221 LO_RESULT LOAutoTextDefinitionGetDateFormat(
222  LOAutoTextDefinitionRef autotext, SUStringRef* date_format);
223 
234 LO_RESULT LOAutoTextDefinitionSetDateFormat(
235  LOAutoTextDefinitionRef autotext, const char* date_format);
236 
250 LO_RESULT LOAutoTextDefinitionGetDisplayFullPath(
251  LOAutoTextDefinitionRef autotext, bool* is_display_full_path);
252 
265 LO_RESULT LOAutoTextDefinitionSetDisplayFullPath(
266  LOAutoTextDefinitionRef autotext, bool is_display_full_path);
267 
281 LO_RESULT LOAutoTextDefinitionGetDisplayFileExtension(
282  LOAutoTextDefinitionRef autotext, bool* is_display_file_ext);
283 
296 LO_RESULT LOAutoTextDefinitionSetDisplayFileExtension(
297  LOAutoTextDefinitionRef autotext, bool is_display_file_ext);
309 SU_DEPRECATED_FUNCTION("LayOut API 7.0")
310 LO_RESULT LOAutoTextDefinitionGetPageNumberStyle(
311  LOAutoTextDefinitionRef autotext, LOAutoTextDefinitionNumberingStyle* numbering_style);
312 
324 SU_DEPRECATED_FUNCTION("LayOut API 7.0")
325 LO_RESULT LOAutoTextDefinitionSetPageNumberStyle(
326  LOAutoTextDefinitionRef autotext, LOAutoTextDefinitionNumberingStyle numbering_style);
327 
339 SU_DEPRECATED_FUNCTION("LayOut API 7.0")
340 LO_RESULT LOAutoTextDefinitionGetPageNumberStartIndex(
341  LOAutoTextDefinitionRef autotext, int* start_index);
342 
354 SU_DEPRECATED_FUNCTION("LayOut API 7.0")
355 LO_RESULT LOAutoTextDefinitionSetPageNumberStartIndex(LOAutoTextDefinitionRef autotext, int value);
356 
368 LO_RESULT LOAutoTextDefinitionGetStartPage(LOAutoTextDefinitionRef autotext, LOPageRef* page);
369 
381 LO_RESULT LOAutoTextDefinitionSetStartPage(LOAutoTextDefinitionRef autotext, LOPageRef page);
382 
395 LO_RESULT LOAutoTextDefinitionGetEndPage(LOAutoTextDefinitionRef autotext, LOPageRef* page);
396 
410 LO_RESULT LOAutoTextDefinitionSetEndPage(LOAutoTextDefinitionRef autotext, LOPageRef page);
411 
423 LO_RESULT LOAutoTextDefinitionGetIncrement(LOAutoTextDefinitionRef autotext, int* increment);
424 
435 LO_RESULT LOAutoTextDefinitionSetIncrement(LOAutoTextDefinitionRef autotext, int increment);
436 
448 LO_RESULT LOAutoTextDefinitionGetSequenceFormat(
449  LOAutoTextDefinitionRef autotext, SUStringRef* sequence_format);
450 
463 LO_RESULT LOAutoTextDefinitionSetSequenceFormat(
464  LOAutoTextDefinitionRef autotext, const char* sequence_format);
465 
476 LO_RESULT LOAutoTextDefinitionRenumberSequence(LOAutoTextDefinitionRef autotext);
477 
491 LO_RESULT LOAutoTextDefinitionGetNumberStyle(
492  LOAutoTextDefinitionRef autotext, LOAutoTextDefinitionNumberingStyle* numbering_style);
493 
507 LO_RESULT LOAutoTextDefinitionSetNumberStyle(
508  LOAutoTextDefinitionRef autotext, LOAutoTextDefinitionNumberingStyle numbering_style);
509 
522 LO_RESULT LOAutoTextDefinitionGetStartIndex(LOAutoTextDefinitionRef autotext, int* start_index);
523 
535 LO_RESULT LOAutoTextDefinitionSetStartIndex(LOAutoTextDefinitionRef autotext, int value);
536 
548 LO_RESULT LOAutoTextDefinitionGetSequenceType(
549  LOAutoTextDefinitionRef autotext, LOAutoTextDefinitionSequenceType* sequence_type);
550 
562 LO_RESULT LOAutoTextDefinitionSetSequenceType(
563  LOAutoTextDefinitionRef autotext, LOAutoTextDefinitionSequenceType sequence_type);
564 
565 #ifdef __cplusplus
566 } // end extern "C"
567 #endif // __cplusplus
568 
569 #endif // LAYOUT_MODEL_AUTOTEXTDEFINITION_H_
Generated on Fri Mar 1 2024 11:17:19 for LayOut C API by   doxygen 1.8.3.1