---

DataMergeParams.h

Go to the documentation of this file.

/**
* @file         DataMergeParams.h
* @brief    差し込み印刷の編集オプションクラス
*
* @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    差し込み印刷で共通のオプション
*/
struct CommonOption {
    /**
    * @brief    出力ファイル名の文字列の追加位置
    */
    enum AddingStrPlacePattern {
        /**
        * @brief    出力ファイル名の先頭に追加（デフォルト）
        */
        Head,
        /**
        * @brief    出力ファイル名の末尾に追加
        */
        Tail
    };

    /**
    * @brief    セルへの差し込みがセル幅をオーバーした際の制御
    */
    enum CellStrOverflowRule {
        /**
        * @brief    改行（デフォルト）
        */
        Normal,
        /**
        * @brief    フォントサイズを変更
        */
        FontSizeChange,
        /**
        * @brief    超過分を削除
        */
        CutExcess,
        /**
        * @brief    埋め文字へ変更
        */
        Padding
    };

    /**
    * @brief    差し込み印刷データのファイルフォーマット
    */
    enum DataType {
        CSV,
        JSON
    };

    /**
    * @brief    差し込み印刷データのエンコード
    */
    enum DataFileEncoding {
        /**
        * @brief    Shift_JIS
        */
        SJIS,
        /**
        * @brief    UTF-8
        */
        UTF8
    };
};

/**
* @brief    シンプル版のオプション
*/
struct SimpleTypeOption {
    /**
    * @brief    差し込み印刷の複数レコードの差し込み印刷データの際の出力方法
    */
    enum OutputMode {
        /**
        * @brief    1つのファイルを出力（デフォルト）
        */
        Single,
        /**
        * @brief    レコード毎にファイルを出力
        */
        PerData
    };
};

/**
* @brief    複合版のオプション
*/
struct CompoundTypeOption {
    /**
    * @brief    明細部の行数パターン
    */
    enum RepeatingRowsPattern {
        /**
        * @brief    行数固定（デフォルト）
        */
        Fixed,
        /**
        * @brief    行数可変
        */
        Variable
    };

    /**
    * @brief    行数固定の明細表が複数ページに渡る場合のスタイル
    */
    enum MultiplePagesStyle {
        /**
        * @brief    本文領域全体を複製（デフォルト）
        */
        RepeatTemplate,
        /**
        * @brief    明細表の繰り返し
        */
        RepeatDetail
    };

    /**
    * @brief    行数固定のフッター部分の編集ルール
    */
    enum DeletingFooterRule {
        /**
        * @brief    編集を行わない（デフォルト）
        */
        LeaveAll,
        /**
        * @brief    フッター部分をすべて削除
        */
        DeleteAll,
        /**
        * @brief    フィールドを残す
        */
        LeaveFld
    };
};

/**
* @brief    ネスト構造のテーブル版のオプション
*/
struct NestedTableTypeOption {
    /**
    * @brief    ネスト構造のテーブルの幅
    */
    enum DetailTableType {
        /**
        * @brief    最小のカラム幅（デフォルト）
        */
        FixedMinimum,
        /**
        * @brief    均等なカラム幅[\%]
        */
        DividedPct,
        /**
        * @brief    均等なカラム幅
        */
        DividedDxa
    };
};

/**
* @brief    入力パラメータ
*/
struct InputParam {
    /**
    * @brief    差し込み印刷対象のテンプレートファイルのパス
    */
    std::string m_input_file_path;
    /**
    * @brief    差し込み印刷画像のディレクトリのパス
    */
    std::string m_input_image_dir = "";

    /**
    * @brief    セルへの差し込みがセル幅をオーバーした際の制御
    */
    CommonOption::CellStrOverflowRule m_cell_str_overflow_rule = CommonOption::CellStrOverflowRule::Normal;
    /**
    * @brief    セルへの差し込みがセル幅をオーバーした際に埋める文字
    */
    std::string m_padding_string = "#";

    /**
    * @brief    差し込み印刷の実行者
    */
    std::string m_executor = "";
};

/**
* @brief    出力パラメータ
*/
struct OutputParam {
    /**
    * @brief    出力するファイルのパス
    */
    std::string m_output_file_path;

    /**
    * @brief    出力ファイル名への追加する文字の位置
    */
    CommonOption::AddingStrPlacePattern m_adding_str_place_pattern = CommonOption::AddingStrPlacePattern::Head;

    /**
    * @brief    出力ファイルに追加するデータに対応するカラム名
    */
    std::string m_file_add_column;
};

---