KiCad PCB EDA Suite
MSG_PANEL_ITEM Class Reference

EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages. More...

#include <msgpanel.h>

Public Member Functions

 MSG_PANEL_ITEM (const wxString &aUpperText, const wxString &aLowerText, COLOR4D aColor, int aPad=MSG_PANEL_DEFAULT_PAD)
 
 MSG_PANEL_ITEM ()
 
void SetUpperText (const wxString &aUpperText)
 
const wxString & GetUpperText () const
 
void SetLowerText (const wxString &aLowerText)
 
const wxString & GetLowerText () const
 
void SetColor (COLOR4D aColor)
 
COLOR4D GetColor () const
 
void SetPadding (int aPad)
 
int GetPadding () const
 

Private Attributes

int m_X
 
int m_UpperY
 
int m_LowerY
 
wxString m_UpperText
 
wxString m_LowerText
 
COLOR4D m_Color
 
int m_Pad
 

Friends

class EDA_MSG_PANEL
 

Detailed Description

EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.

Definition at line 54 of file msgpanel.h.

Constructor & Destructor Documentation

◆ MSG_PANEL_ITEM() [1/2]

MSG_PANEL_ITEM::MSG_PANEL_ITEM ( const wxString &  aUpperText,
const wxString &  aLowerText,
COLOR4D  aColor,
int  aPad = MSG_PANEL_DEFAULT_PAD 
)
inline

Definition at line 67 of file msgpanel.h.

68  :
69  m_UpperText( aUpperText ),
70  m_LowerText( aLowerText ),
71  m_Color( aColor ),
72  m_Pad( aPad )
73  {
74  m_X = 0;
75  m_UpperY = 0;
76  m_LowerY = 0;
77  }
COLOR4D m_Color
Definition: msgpanel.h:61
wxString m_LowerText
Definition: msgpanel.h:60
wxString m_UpperText
Definition: msgpanel.h:59

References m_LowerY, m_UpperY, and m_X.

◆ MSG_PANEL_ITEM() [2/2]

MSG_PANEL_ITEM::MSG_PANEL_ITEM ( )
inline

Definition at line 79 of file msgpanel.h.

79  :
81 
82  {
83  m_X = 0;
84  m_UpperY = 0;
85  m_LowerY = 0;
86  m_Color = COLOR4D::UNSPECIFIED;
87  }
COLOR4D m_Color
Definition: msgpanel.h:61
#define MSG_PANEL_DEFAULT_PAD
The default number of spaces between each text string.
Definition: msgpanel.h:44

References m_Color, m_LowerY, m_UpperY, and m_X.

Member Function Documentation

◆ GetColor()

COLOR4D MSG_PANEL_ITEM::GetColor ( ) const
inline

Definition at line 96 of file msgpanel.h.

96 { return m_Color; }
COLOR4D m_Color
Definition: msgpanel.h:61

References m_Color.

Referenced by EDA_MSG_PANEL::AppendMessage().

◆ GetLowerText()

const wxString& MSG_PANEL_ITEM::GetLowerText ( ) const
inline

Definition at line 93 of file msgpanel.h.

93 { return m_LowerText; }
wxString m_LowerText
Definition: msgpanel.h:60

References m_LowerText.

Referenced by EDA_MSG_PANEL::AppendMessage().

◆ GetPadding()

int MSG_PANEL_ITEM::GetPadding ( ) const
inline

Definition at line 99 of file msgpanel.h.

99 { return m_Pad; }

References m_Pad.

Referenced by EDA_MSG_PANEL::AppendMessage().

◆ GetUpperText()

const wxString& MSG_PANEL_ITEM::GetUpperText ( ) const
inline

Definition at line 90 of file msgpanel.h.

90 { return m_UpperText; }
wxString m_UpperText
Definition: msgpanel.h:59

References m_UpperText.

Referenced by EDA_MSG_PANEL::AppendMessage().

◆ SetColor()

void MSG_PANEL_ITEM::SetColor ( COLOR4D  aColor)
inline

Definition at line 95 of file msgpanel.h.

95 { m_Color = aColor; }
COLOR4D m_Color
Definition: msgpanel.h:61

References m_Color.

◆ SetLowerText()

void MSG_PANEL_ITEM::SetLowerText ( const wxString &  aLowerText)
inline

Definition at line 92 of file msgpanel.h.

92 { m_LowerText = aLowerText; }
wxString m_LowerText
Definition: msgpanel.h:60

References m_LowerText.

◆ SetPadding()

void MSG_PANEL_ITEM::SetPadding ( int  aPad)
inline

Definition at line 98 of file msgpanel.h.

98 { m_Pad = aPad; }

References m_Pad.

◆ SetUpperText()

void MSG_PANEL_ITEM::SetUpperText ( const wxString &  aUpperText)
inline

Definition at line 89 of file msgpanel.h.

89 { m_UpperText = aUpperText; }
wxString m_UpperText
Definition: msgpanel.h:59

References m_UpperText.

Friends And Related Function Documentation

◆ EDA_MSG_PANEL

friend class EDA_MSG_PANEL
friend

Definition at line 64 of file msgpanel.h.

Member Data Documentation

◆ m_Color

COLOR4D MSG_PANEL_ITEM::m_Color
private

◆ m_LowerText

wxString MSG_PANEL_ITEM::m_LowerText
private

◆ m_LowerY

int MSG_PANEL_ITEM::m_LowerY
private

◆ m_Pad

int MSG_PANEL_ITEM::m_Pad
private

Definition at line 62 of file msgpanel.h.

Referenced by GetPadding(), and SetPadding().

◆ m_UpperText

wxString MSG_PANEL_ITEM::m_UpperText
private

◆ m_UpperY

int MSG_PANEL_ITEM::m_UpperY
private

◆ m_X

int MSG_PANEL_ITEM::m_X
private

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