clipboard.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 2
 * 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 <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include <wx/buffer.h>
#include <wx/bitmap.h>
#include <wx/image.h>
#include <wx/string.h>
 
class wxDataObjectComposite;
 
struct CLIPBOARD_MIME_DATA
{
    wxString       m_mimeType;
    wxMemoryBuffer m_data;

    std::optional<wxBitmap> m_image;

    bool m_useRawPngData = false;
};

bool SaveClipboard( const std::string& aTextUTF8 );

bool SaveClipboard( const std::string& aTextUTF8, const std::vector<CLIPBOARD_MIME_DATA>& aMimeData );

bool SaveTabularDataToClipboard( const std::vector<std::vector<wxString>>& aData );

bool GetTabularDataFromClipboard( std::vector<std::vector<wxString>>& aData );

std::string GetClipboardUTF8();

std::unique_ptr<wxBitmap> GetImageFromClipboard();

bool EncodeImageToPng( const wxImage& aImage, wxMemoryBuffer& aOutput );

bool AddPngToClipboardData( wxDataObjectComposite* aData, const wxMemoryBuffer& aPngData,
                            const wxImage* aFallbackImage = nullptr );

bool AddTransparentImageToClipboardData( wxDataObjectComposite* aData, wxImage aImage );