TianZD/QtXlsxWriter
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update .qdoc files

Browse Source
This commit is contained in:
Debao Zhang
2013-10-30 17:35:42 +08:00
parent c87413e8ad
commit d8c1f360a2
8 changed files with 125 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+36 -39
View File
@@ -4,7 +4,42 @@ QtXlsx is a library that can read and write Excel files. It doesn't require Micr
## Getting Started
### Usage(1): Use source code directly
### Usage(1): Use Xlsx as Qt5's addon module
* Download the source code.
* Put the source code in any directory you like. At the toplevel directory run
**Note**: Perl is needed.
```
qmake
make
make install
```
The library, the header files, and others will be installed to your system.
* Add following line to your qmake's project file:
```
QT += xlsx
```
* Then, using Qt Xlsx in your code
```cpp
#include "xlsxdocument.h"
int main()
{
QXlsx::Document xlsx;
xlsx.write("A1", "Hello Qt!");
xlsx.saveAs("Test.xlsx");
return 0;
}
```
### Usage(2): Use source code directly
The package contains a **qtxlsx.pri** file that allows you to integrate the component into applications that use qmake for the build step.
@@ -34,41 +69,6 @@ The package contains a **qtxlsx.pri** file that allows you to integrate the comp
* Then, using Qt Xlsx in your code
```cpp
#include "xlsxdocument.h"
int main()
{
QXlsx::Document xlsx;
xlsx.write("A1", "Hello Qt!");
xlsx.saveAs("Test.xlsx");
return 0;
}
```
### Usage(2): Use Xlsx as Qt5's addon module
**Note**: Perl is needed.
* Download the source code.
* Put the source code in any directory you like. At the toplevel directory run
```
qmake
make
make install
```
The library, the header files, and the feature file will be installed to your system.
* Add following line to your qmake's project file:
```
QT += xlsx
```
* Then, using Qt Xlsx in your code
## References
* https://github.com/jmcnamara/XlsxWriter
@@ -76,9 +76,6 @@ The library, the header files, and the feature file will be installed to your sy
* http://officeopenxml.com/anatomyofOOXML-xlsx.php
* http://www.libxl.com
* http://closedxml.codeplex.com/
* http://search.cpan.org/~jmcnamara/Excel-Writer-XLSX-0.71/
* http://www.codeproject.com/Articles/208075/How-to-read-and-write-xlsx-Excel-2007-file-Part-I
* http://www.codeproject.com/Articles/210014/How-to-read-and-write-xlsx-Excel-2007-file-Part-II
* http://epplus.codeplex.com/
* http://excelpackage.codeplex.com/
* http://spreadsheetlight.com/
examples/xlsx/documentproperty/doc/src/documentproperty.qdoc
+1 -1
View File
@@ -4,7 +4,7 @@
\title Xlsx DocProperties Example
\brief This is a simplest xlsx examples.
\ingroup qtxlsx
\ingroup qtxlsx-examples
This example demonstrates how to generate a
.xlsx file with Qt Xlsx Library.
examples/xlsx/hello/doc/src/hello.qdoc
+1 -1
View File
@@ -2,7 +2,7 @@
\example hello
\title Xlsx Hello Example
\brief This is a simplest xlsx examples.
\ingroup qtxlsx
\ingroup qtxlsx-examples
This example demonstrates how to generate a
simplest .xlsx file with Qt Xlsx Library.
examples/xlsx/readwrite/doc/src/readwrite.qdoc
+1 -1
View File
@@ -2,7 +2,7 @@
\title Xlsx Readwrite Example
\example readwrite
\brief Open an existing xlsx file, modify and save it.
\ingroup qtxlsx
\ingroup qtxlsx-examples
This example demonstrates how to modify an existing
.xlsx file with Qt Xlsx Library.
examples/xlsx/style/doc/src/style.qdoc
+1 -2
View File
@@ -3,8 +3,7 @@
\example style
\title Xlsx Style Example
\brief This is a simplest xlsx examples.
\ingroup qtxlsx
\ingroup qtxlsx-examples
This example demonstrates how to generate a
.xlsx file with Qt Xlsx Library.
src/xlsx/doc/src/examples.qdoc
+8
View File
@@ -0,0 +1,8 @@
/*!
\group qtxlsx-examples
\title Qt Xlsx Examples
\brief Examples for the Qt Xlsx module
\ingroup all-examples
Qt Xlsx comes with the following examples:
*/
src/xlsx/doc/src/qtxlsx-index.qdoc
+7 -67
View File
@@ -28,88 +28,28 @@
\page index.html
\brief Qt Xlsx provides functionality for handling .xlsx files.
QtXlsx is a library that can read and write Excel files. It doesn't require
The \l{Qt Xlsx C++ Classes}{Qt Xlsx Module} provides a set of classes to read and write Excel files. It doesn't require
Microsoft Excel and can be used in any platform that Qt5 supported.
\section1 Getting Started
\section2 Usage(1): Use source code directly
The package contains a qtxlsx.pri file that allows you to integrate
the component into applications that use qmake for the build step.
1. Download the source code from \l {https://github.com/dbzhang800/QtXlsxWriter/archive/master.zip} {github.com}
2. Put the source code in any directory you like. For example, 3rdparty:
To include the definitions of the module's classes, using the following directive:
\code
|-- project.pro
|-- ....
|-- 3rdparty\
| |-- qtxlsx\
| |
#include <QtXlsx>
\endcode
3. Add following line to your qmake project file:
\code
include(3rdparty/qtxlsx/src/xlsx/qtxlsx.pri)
\endcode
\note If you like, you can copy all files from *src/xlsx* to your application's source path. Then add following line to your project file:
\code
include(qtxlsx.pri)
\endcode
4. Then, using Qt Xlsx in your code
\code
#include "xlsxdocument.h"
int main()
{
QXlsx::Document xlsx;
xlsx.write("A1", "Hello Qt!");
xlsx.saveAs("Test.xlsx");
return 0;
}
\endcode
\section2 Usage(2): Use Xlsx as Qt5's addon module
\note Perl is needed.
1. Download the source code.
2. Put the source code in any directory you like. At the toplevel directory run
\code
qmake
make
make install
\endcode
The library, the header files, and the feature file will be installed to your system.
3. Add following line to your qmake's project file:
To link against the module, add this line to your qmake .pro file:
\code
QT += xlsx
\endcode
4. Then, using Qt Xlsx in your code
More information can be found in \l{Qt Xlsx Build} page.
\section1 References
\section1 Related information
\list
\li \l{Qt Xlsx C++ Classes}
\endlist
Qt Xlsx comes with the following examples:
\list
\li \l{Xlsx Hello Example}
\li \l{Xlsx Style Example}
\li \l{Xlsx DocProperties Example}
\li \l{Xlsx Readwrite Example}
\li \l{Qt Xlsx Examples}
\endlist
*/
src/xlsx/doc/src/usage.qdoc
+70
View File
@@ -0,0 +1,70 @@
/*!
\page building
\title Qt Xlsx Build
\section1 Usage(1): Use Xlsx as Qt5's addon module
1. Download the source code from \l {https://github.com/dbzhang800/QtXlsxWriter/archive/master.zip} {github.com}.
2. Put the source code in any directory you like. At the toplevel directory run
\note Perl is needed in this step.
\code
qmake
make
make install
\endcode
The library, the header files, and others will be installed to your system.
3. Add following line to your qmake's project file:
\code
QT += xlsx
\endcode
4. Then, using Qt Xlsx in your code
\code
#include "xlsxdocument.h"
int main()
{
QXlsx::Document xlsx;
xlsx.write("A1", "Hello Qt!");
xlsx.saveAs("Test.xlsx");
return 0;
}
\endcode
\section1 Usage(2): Use source code directly
The package contains a qtxlsx.pri file that allows you to integrate
the component into applications that use qmake for the build step.
1. Download the source code from \l {https://github.com/dbzhang800/QtXlsxWriter/archive/master.zip} {github.com}
2. Put the source code in any directory you like. For example, 3rdparty:
\code
|-- project.pro
|-- ....
|-- 3rdparty\
| |-- qtxlsx\
| |
\endcode
3. Add following line to your qmake project file:
\code
include(3rdparty/qtxlsx/src/xlsx/qtxlsx.pri)
\endcode
\note If you like, you can copy all files from *src/xlsx* to your application's source path. Then add following line to your project file:
\code
include(qtxlsx.pri)
\endcode
4. Then, using Qt Xlsx in your code
*/