---

DataMergeParams.h

Go to the documentation of this file.

/**
* @file         DataMergeParams.h
* @brief    Edit option class for the data-merge
*
* @author   Nakashima h
* @date     2021-10-06
*
* $Id: DataMergeParams.h 32 2022-07-14 03:20:43Z shingo.yoneda $
*
* Copyright (c) 2020-2022 Antenna House, Inc. All rights reserved.
*/

#pragma once
#include <string>

/**
* @brief    Common option for the data-merge
*/
struct CommonOption {
    /**
    * @brief    Position of the additional character string to the output file name
    */
    enum AddingStrPlacePattern {
        /**
        * @brief    Add to the beginning of the output file name (default)
        */
        Head,
        /**
        * @brief    Add to the end of the output file name
        */
        Tail
    };

    /**
    * @brief    Control when cell data-merge overflows the cell width
    */
    enum CellStrOverflowRule {
        /**
        * @brief    Line break (default)
        */
        Normal,
        /**
        * @brief    Adjust font size
        */
        FontSizeChange,
        /**
        * @brief    Remove excess characters
        */
        CutExcess,
        /**
        * @brief    Converts to paddingfill character
        */
        Padding
    };

    /**
    * @brief    File format for merging data
    */
    enum DataType {
        CSV,
        JSON
    };

    /**
    * @brief    File encoding
    */
    enum DataFileEncoding {
        /**
        * @brief    Shift_JIS
        */
        SJIS,
        /**
        * @brief    UTF-8
        */
        UTF8
    };
};

/**
* @brief    Options for the simple type
*/
struct SimpleTypeOption {
    /**
    * @brief    Output mode for the data-merge data of multiple record
    */
    enum OutputMode {
        /**
        * @brief    Output single file (default)
        */
        Single,
        /**
        * @brief    Output single file for each record
        */
        PerData
    };
};

/**
* @brief    Options for the compound type
*/
struct CompoundTypeOption {
    /**
    * @brief    Row number pattern of breakdown part
    */
    enum RepeatingRowsPattern {
        /**
        * @brief    Fixed row number (default)
        */
        Fixed,
        /**
        * @brief    Variable row number
        */
        Variable
    };

    /**
    * @brief    Style when a breakdown part with a fixed number of rows spans multiple pages
    */
    enum MultiplePagesStyle {
        /**
        * @brief    Copy the entire body area (default)
        */
        RepeatTemplate,
        /**
        * @brief    Repeating the breakdown part
        */
        RepeatDetail
    };

    /**
    * @brief    Editing rule for the footer part with a fixed number of rows
    */
    enum DeletingFooterRule {
        /**
        * @brief    Do not edit (default)
        */
        LeaveAll,
        /**
        * @brief    Delete all footer parts
        */
        DeleteAll,
        /**
        * @brief    Leave the field
        */
        LeaveFld
    };
};

/**
* @brief    Options for nested table type
*/
struct NestedTableTypeOption {
    /**
    * @brief    Width of nested table type
    */
    enum DetailTableType {
        /**
        * @brief    Minimum column width (default)
        */
        FixedMinimum,
        /**
        * @brief    Even column width [\%]
        */
        DividedPct,
        /**
        * @brief    Even column width
        */
        DividedDxa
    };
};

/**
* @brief    Input parameter
*/
struct InputParam {
    /**
    * @brief    Path of the template file for data-merge
    */
    std::string m_input_file_path;
    /**
    * @brief    Path of the data-merge image
    */
    std::string m_input_image_dir = "";

    /**
    * @brief    Control when cell data-merge overflows the cell width
    */
    CommonOption::CellStrOverflowRule m_cell_str_overflow_rule = CommonOption::CellStrOverflowRule::Normal;
    /**
    * @brief    Padding string when the data-merge to cell overflows the cell width
    */
    std::string m_padding_string = "#";

    /**
    * @brief    The data-merge executor
    */
    std::string m_executor = "";
};

/**
* @brief    Output parameter
*/
struct OutputParam {
    /**
    * @brief    Path of the file to output
    */
    std::string m_output_file_path;

    /**
    * @brief    The position of characters to be added to the output file name
    */
    CommonOption::AddingStrPlacePattern m_adding_str_place_pattern = CommonOption::AddingStrPlacePattern::Head;

    /**
    * @brief    The column name for the additional data to the output file
    */
    std::string m_file_add_column;
};

---