PhoenixLecture  2.0.0
Set of tools to make lectures
platexobj_create.h File Reference
+ Include dependency graph for platexobj_create.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

PLatexObj platexobj_createItem (const PLatexObj &obj)
 Create an ITEM. More...
 
PLatexObj platexobj_createItem (const std::vector< PLatexObj > &vecObj)
 Create an ITEM. More...
 
PLatexObj platexobj_createItemize ()
 Create an ITEMIZE. More...
 
PLatexObj platexobj_createNewLine ()
 Create a new line. More...
 
PLatexObj platexobj_createNone ()
 Create a NONE PLatexObj. More...
 
PLatexObj platexobj_createParagraph (const PLatexObj &objText, const PString &label="")
 Create a PARAGRAPH. More...
 
PLatexObj platexobj_createParagraph (const PString &text, const PString &label="")
 Create a PARAGRAPH. More...
 
PLatexObj platexobj_createRef (const PString &label, const PLatexObj &textObj)
 Create a reference (REF) More...
 
PLatexObj platexobj_createRef (const PString &label, const PString &text)
 Create a reference (REF) More...
 
PLatexObj platexobj_createRendezVous (const PPath &fileNameIcs)
 Create a RENDEZVOUS. More...
 
PLatexObj platexobj_createSection (PLatexType::PLatexType sectionType, const PLatexObj &complexTitle, const PString &label)
 Create a part, chapter, section, subsection, subsubsection. More...
 
PLatexObj platexobj_createText (const PString &text, const PString &label="")
 Create a TEXT. More...
 
PLatexObj platexobj_createTextBf (const PString &text, const PString &label="")
 Create a TEXT. More...
 
PLatexObj platexobj_createTimetableBlock (const PString &blockStyle)
 Create a TIMETABLE_BLOCK. More...
 
PLatexObj platexobj_createTimetableBlock (const PString &blockStyle, const PLatexObj &obj)
 Create a TIMETABLE_BLOCK. More...
 
PLatexObj platexobj_createTimetableBlock (const PString &blockStyle, const std::vector< PLatexObj > &vecObj)
 Create a TIMETABLE_BLOCK. More...
 
PLatexObj platexobj_createTimetableTimeRow ()
 Create an TIMETABLE_TIMEROW. More...
 

Function Documentation

◆ platexobj_createItem() [1/2]

PLatexObj platexobj_createItem ( const PLatexObj obj)

Create an ITEM.

Parameters
obj: PLatexObj to put in the ITEM
Returns
corresponding PLatexObj

Definition at line 130 of file platexobj_create.cpp.

130  {
131  PLatexObj out;
133  appendVecContent(out.getVecContent(), obj);
134  return out;
135 }
Describe a latex object.
Definition: PLatexObj.h:40
const std::vector< PLatexObj > & getVecContent() const
Gets the vecContent of the PLatexObj.
Definition: PLatexObj.cpp:410
void setType(const PLatexType::PLatexType &type)
Sets the type of the PLatexObj.
Definition: PLatexObj.cpp:130
void appendVecContent(std::vector< PLatexObj > &vecContent, const std::vector< PLatexObj > &vecObj)
Append a vector of PLatexObj in the given vector of content.

References appendVecContent(), PLatexObj::getVecContent(), PLatexType::ITEM, and PLatexObj::setType().

Referenced by ptimetable_texLecture().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createItem() [2/2]

PLatexObj platexobj_createItem ( const std::vector< PLatexObj > &  vecObj)

Create an ITEM.

Parameters
vecObj: vector of PLatexObj to put in the ITEM
Returns
corresponding PLatexObj

Definition at line 141 of file platexobj_create.cpp.

141  {
142  PLatexObj obj;
144  appendVecContent(obj.getVecContent(), vecObj);
145  return obj;
146 }

References appendVecContent(), PLatexObj::getVecContent(), PLatexType::ITEM, and PLatexObj::setType().

+ Here is the call graph for this function:

◆ platexobj_createItemize()

PLatexObj platexobj_createItemize ( )

Create an ITEMIZE.

Returns
corresponding PLatexObj

Definition at line 120 of file platexobj_create.cpp.

120  {
121  PLatexObj obj;
123  return obj;
124 }

References PLatexType::ITEMIZE, and PLatexObj::setType().

Referenced by ptimetable_texLecture().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createNewLine()

PLatexObj platexobj_createNewLine ( )

Create a new line.

Returns
corresponding PLatexObj

Definition at line 41 of file platexobj_create.cpp.

41  {
42  PLatexObj obj;
44  return obj;
45 }

References PLatexType::NEWLINE, and PLatexObj::setType().

Referenced by pspeaker_texSpeaker(), and ptimetable_texLecture().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createNone()

PLatexObj platexobj_createNone ( )

Create a NONE PLatexObj.

Returns
corresponding PLatexObj

Definition at line 12 of file platexobj_create.cpp.

12  {
13  PLatexObj obj;
15  return obj;
16 }

References PLatexType::NONE, and PLatexObj::setType().

Referenced by ptimetable_toTex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createParagraph() [1/2]

PLatexObj platexobj_createParagraph ( const PLatexObj objText,
const PString label 
)

Create a PARAGRAPH.

Parameters
objText: text to put into the PLatexObj
label: label to refer the section
Returns
corresponding PLatexObj

Definition at line 87 of file platexobj_create.cpp.

87  {
88  PLatexObj obj;
90  appendVecContent(obj.getVecContent(), objText);
91  obj.setLabelName(label);
92  return obj;
93 }
void setLabelName(const PString &labelName)
Sets the labelName of the PLatexObj.
Definition: PLatexObj.cpp:158

References appendVecContent(), PLatexObj::getVecContent(), PLatexType::PARAGRAPHE, PLatexObj::setLabelName(), and PLatexObj::setType().

+ Here is the call graph for this function:

◆ platexobj_createParagraph() [2/2]

PLatexObj platexobj_createParagraph ( const PString text,
const PString label 
)

Create a PARAGRAPH.

Parameters
text: text to put into the PLatexObj
label: label to refer the section
Returns
corresponding PLatexObj

Definition at line 78 of file platexobj_create.cpp.

78  {
79  return platexobj_createParagraph(platexobj_createText(text, ""), label);
80 }
PLatexObj platexobj_createText(const PString &text, const PString &label)
Create a TEXT.
PLatexObj platexobj_createParagraph(const PString &text, const PString &label)
Create a PARAGRAPH.

References platexobj_createText().

Referenced by pspeaker_texSpeaker(), and ptimetable_texLecture().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createRef() [1/2]

PLatexObj platexobj_createRef ( const PString label,
const PLatexObj textObj 
)

Create a reference (REF)

Parameters
label: label to reference
textObj: PLatexObj of the reference link (can be empty)
Returns
corresponding PLatexObj

Definition at line 109 of file platexobj_create.cpp.

109  {
110  PLatexObj obj;
112  obj.setName(label);
113  appendVecContent(obj.getVecContent(), textObj);
114  return obj;
115 }
void setName(const PString &name)
Sets the name of the PLatexObj.
Definition: PLatexObj.cpp:144

References appendVecContent(), PLatexObj::getVecContent(), PLatexType::REF, PLatexObj::setName(), and PLatexObj::setType().

+ Here is the call graph for this function:

◆ platexobj_createRef() [2/2]

PLatexObj platexobj_createRef ( const PString label,
const PString text 
)

Create a reference (REF)

Parameters
label: label to reference
text: text of the reference link (can be empty)
Returns
corresponding PLatexObj

Definition at line 100 of file platexobj_create.cpp.

100  {
101  return platexobj_createRef(label, platexobj_createText(text, ""));
102 }
PLatexObj platexobj_createRef(const PString &label, const PString &text)
Create a reference (REF)

References platexobj_createText().

Referenced by ptimetable_blockToTex(), ptimetable_texLecture(), and ptimetable_toTex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createRendezVous()

PLatexObj platexobj_createRendezVous ( const PPath fileNameIcs)

Create a RENDEZVOUS.

Parameters
fileNameIcs: name of the .ics file
Returns
corresponding PLatexObj

Definition at line 194 of file platexobj_create.cpp.

194  {
195  PLatexObj obj;
197  obj.setText(fileNameIcs);
198  return obj;
199 }
void setText(const PString &text)
Sets the text of the PLatexObj.
Definition: PLatexObj.cpp:137

References PLatexType::RENDEZVOUS, PLatexObj::setText(), and PLatexObj::setType().

Referenced by ptimetable_blockToTex(), ptimetable_tex(), ptimetable_texChapter(), ptimetable_texLecture(), ptimetable_texSection(), and ptimetable_toTex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createSection()

PLatexObj platexobj_createSection ( PLatexType::PLatexType  sectionType,
const PLatexObj complexTitle,
const PString label 
)

Create a part, chapter, section, subsection, subsubsection.

Parameters
sectionType: type of the section (PLatexType::PART, PLatexType::CHAPTER, PLatexType::SECTION, PLatexType::SUBSECTION, PLatexType::SUBSUBSECTION)
complexTitle: title of the section
label: label to refer the section
Returns
corresponding PLatexObj

Definition at line 24 of file platexobj_create.cpp.

24  {
25  PLatexObj sec;
26  sec.setType(sectionType);
27  if(complexTitle.getType() == PLatexType::NONE){
28  sec.setComplexTitle(complexTitle.getVecContent());
29  }else{
30  std::vector<PLatexObj> vecContent;
31  vecContent.push_back(complexTitle);
32  sec.setComplexTitle(vecContent);
33  }
34  sec.setLabelName(label);
35  return sec;
36 }
void setComplexTitle(const std::vector< PLatexObj > &complexTitle)
Sets the complexTitle of the PLatexObj.
Definition: PLatexObj.cpp:179
const PLatexType::PLatexType & getType() const
Gets the type of the PLatexObj.
Definition: PLatexObj.cpp:298

References PLatexObj::getType(), PLatexObj::getVecContent(), PLatexType::NONE, PLatexObj::setComplexTitle(), PLatexObj::setLabelName(), and PLatexObj::setType().

Referenced by pspeaker_tex(), pspeaker_texSpeaker(), ptimetable_tex(), ptimetable_texChapter(), ptimetable_texLecture(), and ptimetable_texSection().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createText()

PLatexObj platexobj_createText ( const PString text,
const PString label 
)

Create a TEXT.

Parameters
text: text to put into the PLatexObj
label: label to refer the section
Returns
corresponding PLatexObj

Definition at line 52 of file platexobj_create.cpp.

52  {
53  PLatexObj obj;
55  obj.setText(text);
56  obj.setLabelName(label);
57  return obj;
58 }

References PLatexObj::setLabelName(), PLatexObj::setText(), PLatexObj::setType(), and PLatexType::TEXT.

Referenced by platexobj_createParagraph(), platexobj_createRef(), pspeaker_tex(), pspeaker_texSpeaker(), ptimetable_texLecture(), ptimetable_texSection(), and ptimetable_toTex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createTextBf()

PLatexObj platexobj_createTextBf ( const PString text,
const PString label 
)

Create a TEXT.

Parameters
text: text to put into the PLatexObj
label: label to refer the section
Returns
corresponding PLatexObj

Definition at line 65 of file platexobj_create.cpp.

65  {
66  PLatexObj obj;
68  obj.setName(text);
69  obj.setLabelName(label);
70  return obj;
71 }

References PLatexObj::setLabelName(), PLatexObj::setName(), PLatexObj::setType(), and PLatexType::TEXTBF.

Referenced by pspeaker_texSpeaker(), and ptimetable_texLecture().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createTimetableBlock() [1/3]

PLatexObj platexobj_createTimetableBlock ( const PString blockStyle)

Create a TIMETABLE_BLOCK.

Parameters
blockStyle: style of the block
Returns
corresponding PLatexObj

Definition at line 161 of file platexobj_create.cpp.

161  {
162  PLatexObj cell;
164  cell.setText(blockStyle);
165  return cell;
166 }
@ TIMETABLE_BLOCK
Definition: PLatexType.h:102

References PLatexObj::setText(), PLatexObj::setType(), and PLatexType::TIMETABLE_BLOCK.

Referenced by platexobj_createTimetableBlock(), and ptimetable_toTex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ platexobj_createTimetableBlock() [2/3]

PLatexObj platexobj_createTimetableBlock ( const PString blockStyle,
const PLatexObj obj 
)

Create a TIMETABLE_BLOCK.

Parameters
blockStyle: style of the block
obj: PLatexObj to put in the ITEM
Returns
corresponding PLatexObj

Definition at line 173 of file platexobj_create.cpp.

173  {
174  PLatexObj cell(platexobj_createTimetableBlock(blockStyle));
175  appendVecContent(cell.getVecContent(), obj);
176  return cell;
177 }
PLatexObj platexobj_createTimetableBlock(const PString &blockStyle)
Create a TIMETABLE_BLOCK.

References appendVecContent(), PLatexObj::getVecContent(), and platexobj_createTimetableBlock().

+ Here is the call graph for this function:

◆ platexobj_createTimetableBlock() [3/3]

PLatexObj platexobj_createTimetableBlock ( const PString blockStyle,
const std::vector< PLatexObj > &  vecObj 
)

Create a TIMETABLE_BLOCK.

Parameters
blockStyle: style of the block
vecObj: vector of PLatexObj to put in the ITEM
Returns
corresponding PLatexObj

Definition at line 184 of file platexobj_create.cpp.

184  {
185  PLatexObj cell(platexobj_createTimetableBlock(blockStyle));
186  appendVecContent(cell.getVecContent(), vecObj);
187  return cell;
188 }

References appendVecContent(), PLatexObj::getVecContent(), and platexobj_createTimetableBlock().

+ Here is the call graph for this function:

◆ platexobj_createTimetableTimeRow()

PLatexObj platexobj_createTimetableTimeRow ( )

Create an TIMETABLE_TIMEROW.

Returns
corresponding PLatexObj

Definition at line 151 of file platexobj_create.cpp.

151  {
152  PLatexObj obj;
154  return obj;
155 }
@ TIMETABLE_TIMEROW
Definition: PLatexType.h:100

References PLatexObj::setType(), and PLatexType::TIMETABLE_TIMEROW.

Referenced by ptimetable_toTex().

+ Here is the call graph for this function:
+ Here is the caller graph for this function: