kicad/eeschema/api/api_handler_sch.h

75 lines
2.6 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2024 Jon Evans <jon@craftyjon.com>
* Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KICAD_API_HANDLER_SCH_H
#define KICAD_API_HANDLER_SCH_H
#include <api/api_handler_editor.h>
#include <api/common/commands/editor_commands.pb.h>
#include <kiid.h>
using namespace kiapi;
using namespace kiapi::common;
class SCH_EDIT_FRAME;
class SCH_ITEM;
class API_HANDLER_SCH : public API_HANDLER_EDITOR
{
public:
API_HANDLER_SCH( SCH_EDIT_FRAME* aFrame );
protected:
std::unique_ptr<COMMIT> createCommit() override;
kiapi::common::types::DocumentType thisDocumentType() const override
{
return kiapi::common::types::DOCTYPE_SCHEMATIC;
}
bool validateDocumentInternal( const DocumentSpecifier& aDocument ) const override;
HANDLER_RESULT<std::unique_ptr<EDA_ITEM>> createItemForType( KICAD_T aType,
EDA_ITEM* aContainer );
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;
void deleteItemsInternal( std::map<KIID, ItemDeletionStatus>& aItemsToDelete,
const HANDLER_CONTEXT& aCtx ) override;
std::optional<EDA_ITEM*> getItemFromDocument( const DocumentSpecifier& aDocument,
const KIID& aId ) override;
private:
HANDLER_RESULT<commands::GetOpenDocumentsResponse> handleGetOpenDocuments(
commands::GetOpenDocuments& aMsg, const HANDLER_CONTEXT& aCtx );
SCH_EDIT_FRAME* m_frame;
};
#endif //KICAD_API_HANDLER_SCH_H