KiCad PCB EDA Suite
|
#include <deque>
#include <geometry/shape_line_chain.h>
#include <api/serializable.h>
#include <core/typeinfo.h>
#include <eda_item_flags.h>
#include <eda_search_data.h>
#include <view/view_item.h>
#include <kiid.h>
Go to the source code of this file.
Classes | |
class | EDA_ITEM |
A base class for most all the KiCad significant classes used in schematics and boards. More... | |
struct | CompareByUuid |
Comparison functor for sorting EDA_ITEM pointers by their UUID. More... | |
Namespaces | |
namespace | |
namespace | google::protobuf |
Macros | |
#define | IGNORE_PARENT_GROUP false |
Typedefs | |
typedef std::function< INSPECT_RESULT(EDA_ITEM *aItem, void *aTestData) > | INSPECTOR_FUNC |
Used to inspect and possibly collect the (search) results of iterating over a list or tree of KICAD_T objects. | |
typedef const INSPECTOR_FUNC & | INSPECTOR |
std::function passed to nested users by ref, avoids copying std::function. | |
typedef std::vector< EDA_ITEM * > | EDA_ITEMS |
Define list of drawing items for screens. | |
typedef std::set< EDA_ITEM *, CompareByUuid > | EDA_ITEM_SET |
Enumerations | |
enum class | INSPECT_RESULT { QUIT , CONTINUE } |
enum | RECURSE_MODE { RECURSE , NO_RECURSE } |
Functions | |
EDA_ITEM * | new_clone (const EDA_ITEM &aItem) |
Provide cloning capabilities for all Boost pointer containers of EDA_ITEM pointers. | |
#define IGNORE_PARENT_GROUP false |
Definition at line 55 of file eda_item.h.
typedef std::set< EDA_ITEM*, CompareByUuid > EDA_ITEM_SET |
Definition at line 568 of file eda_item.h.
Define list of drawing items for screens.
The standard C++ container was chosen so the pointer can be removed from a list without it being destroyed.
Definition at line 566 of file eda_item.h.
typedef const INSPECTOR_FUNC& INSPECTOR |
std::function passed to nested users by ref, avoids copying std::function.
Definition at line 91 of file eda_item.h.
typedef std::function< INSPECT_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC |
Used to inspect and possibly collect the (search) results of iterating over a list or tree of KICAD_T objects.
Provide an implementation as needed to inspect EDA_ITEMs visited via EDA_ITEM::Visit() and EDA_ITEM::IterateForward().
FYI the std::function may hold a lambda, std::bind, pointer to func, or ptr to member function, per modern C++. It is used primarily for searching, but not limited to that. It can also collect or modify the scanned objects. 'Capturing' lambdas are particularly convenient because they can use context and this often means aTestData is not used.
aItem | An EDA_ITEM to examine. |
aTestData | is arbitrary data needed by the inspector to determine if the EDA_ITEM under test meets its match criteria, and is often NULL with the advent of capturing lambdas. |
Definition at line 88 of file eda_item.h.
|
strong |
Enumerator | |
---|---|
QUIT | |
CONTINUE |
Definition at line 43 of file eda_item.h.
enum RECURSE_MODE |
Enumerator | |
---|---|
RECURSE | |
NO_RECURSE |
Definition at line 49 of file eda_item.h.
Provide cloning capabilities for all Boost pointer containers of EDA_ITEM pointers.
aItem | EDA_ITEM to clone. |
Definition at line 541 of file eda_item.h.
References EDA_ITEM::Clone().