PhoenixLecture  2.0.0
Set of tools to make lectures
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
PFullMenu Class Reference

Full menu of all site. More...

#include <PLatexObj.h>

+ Collaboration diagram for PFullMenu:

Public Member Functions

bool & getIsExpanded ()
 Gets the isExpanded of the PFullMenu. More...
 
bool getIsExpanded () const
 Gets the isExpanded of the PFullMenu. More...
 
bool & getIsFirstExpanded ()
 Gets the isFirstExpanded of the PFullMenu. More...
 
bool getIsFirstExpanded () const
 Gets the isFirstExpanded of the PFullMenu. More...
 
bool & getIsSeparator ()
 Gets the isSeparator of the PFullMenu. More...
 
bool getIsSeparator () const
 Gets the isSeparator of the PFullMenu. More...
 
PString & getLink ()
 Gets the link of the PFullMenu. More...
 
const PString & getLink () const
 Gets the link of the PFullMenu. More...
 
PString & getMainPageLink ()
 Gets the mainPageLink of the PFullMenu. More...
 
const PString & getMainPageLink () const
 Gets the mainPageLink of the PFullMenu. More...
 
PString & getText ()
 Gets the text of the PFullMenu. More...
 
const PString & getText () const
 Gets the text of the PFullMenu. More...
 
std::vector< PFullMenu > & getVecSubMenu ()
 Gets the vecSubMenu of the PFullMenu. More...
 
const std::vector< PFullMenu > & getVecSubMenu () const
 Gets the vecSubMenu of the PFullMenu. More...
 
PFullMenu & operator= (const PFullMenu &other)
 Operator = of class PFullMenu. More...
 
 PFullMenu ()
 Constructor of class PFullMenu. More...
 
 PFullMenu (const PFullMenu &other)
 Copy Constructor of class PFullMenu. More...
 
void setIsExpanded (bool isExpanded)
 Sets the isExpanded of the PFullMenu. More...
 
void setIsFirstExpanded (bool isFirstExpanded)
 Sets the isFirstExpanded of the PFullMenu. More...
 
void setIsSeparator (bool isSeparator)
 Sets the isSeparator of the PFullMenu. More...
 
void setLink (const PString &link)
 Sets the link of the PFullMenu. More...
 
void setMainPageLink (const PString &mainPageLink)
 Sets the mainPageLink of the PFullMenu. More...
 
void setText (const PString &text)
 Sets the text of the PFullMenu. More...
 
void setVecSubMenu (const std::vector< PFullMenu > &vecSubMenu)
 Sets the vecSubMenu of the PFullMenu. More...
 
virtual ~PFullMenu ()
 Destructor of class PFullMenu. More...
 

Protected Member Functions

void copyPFullMenu (const PFullMenu &other)
 Copy Function of class PFullMenu. More...
 

Private Member Functions

void initialisationPFullMenu ()
 Initialisation Function of class PFullMenu. More...
 

Private Attributes

bool p_isExpanded
 True if the current menu has to be expanded, false otherwise. More...
 
bool p_isFirstExpanded
 True if the current menu was the first which has to be expanded, false otherwise. More...
 
bool p_isSeparator
 True if the entry is a menu separator. More...
 
PString p_link
 Link. More...
 
PString p_mainPageLink
 Main Page link. More...
 
PString p_text
 Text. More...
 
std::vector< PFullMenu > p_vecSubMenu
 Vector of sub-menu. More...
 

Detailed Description

Full menu of all site.

Definition at line 168 of file PLatexObj.h.

Constructor & Destructor Documentation

◆ PFullMenu() [1/2]

PFullMenu::PFullMenu ( )

Constructor of class PFullMenu.

Definition at line 652 of file PLatexObj.cpp.

652  {
653  initialisationPFullMenu();
654 }
PFullMenu::initialisationPFullMenu
void initialisationPFullMenu()
Initialisation Function of class PFullMenu.
Definition: PLatexObj.cpp:838

References initialisationPFullMenu().

+ Here is the call graph for this function:

◆ PFullMenu() [2/2]

PFullMenu::PFullMenu ( const PFullMenu &  other)

Copy Constructor of class PFullMenu.

Parameters
other: PFullMenu we want ot copy

Definition at line 659 of file PLatexObj.cpp.

659  {
660  copyPFullMenu(other);
661 }
PFullMenu::copyPFullMenu
void copyPFullMenu(const PFullMenu &other)
Copy Function of class PFullMenu.
Definition: PLatexObj.cpp:827

References copyPFullMenu().

+ Here is the call graph for this function:

◆ ~PFullMenu()

PFullMenu::~PFullMenu ( )
virtual

Destructor of class PFullMenu.

Definition at line 664 of file PLatexObj.cpp.

664  {
665 
666 }

Member Function Documentation

◆ copyPFullMenu()

void PFullMenu::copyPFullMenu ( const PFullMenu &  other)
protected

Copy Function of class PFullMenu.

Parameters
other: PFullMenu we want ot copy

Definition at line 827 of file PLatexObj.cpp.

827  {
828  p_isExpanded = other.p_isExpanded;
829  p_isFirstExpanded = other.p_isFirstExpanded;
830  p_isSeparator = other.p_isSeparator;
831  p_link = other.p_link;
832  p_text = other.p_text;
833  p_vecSubMenu = other.p_vecSubMenu;
834  p_mainPageLink = other.p_mainPageLink;
835 }
PFullMenu::p_mainPageLink
PString p_mainPageLink
Main Page link.
Definition: PLatexObj.h:212
PFullMenu::p_text
PString p_text
Text.
Definition: PLatexObj.h:208
PFullMenu::p_isFirstExpanded
bool p_isFirstExpanded
True if the current menu was the first which has to be expanded, false otherwise.
Definition: PLatexObj.h:202
PFullMenu::p_isSeparator
bool p_isSeparator
True if the entry is a menu separator.
Definition: PLatexObj.h:204
PFullMenu::p_link
PString p_link
Link.
Definition: PLatexObj.h:206
PFullMenu::p_isExpanded
bool p_isExpanded
True if the current menu has to be expanded, false otherwise.
Definition: PLatexObj.h:200
PFullMenu::p_vecSubMenu
std::vector< PFullMenu > p_vecSubMenu
Vector of sub-menu.
Definition: PLatexObj.h:210

References p_isExpanded, p_isFirstExpanded, p_isSeparator, p_link, p_mainPageLink, p_text, and p_vecSubMenu.

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

+ Here is the caller graph for this function:

◆ getIsExpanded() [1/2]

bool & PFullMenu::getIsExpanded ( )

Gets the isExpanded of the PFullMenu.

Returns
isExpanded of the PFullMenu

Definition at line 736 of file PLatexObj.cpp.

736  {
737  return p_isExpanded;
738 }

References p_isExpanded.

◆ getIsExpanded() [2/2]

bool PFullMenu::getIsExpanded ( ) const

Gets the isExpanded of the PFullMenu.

Returns
isExpanded of the PFullMenu

Definition at line 729 of file PLatexObj.cpp.

729  {
730  return p_isExpanded;
731 }

References p_isExpanded.

Referenced by platexobj_menuToHtmlChapter().

+ Here is the caller graph for this function:

◆ getIsFirstExpanded() [1/2]

bool & PFullMenu::getIsFirstExpanded ( )

Gets the isFirstExpanded of the PFullMenu.

Returns
isFirstExpanded of the PFullMenu

Definition at line 750 of file PLatexObj.cpp.

750  {
751  return p_isFirstExpanded;
752 }

References p_isFirstExpanded.

◆ getIsFirstExpanded() [2/2]

bool PFullMenu::getIsFirstExpanded ( ) const

Gets the isFirstExpanded of the PFullMenu.

Returns
isFirstExpanded of the PFullMenu

Definition at line 743 of file PLatexObj.cpp.

743  {
744  return p_isFirstExpanded;
745 }

References p_isFirstExpanded.

Referenced by platexobj_menuToHtmlChapter().

+ Here is the caller graph for this function:

◆ getIsSeparator() [1/2]

bool & PFullMenu::getIsSeparator ( )

Gets the isSeparator of the PFullMenu.

Returns
isSeparator of the PFullMenu

Definition at line 764 of file PLatexObj.cpp.

764  {
765  return p_isSeparator;
766 }

References p_isSeparator.

◆ getIsSeparator() [2/2]

bool PFullMenu::getIsSeparator ( ) const

Gets the isSeparator of the PFullMenu.

Returns
isSeparator of the PFullMenu

Definition at line 757 of file PLatexObj.cpp.

757  {
758  return p_isSeparator;
759 }

References p_isSeparator.

Referenced by platexobj_menuToHtmlChapter().

+ Here is the caller graph for this function:

◆ getLink() [1/2]

PString & PFullMenu::getLink ( )

Gets the link of the PFullMenu.

Returns
link of the PFullMenu

Definition at line 778 of file PLatexObj.cpp.

778  {
779  return p_link;
780 }

References p_link.

◆ getLink() [2/2]

const PString & PFullMenu::getLink ( ) const

Gets the link of the PFullMenu.

Returns
link of the PFullMenu

Definition at line 771 of file PLatexObj.cpp.

771  {
772  return p_link;
773 }

References p_link.

Referenced by platexobg_isMenuExtanded(), and platexobj_menuToHtmlChapter().

+ Here is the caller graph for this function:

◆ getMainPageLink() [1/2]

PString & PFullMenu::getMainPageLink ( )

Gets the mainPageLink of the PFullMenu.

Returns
mainPageLink of the PFullMenu

Definition at line 820 of file PLatexObj.cpp.

820  {
821  return p_mainPageLink;
822 }

References p_mainPageLink.

◆ getMainPageLink() [2/2]

const PString & PFullMenu::getMainPageLink ( ) const

Gets the mainPageLink of the PFullMenu.

Returns
mainPageLink of the PFullMenu

Definition at line 813 of file PLatexObj.cpp.

813  {
814  return p_mainPageLink;
815 }

References p_mainPageLink.

Referenced by platexobj_menuToHtml().

+ Here is the caller graph for this function:

◆ getText() [1/2]

PString & PFullMenu::getText ( )

Gets the text of the PFullMenu.

Returns
text of the PFullMenu

Definition at line 792 of file PLatexObj.cpp.

792  {
793  return p_text;
794 }

References p_text.

◆ getText() [2/2]

const PString & PFullMenu::getText ( ) const

Gets the text of the PFullMenu.

Returns
text of the PFullMenu

Definition at line 785 of file PLatexObj.cpp.

785  {
786  return p_text;
787 }

References p_text.

Referenced by platexobj_menuToHtmlChapter().

+ Here is the caller graph for this function:

◆ getVecSubMenu() [1/2]

std::vector< PFullMenu > & PFullMenu::getVecSubMenu ( )

Gets the vecSubMenu of the PFullMenu.

Returns
vecSubMenu of the PFullMenu

Definition at line 806 of file PLatexObj.cpp.

806  {
807  return p_vecSubMenu;
808 }

References p_vecSubMenu.

◆ getVecSubMenu() [2/2]

const std::vector< PFullMenu > & PFullMenu::getVecSubMenu ( ) const

Gets the vecSubMenu of the PFullMenu.

Returns
vecSubMenu of the PFullMenu

Definition at line 799 of file PLatexObj.cpp.

799  {
800  return p_vecSubMenu;
801 }

References p_vecSubMenu.

Referenced by platexobj_makeExpandMenu(), platexobj_menuToHtml(), platexobj_menuToHtmlChapter(), and platexobj_toMenuAll().

+ Here is the caller graph for this function:

◆ initialisationPFullMenu()

void PFullMenu::initialisationPFullMenu ( )
private

Initialisation Function of class PFullMenu.

Definition at line 838 of file PLatexObj.cpp.

838  {
839  p_isExpanded = false;
840  p_isFirstExpanded = false;
841  p_isSeparator = false;
842  p_link = "";
843  p_text = "";
844  p_mainPageLink = "";
845 }

References p_isExpanded, p_isFirstExpanded, p_isSeparator, p_link, p_mainPageLink, and p_text.

Referenced by PFullMenu().

+ Here is the caller graph for this function:

◆ operator=()

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

Operator = of class PFullMenu.

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

Definition at line 672 of file PLatexObj.cpp.

672  {
673  copyPFullMenu(other);
674  return *this;
675 }

References copyPFullMenu().

+ Here is the call graph for this function:

◆ setIsExpanded()

void PFullMenu::setIsExpanded ( bool  isExpanded)

Sets the isExpanded of the PFullMenu.

Parameters
isExpanded: isExpanded of the PFullMenu

Definition at line 680 of file PLatexObj.cpp.

680  {
681  p_isExpanded = isExpanded;
682 }

References p_isExpanded.

Referenced by platexobj_makeExpandMenu().

+ Here is the caller graph for this function:

◆ setIsFirstExpanded()

void PFullMenu::setIsFirstExpanded ( bool  isFirstExpanded)

Sets the isFirstExpanded of the PFullMenu.

Parameters
isFirstExpanded: isFirstExpanded of the PFullMenu

Definition at line 687 of file PLatexObj.cpp.

687  {
688  p_isFirstExpanded = isFirstExpanded;
689 }

References p_isFirstExpanded.

Referenced by platexobj_makeExpandMenu().

+ Here is the caller graph for this function:

◆ setIsSeparator()

void PFullMenu::setIsSeparator ( bool  isSeparator)

Sets the isSeparator of the PFullMenu.

Parameters
isSeparator: isSeparator of the PFullMenu

Definition at line 694 of file PLatexObj.cpp.

694  {
695  p_isSeparator = isSeparator;
696 }
isSeparator
bool isSeparator(const PLatexObj &obj)
Say if the PLatexObj is a book separator.
Definition: platexobj_utils.cpp:24

References isSeparator(), and p_isSeparator.

Referenced by platexobj_toMenuAll().

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

◆ setLink()

void PFullMenu::setLink ( const PString &  link)

Sets the link of the PFullMenu.

Parameters
link: link of the PFullMenu

Definition at line 701 of file PLatexObj.cpp.

701  {
702  p_link = link;
703 }

References p_link.

Referenced by platexobj_toMenuAll().

+ Here is the caller graph for this function:

◆ setMainPageLink()

void PFullMenu::setMainPageLink ( const PString &  mainPageLink)

Sets the mainPageLink of the PFullMenu.

Parameters
mainPageLink: mainPageLink of the PFullMenu

Definition at line 722 of file PLatexObj.cpp.

722  {
723  p_mainPageLink = mainPageLink;
724 }

References p_mainPageLink.

Referenced by platexobj_toMenu().

+ Here is the caller graph for this function:

◆ setText()

void PFullMenu::setText ( const PString &  text)

Sets the text of the PFullMenu.

Parameters
text: text of the PFullMenu

Definition at line 708 of file PLatexObj.cpp.

708  {
709  p_text = text;
710 }

References p_text.

Referenced by platexobj_toMenuAll().

+ Here is the caller graph for this function:

◆ setVecSubMenu()

void PFullMenu::setVecSubMenu ( const std::vector< PFullMenu > &  vecSubMenu)

Sets the vecSubMenu of the PFullMenu.

Parameters
vecSubMenu: vecSubMenu of the PFullMenu

Definition at line 715 of file PLatexObj.cpp.

715  {
716  p_vecSubMenu = vecSubMenu;
717 }

References p_vecSubMenu.

Member Data Documentation

◆ p_isExpanded

bool PFullMenu::p_isExpanded
private

True if the current menu has to be expanded, false otherwise.

Definition at line 200 of file PLatexObj.h.

Referenced by copyPFullMenu(), getIsExpanded(), initialisationPFullMenu(), and setIsExpanded().

◆ p_isFirstExpanded

bool PFullMenu::p_isFirstExpanded
private

True if the current menu was the first which has to be expanded, false otherwise.

Definition at line 202 of file PLatexObj.h.

Referenced by copyPFullMenu(), getIsFirstExpanded(), initialisationPFullMenu(), and setIsFirstExpanded().

◆ p_isSeparator

bool PFullMenu::p_isSeparator
private

True if the entry is a menu separator.

Definition at line 204 of file PLatexObj.h.

Referenced by copyPFullMenu(), getIsSeparator(), initialisationPFullMenu(), and setIsSeparator().

◆ p_link

PString PFullMenu::p_link
private

Link.

Definition at line 206 of file PLatexObj.h.

Referenced by copyPFullMenu(), getLink(), initialisationPFullMenu(), and setLink().

◆ p_mainPageLink

PString PFullMenu::p_mainPageLink
private

Main Page link.

Definition at line 212 of file PLatexObj.h.

Referenced by copyPFullMenu(), getMainPageLink(), initialisationPFullMenu(), and setMainPageLink().

◆ p_text

PString PFullMenu::p_text
private

Text.

Definition at line 208 of file PLatexObj.h.

Referenced by copyPFullMenu(), getText(), initialisationPFullMenu(), and setText().

◆ p_vecSubMenu

std::vector<PFullMenu> PFullMenu::p_vecSubMenu
private

Vector of sub-menu.

Definition at line 210 of file PLatexObj.h.

Referenced by copyPFullMenu(), getVecSubMenu(), and setVecSubMenu().

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