KiCad PCB EDA Suite
Loading...
Searching...
No Matches
api_handler_sch.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2024 Jon Evans <[email protected]>
5 * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#ifndef KICAD_API_HANDLER_SCH_H
22#define KICAD_API_HANDLER_SCH_H
23
25#include <api/common/commands/editor_commands.pb.h>
26#include <kiid.h>
27
28using namespace kiapi;
29using namespace kiapi::common;
30
31class SCH_EDIT_FRAME;
32class SCH_ITEM;
33
34
36{
37public:
39
40protected:
41 std::unique_ptr<COMMIT> createCommit() override;
42
43 kiapi::common::types::DocumentType thisDocumentType() const override
44 {
45 return kiapi::common::types::DOCTYPE_SCHEMATIC;
46 }
47
48 bool validateDocumentInternal( const DocumentSpecifier& aDocument ) const override;
49
51 EDA_ITEM* aContainer );
52
54 const HANDLER_CONTEXT& aCtx,
55 const types::ItemHeader &aHeader,
56 const google::protobuf::RepeatedPtrField<google::protobuf::Any>& aItems,
57 std::function<void(commands::ItemStatus, google::protobuf::Any)> aItemHandler )
58 override;
59
60 void deleteItemsInternal( std::map<KIID, ItemDeletionStatus>& aItemsToDelete,
61 const HANDLER_CONTEXT& aCtx ) override;
62
63 std::optional<EDA_ITEM*> getItemFromDocument( const DocumentSpecifier& aDocument,
64 const KIID& aId ) override;
65
66private:
68 commands::GetOpenDocuments& aMsg, const HANDLER_CONTEXT& aCtx );
69
71};
72
73
74#endif //KICAD_API_HANDLER_SCH_H
tl::expected< T, ApiResponseStatus > HANDLER_RESULT
Definition: api_handler.h:45
Base class for API handlers related to editor frames.
SCH_EDIT_FRAME * m_frame
std::unique_ptr< COMMIT > createCommit() override
Override this to create an appropriate COMMIT subclass for the frame in question.
std::optional< EDA_ITEM * > getItemFromDocument(const DocumentSpecifier &aDocument, const KIID &aId) override
HANDLER_RESULT< std::unique_ptr< EDA_ITEM > > createItemForType(KICAD_T aType, EDA_ITEM *aContainer)
HANDLER_RESULT< commands::GetOpenDocumentsResponse > handleGetOpenDocuments(commands::GetOpenDocuments &aMsg, const HANDLER_CONTEXT &aCtx)
void deleteItemsInternal(std::map< KIID, ItemDeletionStatus > &aItemsToDelete, const HANDLER_CONTEXT &aCtx) override
kiapi::common::types::DocumentType thisDocumentType() const override
Override this to specify which document type this editor handles.
HANDLER_RESULT< types::ItemRequestStatus > handleCreateUpdateItemsInternal(bool aCreate, const HANDLER_CONTEXT &aCtx, const types::ItemHeader &aHeader, const google::protobuf::RepeatedPtrField< google::protobuf::Any > &aItems, std::function< void(commands::ItemStatus, google::protobuf::Any)> aItemHandler) override
bool validateDocumentInternal(const DocumentSpecifier &aDocument) const override
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
Definition: kiid.h:49
Schematic editor (Eeschema) main window.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78