mirror of
https://github.com/tfussell/xlnt.git
synced 2024-03-22 13:11:17 +08:00
update docs
This commit is contained in:
parent
9dce7b8f0c
commit
872d6ae16d
|
@ -9,10 +9,7 @@ Welcome to xlnt's documentation!
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 2
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::cell
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenstruct:: xlnt::cell_reference_hash
|
.. doxygenstruct:: xlnt::cell_reference_hash
|
||||||
:members:
|
:members:
|
||||||
|
@ -20,6 +17,9 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::cell_reference
|
.. doxygenclass:: xlnt::cell_reference
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::cell
|
||||||
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::comment
|
.. doxygenclass:: xlnt::comment
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
@ -38,12 +38,6 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::relationship
|
.. doxygenclass:: xlnt::relationship
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::string_table
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::string_table_builder
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenstruct:: xlnt::zip_info
|
.. doxygenstruct:: xlnt::zip_info
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
@ -53,21 +47,12 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::drawing
|
.. doxygenclass:: xlnt::drawing
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::tokenizer
|
||||||
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::translator
|
.. doxygenclass:: xlnt::translator
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::comment_reader
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::excel_reader
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::shared_strings_reader
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::style_reader
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::alignment
|
.. doxygenclass:: xlnt::alignment
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
@ -104,10 +89,13 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::document_security
|
.. doxygenclass:: xlnt::document_security
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::manifest
|
||||||
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::named_range
|
.. doxygenclass:: xlnt::named_range
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenstruct:: xlnt::content_type
|
.. doxygenclass:: xlnt::theme
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::workbook
|
.. doxygenclass:: xlnt::workbook
|
||||||
|
@ -119,6 +107,9 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::column_properties
|
.. doxygenclass:: xlnt::column_properties
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
.. doxygenstruct:: xlnt::major_order
|
||||||
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::page_margins
|
.. doxygenclass:: xlnt::page_margins
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
@ -128,10 +119,13 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::pane
|
.. doxygenclass:: xlnt::pane
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::range_reference
|
||||||
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::range
|
.. doxygenclass:: xlnt::range
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::range_reference
|
.. doxygenclass:: xlnt::row_properties
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::sheet_protection
|
.. doxygenclass:: xlnt::sheet_protection
|
||||||
|
@ -140,9 +134,6 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::sheet_view
|
.. doxygenclass:: xlnt::sheet_view
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::row_properties
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::header
|
.. doxygenclass:: xlnt::header
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
@ -158,22 +149,40 @@ Contents:
|
||||||
.. doxygenclass:: xlnt::worksheet
|
.. doxygenclass:: xlnt::worksheet
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::chart_writer
|
.. doxygenclass:: xlnt::comment_serializer
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::chart_writer_factory
|
.. doxygenclass:: xlnt::excel_serializer
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::comment_writer
|
.. doxygenclass:: xlnt::manifest_serializer
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::excel_writer
|
.. doxygenclass:: xlnt::relationship_serializer
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::string_writer
|
.. doxygenclass:: xlnt::shared_strings_serializer
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. doxygenclass:: xlnt::style_writer
|
.. doxygenclass:: xlnt::style_serializer
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::theme_serializer
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::workbook_serializer
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::worksheet_serializer
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::xml_document
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::xml_node
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. doxygenclass:: xlnt::xml_serializer
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
|
|
@ -1,58 +0,0 @@
|
||||||
// Copyright (c) 2015 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
|
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#include <string>
|
|
||||||
#include <vector>
|
|
||||||
|
|
||||||
namespace xlnt {
|
|
||||||
|
|
||||||
class string_table_builder;
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Encapsulates a table of strings used for reading and writing sharedStrings.xml.
|
|
||||||
/// </summary>
|
|
||||||
class string_table
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
int operator[](const std::string &key) const;
|
|
||||||
private:
|
|
||||||
friend class string_table_builder;
|
|
||||||
std::vector<std::string> strings_;
|
|
||||||
};
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Provides a simple interface for using string_table.
|
|
||||||
/// </summary>
|
|
||||||
class string_table_builder
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
void add(const std::string &string);
|
|
||||||
string_table &get_table() { return table_; }
|
|
||||||
const string_table &get_table() const { return table_; }
|
|
||||||
private:
|
|
||||||
string_table table_;
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace xlnt
|
|
|
@ -1,33 +0,0 @@
|
||||||
#include <string>
|
|
||||||
#include <vector>
|
|
||||||
|
|
||||||
namespace xlnt {
|
|
||||||
|
|
||||||
class cell_reference;
|
|
||||||
class tokenizer;
|
|
||||||
|
|
||||||
class translator
|
|
||||||
{
|
|
||||||
translator(const std::string &formula, const cell_reference &ref);
|
|
||||||
|
|
||||||
std::vector<std::string> get_tokens();
|
|
||||||
|
|
||||||
static std::string translate_row(const std::string &row_str, int row_delta);
|
|
||||||
static std::string translate_col(const std::string &col_str, col_delta);
|
|
||||||
|
|
||||||
std::pair<std::string, std::string> strip_ws_name(const std::string &range_str);
|
|
||||||
|
|
||||||
void translate_range(const range_reference &range_ref);
|
|
||||||
void translate_formula(const cell_reference &dest);
|
|
||||||
|
|
||||||
private:
|
|
||||||
const std::string ROW_RANGE_RE;
|
|
||||||
const std::string COL_RANGE_RE;
|
|
||||||
const std::string CELL_REF_RE;
|
|
||||||
|
|
||||||
std::string formula_;
|
|
||||||
cell_reference reference_;
|
|
||||||
tokenizer tokenizer_;
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace xlnt
|
|
|
@ -59,14 +59,6 @@ namespace detail {
|
||||||
struct workbook_impl;
|
struct workbook_impl;
|
||||||
} // namespace detail
|
} // namespace detail
|
||||||
|
|
||||||
struct content_type
|
|
||||||
{
|
|
||||||
bool is_default;
|
|
||||||
std::string extension;
|
|
||||||
std::string part_name;
|
|
||||||
std::string type;
|
|
||||||
};
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// workbook is the container for all other parts of the document.
|
/// workbook is the container for all other parts of the document.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
@ -196,8 +188,6 @@ public:
|
||||||
return !(*this == std::nullptr_t{});
|
return !(*this == std::nullptr_t{});
|
||||||
}
|
}
|
||||||
|
|
||||||
std::vector<content_type> get_content_types() const;
|
|
||||||
|
|
||||||
void create_relationship(const std::string &id, const std::string &target, relationship::type type);
|
void create_relationship(const std::string &id, const std::string &target, relationship::type type);
|
||||||
relationship get_relationship(const std::string &id) const;
|
relationship get_relationship(const std::string &id) const;
|
||||||
const std::vector<relationship> &get_relationships() const;
|
const std::vector<relationship> &get_relationships() const;
|
||||||
|
|
Loading…
Reference in New Issue
Block a user