Skip to content

Example.md

Latest commit

 

History

History
306 lines (222 loc) · 9.12 KB

Example.md

File metadata and controls

306 lines (222 loc) · 9.12 KB

QXlsx Examples

HelloWorld

  • Hello world example
// main.cpp

#include <QtGlobal>
#include <QCoreApplication>
#include <QtCore>
#include <QVariant>
#include <QDebug>

#include <iostream>
using namespace std;

// [0] include QXlsx headers 
#include "xlsxdocument.h"
#include "xlsxchartsheet.h"
#include "xlsxcellrange.h"
#include "xlsxchart.h"
#include "xlsxrichstring.h"
#include "xlsxworkbook.h"
using namespace QXlsx;

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);

    int row = 1; int col = 1;
	
    // [1]  Writing excel file(*.xlsx)
    QXlsx::Document xlsxW;
	QVariant writeValue = QString("Hello Qt!");
    xlsxW.write(row, col, writeValue); // write "Hello Qt!" to cell(A,1).
    xlsxW.saveAs("Test.xlsx"); // save the document as 'Test.xlsx'

    // [2] Reading excel file(*.xlsx)
    Document xlsxR("Test.xlsx"); 
    if (xlsxR.load()) // load excel file
    { 
        Cell* cell = xlsxR.cellAt(row, col); // get cell pointer.
        if ( cell != NULL )
        {
            QVariant var = cell->readValue(); // read cell value (number(double), QDateTime, QString ...)
            qDebug() << var; // display value. it is 'Hello Qt!'.
        }
    }

    return 0;
}

TestExcel


HelloAndroid

  • See 'HelloAndroid' example using QML and native C++.

  • Qt 5.11.1 / gcc 4.9 / QtCreator 4.6.2

  • Android x86 (using Emulator <Android Oreo / API 26>)

  • Android Studio 3.1.3 (Android NDK 17.1)


WebServer

  • Load xlsx file and display on Web.
    • Connect to http://127.0.0.1:3001
  • C++ 14(17) is required. Old compilers is not supported.


ShowConsole

  • Load xlsx file and display in console.
    • [Usage] ShowConsole *.xlsx
  • C++ 11 is required. Old compilers is not supported.


ReadColor

  • Read cell color


csv

  • Save the xlsx file as a csv file.
        QString xlsxFileName = ":/test.xlsx";
        QXlsx::Document xlsxDoc(xlsxFileName);
        if (!xlsxDoc.isLoadPackage()) {
            return 0; // failed to load
        }

        QString csvFileName = "hello.csv";
        if ( xlsxDoc.saveAsCsv(csvFileName) ){
            qDebug() << "save as csv file";
        }

ExcelViewer

  • Load xlsx file and display on Qt widgets.


XlsxFactory

  • Load xlsx file and display on Qt widgets.
  • Moved to personal repository for advanced app.


LargeData

  • LargeData example demonstrates how to efficiently generate, write, and read large Excel .xlsx files using QXlsx.

  • It showcases:

    • Writing a large dataset (hundreds of thousands of rows)
    • Optional cell formatting
    • Splitting data across multiple sheets
    • Time-stamped progress reporting (0.1% increments)
    • Verification of selected sample cells after writing
    • Command-line configurability (rows, columns, sheet size, etc.)

  • This example is useful for testing performance, benchmarking, and validating QXlsx behavior with big data workloads.

  • Command-Line Usage

    • The program accepts several optional parameters:
Option Description Default
--rows <n> -r <n> Number of rows to generate 100000
--cols <n> -c <n> Number of columns to generate 10
--use-style -s Apply simple cell formatting Disabled
--sheet-rows <n> -S <n> Max rows per sheet (0 = single sheet) 0
  • Examples
LargeData --rows 200000 --cols 20
   Generate 200,000 rows × 20 columns
   
LargeData -r 100000 -c 10 --use-style
   Apply cell formatting   

LargeData -r 200000 -c 10 -S 50000
   Split into multiple sheets (50,000 rows per sheet)

LargeData -r 300000 -c 15 -S 60000 --use-style
   All options combined

ExcelTableEditor

  • Load Excel files with multiple sheets
  • Display sheet contents in a QTableView
  • Edit all cells (including row 1)
  • Boolean values displayed as checkboxes
  • Read & preserve basic cell formatting (font, alignment, colors)
  • Sheet operations:
    • Rename sheet
    • Add new sheet
    • Delete sheet
    • Reorder sheets (move left/right)
  • Save or Save As to produce a modified workbook

sax reader

  • How to use sax parser that uses less RAM memory.
void dump_all_sheets_sax(QXlsx::Document& doc)
{
    QXlsx::sax_options opt;
    opt.resolve_shared_strings = true;     // If there are many strings, set to false to save more RAM (but sharedString index may be output instead)
    opt.read_formulas_as_text  = true;     // Output formula as string instead of result value (set false if not needed)
    opt.stop_on_empty_sheetdata = false;   // Continue even if sheetData is empty

    const QStringList sheets = doc.sheetNames();
    qInfo() << "sheet count:" << sheets.size();

    for (const QString& sheet_name : sheets) {
        qInfo().noquote() << "\n=== SHEET:" << sheet_name << "===";

        const bool ok = doc.read_sheet_sax(
            sheet_name,
            opt,
            [&](const QXlsx::sax_cell& cell) -> bool {
                qDebug().noquote()
                << QString("%1!R%2C%3 = %4")
                        .arg(cell.sheet_name)
                        .arg(cell.row)
                        .arg(cell.col)
                        .arg(cell.value.toString());
                return true; // continue
            });

        qInfo() << "sheet done:" << sheet_name << "ok=" << ok;
    }
}

FormulaDump

  • Run

    • The main executable allows you to dump formulas and values from an XLSX file. Example usage:
    ./FormulaDump <xlsx-file> [options]

  • Options

    • --sheet <name>: Dump only the specified sheet
    • --all: Dump all sheets
    • --only-formula: Output only formula cells
    • --show-value: Output cell values
    • --eval-formula: Evaluate formulas if no cached value
    • --max-rows <n>: Limit the number of rows
    • --max-cols <n>: Limit the number of columns
    • --print-empty: Print cells even if the value is empty

  • Formula