xlnt/source/detail/relationship_serializer.hpp

65 lines
2.2 KiB
C++
Raw Normal View History

2015-12-25 06:10:02 +08:00
// Copyright (c) 2014-2016 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, WRISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file
2015-10-30 01:46:56 +08:00
#pragma once
#include <string>
2015-10-30 01:46:56 +08:00
#include <vector>
#include <xlnt/xlnt_config.hpp>
2015-10-30 01:46:56 +08:00
namespace xlnt {
2015-10-30 01:46:56 +08:00
class relationship;
2015-10-31 06:54:04 +08:00
class zip_file;
2015-10-30 01:46:56 +08:00
2015-11-04 07:26:33 +08:00
/// <summary>
/// Reads and writes collections of relationshps for a particular file.
/// </summary>
class XLNT_CLASS relationship_serializer
2015-10-30 01:46:56 +08:00
{
2015-11-04 07:26:33 +08:00
public:
/// <summary>
/// Construct a serializer which operates on archive.
/// </summary>
relationship_serializer(zip_file &archive);
2016-01-18 14:23:31 +08:00
2015-11-04 07:26:33 +08:00
/// <summary>
/// Return a vector of relationships corresponding to target.
/// </summary>
std::vector<relationship> read_relationships(const std::string &target);
2016-01-18 14:23:31 +08:00
2015-11-04 07:26:33 +08:00
/// <summary>
/// Write relationships to archive for the given target.
/// </summary>
bool write_relationships(const std::vector<relationship> &relationships, const std::string &target);
2016-01-18 14:23:31 +08:00
2015-11-04 07:26:33 +08:00
private:
/// <summary>
/// Internal archive which is used for reading and writing.
/// </summary>
zip_file &archive_;
2015-10-30 01:46:56 +08:00
};
2015-10-30 01:46:56 +08:00
} // namespace xlnt