PhoenixLecture  2.0.0
Set of tools to make lectures
PLatexEnv Class Reference

Describe a latex environement. More...

#include <PLatexObj.h>

+ Collaboration diagram for PLatexEnv:

Public Member Functions

PLatexObjgetBegin ()
 Gets the begin of the PLatexEnv. More...
 
const PLatexObjgetBegin () const
 Gets the begin of the PLatexEnv. More...
 
PLatexObjgetEnd ()
 Gets the end of the PLatexEnv. More...
 
const PLatexObjgetEnd () const
 Gets the end of the PLatexEnv. More...
 
PStringgetName ()
 Gets the name of the PLatexEnv. More...
 
const PStringgetName () const
 Gets the name of the PLatexEnv. More...
 
PLatexEnvoperator= (const PLatexEnv &other)
 Operator = of class PLatexEnv. More...
 
 PLatexEnv ()
 Constructor of class PLatexEnv. More...
 
 PLatexEnv (const PLatexEnv &other)
 Copy Constructor of class PLatexEnv. More...
 
void setBegin (const PLatexObj &begin)
 Sets the begin of the PLatexEnv. More...
 
void setEnd (const PLatexObj &end)
 Sets the end of the PLatexEnv. More...
 
void setName (const PString &name)
 Sets the name of the PLatexEnv. More...
 
virtual ~PLatexEnv ()
 Destructor of class PLatexEnv. More...
 

Protected Member Functions

void copyPLatexEnv (const PLatexEnv &other)
 Copy Function of class PLatexEnv. More...
 

Private Member Functions

void initialisationPLatexEnv ()
 Initialisation Function of class PLatexEnv. More...
 

Private Attributes

PLatexObj p_begin
 Begining of the environement. More...
 
PLatexObj p_end
 Ending of the environement. More...
 
PString p_name
 Name of the environement. More...
 

Detailed Description

Describe a latex environement.

Definition at line 242 of file PLatexObj.h.

Constructor & Destructor Documentation

◆ PLatexEnv() [1/2]

PLatexEnv::PLatexEnv ( )

Constructor of class PLatexEnv.

Definition at line 949 of file PLatexObj.cpp.

949  {
951 }
void initialisationPLatexEnv()
Initialisation Function of class PLatexEnv.
Definition: PLatexObj.cpp:1047

References initialisationPLatexEnv().

+ Here is the call graph for this function:

◆ PLatexEnv() [2/2]

PLatexEnv::PLatexEnv ( const PLatexEnv other)

Copy Constructor of class PLatexEnv.

Parameters
other: PLatexEnv we want ot copy

Definition at line 956 of file PLatexObj.cpp.

956  {
957  copyPLatexEnv(other);
958 }
void copyPLatexEnv(const PLatexEnv &other)
Copy Function of class PLatexEnv.
Definition: PLatexObj.cpp:1040

References copyPLatexEnv().

+ Here is the call graph for this function:

◆ ~PLatexEnv()

PLatexEnv::~PLatexEnv ( )
virtual

Destructor of class PLatexEnv.

Definition at line 961 of file PLatexObj.cpp.

961  {
962 
963 }

Member Function Documentation

◆ copyPLatexEnv()

void PLatexEnv::copyPLatexEnv ( const PLatexEnv other)
protected

Copy Function of class PLatexEnv.

Parameters
other: PLatexEnv we want ot copy

Definition at line 1040 of file PLatexObj.cpp.

1040  {
1041  p_name = other.p_name;
1042  p_begin = other.p_begin;
1043  p_end = other.p_end;
1044 }
PLatexObj p_end
Ending of the environement.
Definition: PLatexObj.h:266
PLatexObj p_begin
Begining of the environement.
Definition: PLatexObj.h:264
PString p_name
Name of the environement.
Definition: PLatexObj.h:262

References p_begin, p_end, and p_name.

Referenced by operator=(), and PLatexEnv().

+ Here is the caller graph for this function:

◆ getBegin() [1/2]

PLatexObj & PLatexEnv::getBegin ( )

Gets the begin of the PLatexEnv.

Returns
begin of the PLatexEnv

Definition at line 1019 of file PLatexObj.cpp.

1019  {
1020  return p_begin;
1021 }

References p_begin.

◆ getBegin() [2/2]

const PLatexObj & PLatexEnv::getBegin ( ) const

Gets the begin of the PLatexEnv.

Returns
begin of the PLatexEnv

Definition at line 1012 of file PLatexObj.cpp.

1012  {
1013  return p_begin;
1014 }

References p_begin.

◆ getEnd() [1/2]

PLatexObj & PLatexEnv::getEnd ( )

Gets the end of the PLatexEnv.

Returns
end of the PLatexEnv

Definition at line 1033 of file PLatexObj.cpp.

1033  {
1034  return p_end;
1035 }

References p_end.

◆ getEnd() [2/2]

const PLatexObj & PLatexEnv::getEnd ( ) const

Gets the end of the PLatexEnv.

Returns
end of the PLatexEnv

Definition at line 1026 of file PLatexObj.cpp.

1026  {
1027  return p_end;
1028 }

References p_end.

◆ getName() [1/2]

PString & PLatexEnv::getName ( )

Gets the name of the PLatexEnv.

Returns
name of the PLatexEnv

Definition at line 1005 of file PLatexObj.cpp.

1005  {
1006  return p_name;
1007 }

References p_name.

◆ getName() [2/2]

const PString & PLatexEnv::getName ( ) const

Gets the name of the PLatexEnv.

Returns
name of the PLatexEnv

Definition at line 998 of file PLatexObj.cpp.

998  {
999  return p_name;
1000 }

References p_name.

◆ initialisationPLatexEnv()

void PLatexEnv::initialisationPLatexEnv ( )
private

Initialisation Function of class PLatexEnv.

Definition at line 1047 of file PLatexObj.cpp.

1047  {
1048  p_name = "";
1049 }

References p_name.

Referenced by PLatexEnv().

+ Here is the caller graph for this function:

◆ operator=()

PLatexEnv & PLatexEnv::operator= ( const PLatexEnv other)

Operator = of class PLatexEnv.

Parameters
other: PLatexEnv we want ot copy
Returns
copied class PLatexEnv

Definition at line 969 of file PLatexObj.cpp.

969  {
970  copyPLatexEnv(other);
971  return *this;
972 }

References copyPLatexEnv().

+ Here is the call graph for this function:

◆ setBegin()

void PLatexEnv::setBegin ( const PLatexObj begin)

Sets the begin of the PLatexEnv.

Parameters
begin: begin of the PLatexEnv

Definition at line 984 of file PLatexObj.cpp.

984  {
985  p_begin = begin;
986 }

References p_begin.

◆ setEnd()

void PLatexEnv::setEnd ( const PLatexObj end)

Sets the end of the PLatexEnv.

Parameters
end: end of the PLatexEnv

Definition at line 991 of file PLatexObj.cpp.

991  {
992  p_end = end;
993 }

References p_end.

◆ setName()

void PLatexEnv::setName ( const PString name)

Sets the name of the PLatexEnv.

Parameters
name: name of the PLatexEnv

Definition at line 977 of file PLatexObj.cpp.

977  {
978  p_name = name;
979 }

References p_name.

Member Data Documentation

◆ p_begin

PLatexObj PLatexEnv::p_begin
private

Begining of the environement.

Definition at line 264 of file PLatexObj.h.

Referenced by copyPLatexEnv(), getBegin(), and setBegin().

◆ p_end

PLatexObj PLatexEnv::p_end
private

Ending of the environement.

Definition at line 266 of file PLatexObj.h.

Referenced by copyPLatexEnv(), getEnd(), and setEnd().

◆ p_name

PString PLatexEnv::p_name
private

Name of the environement.

Definition at line 262 of file PLatexObj.h.

Referenced by copyPLatexEnv(), getName(), initialisationPLatexEnv(), and setName().


The documentation for this class was generated from the following files: