EDA_MSG_PANEL Class Reference

A panel to display various information messages. More...

#include <msgpanel.h>

Inheritance diagram for EDA_MSG_PANEL:

Public Member Functions
	EDA_MSG_PANEL (wxWindow *aParent, int aId, const wxPoint &aPosition, const wxSize &aSize, long style=wxTAB_TRAVERSAL, const wxString &name=wxPanelNameStr)
	~EDA_MSG_PANEL ()
void	OnPaint (wxPaintEvent &aEvent)
void	EraseMsgBox ()
void	SetMessage (int aXPosition, const wxString &aUpperText, const wxString &aLowerText)
	Set a message at aXPosition to aUpperText and aLowerText in the message panel. More...
void	AppendMessage (const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
	Append a message to the message panel. More...
void	AppendMessage (const MSG_PANEL_ITEM &aMessageItem)
	Append aMessageItem to the message panel. More...

Static Public Member Functions
static int	GetRequiredHeight ()
	Return the required height (in pixels) of a EDA_MSG_PANEL. More...

Protected Member Functions
void	showItem (wxDC &dc, const MSG_PANEL_ITEM &aItem)
void	erase (wxDC *DC)
wxSize	computeTextSize (const wxString &text) const
	Calculate the width and height of a text string using the system UI font. More...

Static Protected Member Functions
static wxSize	computeFontSize ()
	Compute the height and width of a 'W' in the system font. More...

Protected Attributes
MSG_PANEL_ITEMS	m_Items
int	m_last_x
	the last used x coordinate More...
wxSize	m_fontSize

Detailed Description

A panel to display various information messages.

Definition at line 103 of file msgpanel.h.

Constructor & Destructor Documentation

EDA_MSG_PANEL()

EDA_MSG_PANEL::EDA_MSG_PANEL	(	wxWindow *	aParent,
		int	aId,
		const wxPoint &	aPosition,
		const wxSize &	aSize,
		long	style = wxTAB_TRAVERSAL,
		const wxString &	name = wxPanelNameStr
	)

Definition at line 44 of file msgpanel.cpp.

                                                                 :
    wxPanel( aParent, aId, aPosition, aSize, style, name )
{
    SetFont( wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT ) );
    SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE ) );

    // informs wx not to paint the background itself as we will paint it later in erase()
    SetBackgroundStyle( wxBG_STYLE_PAINT );

    m_last_x = 0;

    m_fontSize = computeFontSize();
}

~EDA_MSG_PANEL()

EDA_MSG_PANEL::~EDA_MSG_PANEL

(

)

Definition at line 61 of file msgpanel.cpp.

{
}

Member Function Documentation

AppendMessage() [1/2]

void EDA_MSG_PANEL::AppendMessage	(	const wxString &	aUpperText,
		const wxString &	aLowerText,
		int	aPadding = 6
	)

Append a message to the message panel.

This method automatically adjusts for the width of the text string. Making consecutive calls to AppendMessage will append each message to the right of the last message. This message is not compatible with Affiche_1_Parametre.

Parameters

aUpperText	The message upper text.
aLowerText	The message lower text.
aPadding	Number of spaces to pad between messages (default = 4).

Definition at line 119 of file msgpanel.cpp.

{
    wxString    text;
    wxSize      drawSize = GetClientSize();

    text = ( aUpperText.Len() > aLowerText.Len() ) ? aUpperText : aLowerText;
    text.Append( ' ', aPadding );

    MSG_PANEL_ITEM item;

    /* Don't put the first message a window client position 0.  Offset by
     * one 'W' character width. */
    if( m_last_x == 0 )
        m_last_x = m_fontSize.x;

    item.m_X = m_last_x;

    item.m_UpperY = ( drawSize.y / 2 ) - m_fontSize.y;
    item.m_LowerY = drawSize.y - m_fontSize.y;

    item.m_UpperText = aUpperText;
    item.m_LowerText = aLowerText;
    m_Items.push_back( item );
    m_last_x += computeTextSize( text ).x;

    // Add an extra space between texts for a better look:
    m_last_x += m_fontSize.x;

    Refresh();
}

References computeTextSize(), m_fontSize, m_Items, m_last_x, MSG_PANEL_ITEM::m_LowerText, MSG_PANEL_ITEM::m_LowerY, MSG_PANEL_ITEM::m_UpperText, MSG_PANEL_ITEM::m_UpperY, MSG_PANEL_ITEM::m_X, Refresh(), and text.

Referenced by AppendMessage(), EDA_DRAW_FRAME::AppendMsgPanel(), and EDA_DRAW_FRAME::SetMsgPanel().

AppendMessage() [2/2]

void EDA_MSG_PANEL::AppendMessage ( const MSG_PANEL_ITEM &  aMessageItem )

inline

Append aMessageItem to the message panel.

Parameters

aMessageItem

is a reference to an MSG_PANEL_ITEM containing the message to append to the panel.

Definition at line 151 of file msgpanel.h.

    {
        AppendMessage( aMessageItem.GetUpperText(), aMessageItem.GetLowerText(),
                       aMessageItem.GetPadding() );
    }

References AppendMessage(), MSG_PANEL_ITEM::GetLowerText(), MSG_PANEL_ITEM::GetPadding(), and MSG_PANEL_ITEM::GetUpperText().

computeFontSize()

wxSize EDA_MSG_PANEL::computeFontSize ( )

staticprotected

Compute the height and width of a 'W' in the system font.

Definition at line 66 of file msgpanel.cpp.

{
    // Get size of the wxSYS_DEFAULT_GUI_FONT
    wxSize     fontSizeInPixels;

    wxScreenDC dc;

    dc.SetFont( wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT ) );
    dc.GetTextExtent( wxT( "W" ), &fontSizeInPixels.x, &fontSizeInPixels.y );

    return fontSizeInPixels;
}

Referenced by GetRequiredHeight().

computeTextSize()

wxSize EDA_MSG_PANEL::computeTextSize ( const wxString &  text ) const

protected

Calculate the width and height of a text string using the system UI font.

Definition at line 87 of file msgpanel.cpp.

{
    // Get size of the wxSYS_DEFAULT_GUI_FONT
    wxSize     textSizeInPixels;

    wxScreenDC dc;

    dc.SetFont( wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT ) );
    dc.GetTextExtent( aText, &textSizeInPixels.x, &textSizeInPixels.y );

    return textSizeInPixels;
}

Referenced by AppendMessage().

erase()

void EDA_MSG_PANEL::erase ( wxDC *  DC )

protected

Definition at line 231 of file msgpanel.cpp.

{
    wxPen   pen;
    wxBrush brush;

    wxSize  size  = GetClientSize();
    wxColour color = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE );

    pen.SetColour( color );

    brush.SetColour( color );
    brush.SetStyle( wxBRUSHSTYLE_SOLID );

    aDC->SetPen( pen );
    aDC->SetBrush( brush );
    aDC->DrawRectangle( 0, 0, size.x, size.y );
}

References color.

Referenced by OnPaint().

EraseMsgBox()

void EDA_MSG_PANEL::EraseMsgBox

(

)

Definition at line 223 of file msgpanel.cpp.

{
   m_Items.clear();
   m_last_x = 0;
   Refresh();
}

References m_Items, m_last_x, and Refresh().

Referenced by EDA_DRAW_FRAME::ClearMsgPanel(), EDA_DRAW_FRAME::EraseMsgBox(), and EDA_DRAW_FRAME::SetMsgPanel().

GetRequiredHeight()

int EDA_MSG_PANEL::GetRequiredHeight ( )

static

Return the required height (in pixels) of a EDA_MSG_PANEL.

This takes into consideration the system gui font, wxSYS_DEFAULT_GUI_FONT.

Definition at line 80 of file msgpanel.cpp.

{
    // make space for two rows of text plus a number of pixels between them.
    return 2 * computeFontSize().y + 0;
}

References computeFontSize().

Referenced by EDA_DRAW_FRAME::EDA_DRAW_FRAME().

OnPaint()

void EDA_MSG_PANEL::OnPaint

(

wxPaintEvent &

aEvent

)

Definition at line 101 of file msgpanel.cpp.

{
    wxPaintDC dc( this );

    erase( &dc );

    dc.SetBackground( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE ) );
    dc.SetBackgroundMode( wxSOLID );
    dc.SetTextBackground( wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE ) );
    dc.SetFont( wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT ) );

    for( const MSG_PANEL_ITEM& item : m_Items )
        showItem( dc, item );

    aEvent.Skip();
}

References erase(), m_Items, and showItem().

SetMessage()

void EDA_MSG_PANEL::SetMessage	(	int	aXPosition,
		const wxString &	aUpperText,
		const wxString &	aLowerText
	)

Set a message at aXPosition to aUpperText and aLowerText in the message panel.

Parameters

aXPosition	The horizontal position to display the message or less than zero to set the message using the last message position.
aUpperText	The text to be displayed in top line.
aLowerText	The text to be displayed in bottom line.

Definition at line 152 of file msgpanel.cpp.

{
    wxPoint pos;
    wxSize drawSize = GetClientSize();

    if( aXPosition >= 0 )
        m_last_x = pos.x = aXPosition * (m_fontSize.x + 2);
    else
        pos.x = m_last_x;

    MSG_PANEL_ITEM item;

    item.m_X = pos.x;

    item.m_UpperY = (drawSize.y / 2) - m_fontSize.y;
    item.m_LowerY = drawSize.y - m_fontSize.y;

    item.m_UpperText = aUpperText;
    item.m_LowerText = aLowerText;

    int ndx;

    // update the vector, which is sorted by m_X
    int limit = m_Items.size();

    for( ndx=0;  ndx<limit;  ++ndx )
    {
        // replace any item with same X
        if( m_Items[ndx].m_X == item.m_X )
        {
            m_Items[ndx] = item;
            break;
        }

        if( m_Items[ndx].m_X > item.m_X )
        {
            m_Items.insert( m_Items.begin() + ndx, item );
            break;
        }
    }

    if( ndx == limit )        // mutually exclusive with two above if tests
        m_Items.push_back( item );

    Refresh();
}

References m_fontSize, m_Items, m_last_x, MSG_PANEL_ITEM::m_LowerText, MSG_PANEL_ITEM::m_LowerY, MSG_PANEL_ITEM::m_UpperText, MSG_PANEL_ITEM::m_UpperY, MSG_PANEL_ITEM::m_X, and Refresh().

showItem()

void EDA_MSG_PANEL::showItem ( wxDC &  dc, const MSG_PANEL_ITEM &  aItem  )

protected

Definition at line 201 of file msgpanel.cpp.

{
    COLOR4D color;

    // Change the text to a disabled color when the window isn't active
    wxTopLevelWindow* tlw = dynamic_cast<wxTopLevelWindow*>( wxGetTopLevelParent( this ) );

    if( tlw && !tlw->IsActive() )
        color = wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT );
    else
        color = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT );

    aDC.SetTextForeground( color.ToColour() );

    if( !aItem.m_UpperText.IsEmpty() )
        aDC.DrawText( aItem.m_UpperText, aItem.m_X, aItem.m_UpperY );

    if( !aItem.m_LowerText.IsEmpty() )
        aDC.DrawText( aItem.m_LowerText, aItem.m_X, aItem.m_LowerY );
}

References color, MSG_PANEL_ITEM::m_LowerText, MSG_PANEL_ITEM::m_LowerY, MSG_PANEL_ITEM::m_UpperText, MSG_PANEL_ITEM::m_UpperY, and MSG_PANEL_ITEM::m_X.

Referenced by OnPaint().

Member Data Documentation

m_fontSize

wxSize EDA_MSG_PANEL::m_fontSize

protected

Definition at line 176 of file msgpanel.h.

Referenced by AppendMessage(), and SetMessage().

m_Items

MSG_PANEL_ITEMS EDA_MSG_PANEL::m_Items

protected

Definition at line 174 of file msgpanel.h.

Referenced by AppendMessage(), EraseMsgBox(), OnPaint(), and SetMessage().

m_last_x

int EDA_MSG_PANEL::m_last_x

protected

the last used x coordinate

Definition at line 175 of file msgpanel.h.

Referenced by AppendMessage(), EraseMsgBox(), and SetMessage().

---

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

• msgpanel.h
• msgpanel.cpp