ERC_HTML_LISTFRAME Class Reference

Class ERC_HTML_LISTFRAME is used to display a DRC_ITEM_LIST. More...

#include <dialog_erc_listbox.h>

Inheritance diagram for ERC_HTML_LISTFRAME:

Public Member Functions
	ERC_HTML_LISTFRAME (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0)
	~ERC_HTML_LISTFRAME ()
void	AppendToList (SCH_MARKER *aMarker)
	Function AppendToList. More...
void	DisplayList ()
	Function DisplayList(); Build the Html marker list and show it. More...
const SCH_MARKER *	GetItem (unsigned aIndex)
	Function GetItem returns a requested DRC_ITEM* or NULL. More...
void	ClearList ()
	Function ClearList deletes all items shown in the list. More...

Private Attributes
std::vector< SCH_MARKER * >	m_MarkerListReferences

Detailed Description

Class ERC_HTML_LISTFRAME is used to display a DRC_ITEM_LIST.

Definition at line 38 of file dialog_erc_listbox.h.

Constructor & Destructor Documentation

ERC_HTML_LISTFRAME::ERC_HTML_LISTFRAME ( wxWindow *  parent, wxWindowID  id = wxID_ANY, const wxPoint &  pos = wxDefaultPosition, const wxSize &  size = wxDefaultSize, long  style = 0  )

inline

Definition at line 44 of file dialog_erc_listbox.h.

                                         :
        wxHtmlWindow( parent, id, pos, size, style | wxHW_NO_SELECTION )
    {
    }

ERC_HTML_LISTFRAME::~ERC_HTML_LISTFRAME ( )

inline

Definition at line 52 of file dialog_erc_listbox.h.

    {
    }

Member Function Documentation

void ERC_HTML_LISTFRAME::AppendToList ( SCH_MARKER *  aMarker )

inline

Function AppendToList.

Parameters

aItem

The SCH_MARKER* to add to the current list which will be later displayed in the wxHtmlWindow

Definition at line 62 of file dialog_erc_listbox.h.

Referenced by DIALOG_ERC::DisplayERC_MarkersList().

    {
        m_MarkerListReferences.push_back( aMarker );
    }

void ERC_HTML_LISTFRAME::ClearList ( )

inline

Function ClearList deletes all items shown in the list.

Does not erase markers in schematic

Definition at line 111 of file dialog_erc_listbox.h.

Referenced by DIALOG_ERC::DisplayERC_MarkersList(), DIALOG_ERC::OnEraseDrcMarkersClick(), and DIALOG_ERC::OnErcCmpClick().

    {
        m_MarkerListReferences.clear();
        SetPage( wxEmptyString );
    }

void ERC_HTML_LISTFRAME::DisplayList ( )

inline

Function DisplayList(); Build the Html marker list and show it.

Definition at line 71 of file dialog_erc_listbox.h.

Referenced by DIALOG_ERC::DisplayERC_MarkersList().

    {
        wxString htmlpage;

        // for each marker, build a link like:
        // <A HREF="marker_index">text to click</A>
        // The "text to click" is the error name (first line of the full error text).
        wxString marker_text;

        for( unsigned ii = 0; ii < m_MarkerListReferences.size(); ii++ )
        {
            marker_text.Printf( wxT( "<A HREF=\"%d\">" ), ii );
            marker_text << m_MarkerListReferences[ii]->GetReporter().ShowHtml();
            marker_text.Replace( wxT( "<ul>" ), wxT( "</A><ul>" ), false );
            htmlpage += marker_text;
        }

        SetPage( htmlpage );
    }

const SCH_MARKER* ERC_HTML_LISTFRAME::GetItem ( unsigned  aIndex )

inline

Function GetItem returns a requested DRC_ITEM* or NULL.

Definition at line 95 of file dialog_erc_listbox.h.

Referenced by DIALOG_ERC::OnLeftClickMarkersList().

    {
        if( m_MarkerListReferences.size() > aIndex )
        {
            return m_MarkerListReferences[ aIndex ];
        }

        return NULL;
    }

Member Data Documentation

std::vector<SCH_MARKER*> ERC_HTML_LISTFRAME::m_MarkerListReferences

private

Definition at line 41 of file dialog_erc_listbox.h.

---

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

• dialog_erc_listbox.h