QT read / write excel--qxlsx worksheet display / hide status setting 4

Qt Reading and writing Excel–QXlsx Worksheet display / Hide status settings 4🤏

More highlights
Personal content summary

1、 summary

• QXlsx It's one that can read and write Excel Document library . Do not rely on office as well as wps Components , Can be in Qt5 Any platform supported by ;

• Usage mode

  1. QXlsx It can be compiled into a dynamic library to use （ Using dynamic libraries does not require every compilation , You can also reduce the amount of project code , You don't have to open dozens of files as soon as you open the project ）;
  2. Direct will QXlsx.pri Add code to use （ I recommend using the source code directly , because QXlsx The annotation information of is basically cpp In file , You can learn by reading the source code and comments QXlsx The function of , Of course , If you're familiar QXlsx It will be more convenient to compile it into a library , It can reduce the amount of code in the project ）;

• The functions implemented in this paper ：

  1. Create a worksheet with the specified name （Sheet）, Automatically add to the end ;
  2. Query open Excel All available worksheets in （Sheet） name ;
  3. Query the status of the selected worksheet （ Show 、 hide 、 Absolute hide ）;
  4. Set the status of the selected worksheet （ Show 、 hide 、 Absolute hide ）;
  5. One click call WPS fast open Excel（ For the convenience of viewing the effect ）.

2、 preparation

Qt Reading and writing Excel–QXlsx Basic use 1
Qt Reading and writing Excel–QXlsx Compile as a static library 2

3、 Function description 🤟

Be careful ： The operation has been executed and will not take effect until it is saved .

• QStringList sheetNames() const

  • Functional specifications ： Inquire about Excel All worksheets in （Sheet） name ;
  • Return value ： List of names of all worksheets ;

• bool addSheet(const QString &name = QString(), AbstractSheet::SheetType type = AbstractSheet::ST_WorkSheet)

  • Functional specifications ： Create a name at the end name, The type is type The worksheet for ;
  • Parameters name： Name of the worksheet created , If no name is specified, it defaults to Sheet1、Sheet2 Increasing ;
  • Parameters type： Type of worksheet created , Omission ;
    • ST_WorkSheet： Form sheet
    • ST_ChartSheet： Chart sheet
    • ST_DialogSheet： Not yet
    • ST_MacroSheet： Not yet
  • Return value ： If it is created successfully, it will return true, Failure to return false;
    • If the name already exists, the creation fails ;
    • If it is ST_DialogSheet、ST_MacroSheet Also failed to create ;（ Note that this creation failure has bug, Entered after creation failure name Will be saved , You cannot create a worksheet with this name next time , But it doesn't affect the use of , Repair method ： stay xlsxworkbook.cpp In the document Q_ASSERT(false); Add... To the next line return sheet; that will do ）

• AbstractSheet *Document::sheet(const QString &sheetName) const

  • Functional specifications ： According to the worksheet name entered sheetName Returns a pointer to the worksheet , Returns if it does not exist NULL
  • Parameters sheetName： Worksheet name ;
  • Return value ： Successfully returned the available worksheet pointer , Failure to return NULL;

• AbstractSheet::SheetState AbstractSheet::sheetState() const

  • Functional specifications ： Get the status of the current worksheet ;

  • Return value ： Current status of the worksheet enum SheetState { SS_Visible( Show ),SS_Hidden( hide ), SS_VeryHidden（ Absolute hide ） };;

    • Display state ： adopt WPS open Excel You can see the worksheet ;

    • Hidden state ： open Excel Can't see hidden worksheets , Need to set up Unhide To see ;

      

    • Absolute hide ： Set up Unhide I can't see .

• void AbstractSheet::setSheetState(SheetState state)

  • Functional specifications ： Set sheet status .
  • Parameters state： Worksheet status to be set enum SheetState { SS_Visible( Show ),SS_Hidden( hide ), SS_VeryHidden（ Absolute hide ） };;

• bool AbstractSheet::isHidden() const

  • Functional specifications ： Whether the worksheet is hidden .
  • Return value ： The worksheet is 【 Hidden state 】 perhaps 【 Absolutely hidden 】 return true,【 Display state 】 return false;

• bool AbstractSheet::isVisible() const

  • Functional specifications ： Whether the worksheet shows （ And isHidden() contrary ）.
  • Return value ： The worksheet is 【 Hidden state 】 perhaps 【 Absolutely hidden 】 return false,【 Display state 】 return true;

• void AbstractSheet::setHidden(bool hidden)

  • Functional specifications ： Set the sheet to be hidden or visible .
  • Parameters hidden： true： hide false： Show

• void AbstractSheet::setVisible(bool visible)

  • Functional specifications ： Set the sheet to be hidden or visible .
  • Parameters hidden： true： Show false： hide

4、 Sample code

4.1 .h file

/****************************************************************************** * @ file name  test3.h * @ function   be based on AbstractSheet Class Demo, Mainly demonstrated  * 1、 Create sheet ; * 2、 Query worksheet ; * 3、 Query worksheet status ; * 4、 Set sheet status . * * @ developer  mhf * @ mailbox  [email protected] * @ Time  2022/06/19 * @ remarks  *****************************************************************************/
#ifndef TEST3_H
#define TEST3_H

#include <QWidget>

namespace Ui {
    
class Test3;
}

class Test3 : public QWidget
{
    
    Q_OBJECT

public:
    explicit Test3(QWidget *parent = nullptr);
    ~Test3();

private slots:
    void on_but_show_clicked();

    void on_but_addSheet_clicked();

    void on_com_sheets_activated(const QString &arg1);

    void on_com_state_activated(int index);

private:
    Ui::Test3 *ui;
};

#endif // TEST3_H

4.2 .cpp file

#include "test3.h"
#include "ui_test3.h"

#include <QDir>
#include <qprocess.h>
#include <QDebug>
#include "xlsxdocument.h"
QXLSX_USE_NAMESPACE            //  add to Xlsx Namespace 

#define EXCEL_NAME "state.xlsx" //  Ben Demo The use of Excel file name 

Test3::Test3(QWidget *parent) :
    QWidget(parent),
    ui(new Ui::Test3)
{
    
    ui->setupUi(this);
    this->setWindowTitle("QXlsx Query and set worksheet status Demo");
}

Test3::~Test3()
{
    
    delete ui;
}


/** * @brief  By calling WPS Open... Under the current path Excel file , If the opening fails, you need to replace your own wps Installation path for  */
void Test3::on_but_show_clicked()
{
    
    bool ret = QProcess::startDetached("D:/WPS Office/ksolaunch.exe", QStringList() << QDir::currentPath() + "/" + EXCEL_NAME);
    if(!ret)
    {
    
        qWarning() << " open Excel Failure , Please note that wps Does the path exist , Or replace other programs to open excel";
    }
}

/** * @brief  Create a worksheet  */
void Test3::on_but_addSheet_clicked()
{
    
    Document xlsx(EXCEL_NAME);             //  If the file exists, open EXCEL_NAME, If it does not exist, pass in the file name , stay save Save as EXCEL_NAME
    qDebug() << xlsx.load();               //  If the file exists , And if it is opened successfully, it will be true, Otherwise false
// xlsx.addSheet(); //  Create a worksheet , If no name is specified, it defaults to Sheet1、Sheet2 Increasing 
    xlsx.addSheet(ui->line_name->text());  //  Specify a name to create a worksheet ( The default setting is the currently active worksheet )
    xlsx.write(2, 2, "hello");             //  Write data to the currently active worksheet 
    if(xlsx.save())                        //  Because in 【Document xlsx(EXCEL_NAME);】 File name specified , So save it to EXCEL_NAME, If not specified, it defaults to 【Book1.xlsx】
    {
    
        qDebug() << " Saved successfully ！";

        ui->com_sheets->clear();
        ui->com_sheets->addItems(xlsx.sheetNames());   //  Query all available worksheets 
    }
    else
    {
    
        qDebug() << " Save failed ！";
    }
}

/** * @brief  Select the worksheet name from the drop-down box , Query worksheet status  * @param arg1 */
void Test3::on_com_sheets_activated(const QString &arg1)
{
    
    Document xlsx(EXCEL_NAME);
    AbstractSheet* sheet = xlsx.sheet(arg1);   //  Get worksheet pointer by name 
    if(!sheet) return;    //  Judge whether it is NULL

    int state = sheet->sheetState();           //  Get current worksheet status 
    ui->com_state->setCurrentIndex(state);
}

/** * @brief  Set sheet status , *  It can be done by setSheetState Set display 、 hide 、 Absolute hide 【 Three states 】, *  adopt sheetState Get the current status of the worksheet 【 Three states 】 *  It can also be done through setHidden or setVisible Set display 、 Hidden state 【 Two kinds of state 】, *  And pass isHidden perhaps isVisible Query shows hidden status 【 Two kinds of state 】 * @param index */
void Test3::on_com_state_activated(int index)
{
    
    Document xlsx(EXCEL_NAME);
    AbstractSheet* sheet = xlsx.sheet(ui->com_sheets->currentText());   //  Get worksheet pointer by name 
    if(!sheet) return;    //  Judge whether it is NULL

    sheet->setSheetState(AbstractSheet::SheetState(index));             //  Modify worksheet status 
    if(xlsx.save())
    {
    
        qDebug() << " Saved successfully ！" ;
    }
    else
    {
    
        qDebug() << " Save failed ！";
    }
}

5、 Realization effect

6、 Source code

gitee
github