KiCad PCB EDA Suite
TOOL_EVENT_LIST Class Reference

A list of TOOL_EVENTs, with overloaded || operators allowing for concatenating TOOL_EVENTs with little code. More...

#include <tool_event.h>

Public Types

typedef TOOL_EVENT value_type
 
typedef std::deque< TOOL_EVENT >::iterator iterator
 
typedef std::deque< TOOL_EVENT >::const_iterator const_iterator
 Default constructor. Creates an empty list. More...
 

Public Member Functions

 TOOL_EVENT_LIST ()
 Constructor for a list containing only one TOOL_EVENT. More...
 
 TOOL_EVENT_LIST (const TOOL_EVENT &aSingleEvent)
 Copy an existing TOOL_EVENT_LIST. More...
 
 TOOL_EVENT_LIST (const TOOL_EVENT_LIST &aEventList)
 
const std::string Format () const
 Function Format() Returns information about event in form of a human-readable string. More...
 
OPT< const TOOL_EVENT & > Matches (const TOOL_EVENT &aEvent) const
 
void Add (const TOOL_EVENT &aEvent)
 Add a tool event to the list. More...
 
iterator begin ()
 
iterator end ()
 
const_iterator cbegin () const
 
const_iterator cend () const
 
int size () const
 
void clear ()
 
TOOL_EVENT_LISToperator= (const TOOL_EVENT_LIST &aEventList)
 
TOOL_EVENT_LISToperator= (const TOOL_EVENT &aEvent)
 
TOOL_EVENT_LISToperator|| (const TOOL_EVENT &aEvent)
 
TOOL_EVENT_LISToperator|| (const TOOL_EVENT_LIST &aEvent)
 

Private Attributes

std::deque< TOOL_EVENTm_events
 

Detailed Description

A list of TOOL_EVENTs, with overloaded || operators allowing for concatenating TOOL_EVENTs with little code.

Definition at line 554 of file tool_event.h.

Member Typedef Documentation

◆ const_iterator

Default constructor. Creates an empty list.

Definition at line 559 of file tool_event.h.

◆ iterator

Definition at line 558 of file tool_event.h.

◆ value_type

Definition at line 557 of file tool_event.h.

Constructor & Destructor Documentation

◆ TOOL_EVENT_LIST() [1/3]

TOOL_EVENT_LIST::TOOL_EVENT_LIST ( )
inline

Constructor for a list containing only one TOOL_EVENT.

Definition at line 562 of file tool_event.h.

◆ TOOL_EVENT_LIST() [2/3]

TOOL_EVENT_LIST::TOOL_EVENT_LIST ( const TOOL_EVENT aSingleEvent)
inline

Copy an existing TOOL_EVENT_LIST.

Definition at line 566 of file tool_event.h.

References m_events.

◆ TOOL_EVENT_LIST() [3/3]

TOOL_EVENT_LIST::TOOL_EVENT_LIST ( const TOOL_EVENT_LIST aEventList)
inline

Definition at line 572 of file tool_event.h.

573  {
574  m_events.clear();
575 
576  for( const TOOL_EVENT& event : aEventList.m_events )
577  m_events.push_back( event );
578  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669
Generic, UI-independent tool event.
Definition: tool_event.h:152

References m_events.

Member Function Documentation

◆ Add()

void TOOL_EVENT_LIST::Add ( const TOOL_EVENT aEvent)
inline

Add a tool event to the list.

Parameters
aEventis the tool event to be added.

Definition at line 604 of file tool_event.h.

605  {
606  m_events.push_back( aEvent );
607  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

Referenced by operator||(), and operator||().

◆ begin()

iterator TOOL_EVENT_LIST::begin ( )
inline

Definition at line 609 of file tool_event.h.

610  {
611  return m_events.begin();
612  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

◆ cbegin()

const_iterator TOOL_EVENT_LIST::cbegin ( ) const
inline

Definition at line 619 of file tool_event.h.

620  {
621  return m_events.begin();
622  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

◆ cend()

const_iterator TOOL_EVENT_LIST::cend ( ) const
inline

Definition at line 624 of file tool_event.h.

625  {
626  return m_events.end();
627  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

◆ clear()

void TOOL_EVENT_LIST::clear ( )
inline

Definition at line 634 of file tool_event.h.

635  {
636  m_events.clear();
637  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ end()

iterator TOOL_EVENT_LIST::end ( )
inline

Definition at line 614 of file tool_event.h.

615  {
616  return m_events.end();
617  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

◆ Format()

const std::string TOOL_EVENT_LIST::Format ( ) const

Function Format() Returns information about event in form of a human-readable string.

Returns
Event information.

Definition at line 188 of file tool_event.cpp.

189 {
190  std::string s;
191 
192  for( const TOOL_EVENT& e : m_events )
193  s += e.Format() + " ";
194 
195  return s;
196 }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669
Generic, UI-independent tool event.
Definition: tool_event.h:152

References m_events.

◆ Matches()

OPT<const TOOL_EVENT&> TOOL_EVENT_LIST::Matches ( const TOOL_EVENT aEvent) const
inline

Definition at line 588 of file tool_event.h.

589  {
590  for( const TOOL_EVENT& event : m_events )
591  {
592  if( event.Matches( aEvent ) )
593  return event;
594  }
595 
596  return OPT<const TOOL_EVENT&>();
597  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669
Generic, UI-independent tool event.
Definition: tool_event.h:152
boost::optional< T > OPT
Definition: optional.h:7

References m_events.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ operator=() [1/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator= ( const TOOL_EVENT_LIST aEventList)
inline

Definition at line 639 of file tool_event.h.

640  {
641  m_events.clear();
642 
643  for( const TOOL_EVENT& event : aEventList.m_events )
644  m_events.push_back( event );
645 
646  return *this;
647  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669
Generic, UI-independent tool event.
Definition: tool_event.h:152

References m_events.

◆ operator=() [2/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator= ( const TOOL_EVENT aEvent)
inline

Definition at line 649 of file tool_event.h.

650  {
651  m_events.clear();
652  m_events.push_back( aEvent );
653  return *this;
654  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

◆ operator||() [1/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator|| ( const TOOL_EVENT aEvent)
inline

Definition at line 656 of file tool_event.h.

657  {
658  Add( aEvent );
659  return *this;
660  }
void Add(const TOOL_EVENT &aEvent)
Add a tool event to the list.
Definition: tool_event.h:604

References Add().

◆ operator||() [2/2]

TOOL_EVENT_LIST& TOOL_EVENT_LIST::operator|| ( const TOOL_EVENT_LIST aEvent)
inline

Definition at line 662 of file tool_event.h.

663  {
664  std::copy( aEvent.m_events.begin(), aEvent.m_events.end(), std::back_inserter( m_events ) );
665  return *this;
666  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

◆ size()

int TOOL_EVENT_LIST::size ( ) const
inline

Definition at line 629 of file tool_event.h.

630  {
631  return m_events.size();
632  }
std::deque< TOOL_EVENT > m_events
Definition: tool_event.h:669

References m_events.

Member Data Documentation

◆ m_events

std::deque<TOOL_EVENT> TOOL_EVENT_LIST::m_events
private

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