diff options
author | Paul Wicking <paul.wicking@qt.io> | 2020-08-25 11:22:42 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2020-08-28 12:05:49 +0200 |
commit | ebabbd0264c36922461ffdef1436ad7c983cab47 (patch) | |
tree | 2330f364bd4fa6b28620b8771ca928ea63e21e3d /src/gui/doc/snippets/code | |
parent | 186eb6d50f0fb536da319f2e2f58805cb948a006 (diff) |
Doc: Compile image snippets
Fix minor issues (e.g. whitespace, missing semi-colon) in passing.
Update documentation to use same snippet to avoid duplication of
snippets across snippet files. Remove offending snippet.
Done-with: Nico Vertriest <nico.vertriest@qt.io>
Task-number: QTBUG-81486
Change-Id: Ia45549d50e8f4e22ce72667a19c38132306d38b3
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/gui/doc/snippets/code')
-rw-r--r-- | src/gui/doc/snippets/code/code.pro | 9 | ||||
-rw-r--r-- | src/gui/doc/snippets/code/src_gui_image_qicon.cpp | 33 | ||||
-rw-r--r-- | src/gui/doc/snippets/code/src_gui_image_qimage.cpp | 14 | ||||
-rw-r--r-- | src/gui/doc/snippets/code/src_gui_image_qimagereader.cpp | 16 | ||||
-rw-r--r-- | src/gui/doc/snippets/code/src_gui_image_qimagewriter.cpp | 24 | ||||
-rw-r--r-- | src/gui/doc/snippets/code/src_gui_image_qmovie.cpp | 14 | ||||
-rw-r--r-- | src/gui/doc/snippets/code/src_gui_image_qpixmap.cpp | 18 | ||||
-rw-r--r-- | src/gui/doc/snippets/code/src_gui_image_qpixmapcache.cpp | 4 |
8 files changed, 118 insertions, 14 deletions
diff --git a/src/gui/doc/snippets/code/code.pro b/src/gui/doc/snippets/code/code.pro index ae53a0a1a1..83be76abb5 100644 --- a/src/gui/doc/snippets/code/code.pro +++ b/src/gui/doc/snippets/code/code.pro @@ -5,4 +5,11 @@ QT += core gui widgets SOURCES = \ doc_src_coordsys.cpp \ doc_src_richtext.cpp \ - src_gui_accessible_qaccessible.cpp + src_gui_accessible_qaccessible.cpp \ + src_gui_image_qicon.cpp \ + src_gui_image_qimage.cpp \ + src_gui_image_qimagereader.cpp \ + src_gui_image_qimagewriter.cpp \ + src_gui_image_qmovie.cpp \ + src_gui_image_qpixmapcache.cpp \ + src_gui_image_qpixmap.cpp diff --git a/src/gui/doc/snippets/code/src_gui_image_qicon.cpp b/src/gui/doc/snippets/code/src_gui_image_qicon.cpp index faad6574a7..f70426e5f1 100644 --- a/src/gui/doc/snippets/code/src_gui_image_qicon.cpp +++ b/src/gui/doc/snippets/code/src_gui_image_qicon.cpp @@ -47,6 +47,20 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ +#include <QIcon> +#include <QPainter> +#include <QToolButton> + +namespace src_gui_image_qicon { + +struct MyWidget : public QWidget +{ + void drawIcon(QPainter *painter, QPoint pos); + bool isChecked() { return true; } + QIcon icon; +}; + +void wrapper0() { //! [0] QToolButton *button = new QToolButton; @@ -58,6 +72,8 @@ button->setIcon(QIcon("open.xpm")); button->setIcon(QIcon()); //! [1] +} // wrapper0 + //! [2] void MyWidget::drawIcon(QPainter *painter, QPoint pos) @@ -71,14 +87,25 @@ void MyWidget::drawIcon(QPainter *painter, QPoint pos) } //! [2] + +void wrapper1() { + //! [3] - QIcon undoicon = QIcon::fromTheme("edit-undo"); +QIcon undoicon = QIcon::fromTheme("edit-undo"); //! [3] +} // wrapper1 + + //! [4] - QIcon undoicon = QIcon::fromTheme("edit-undo", QIcon(":/undo.png")); +QIcon undoicon = QIcon::fromTheme("edit-undo", QIcon(":/undo.png")); //! [4] + +void wrapper2(){ //! [5] - QIcon::setFallbackSearchPaths(QIcon::fallbackSearchPaths() << "my/search/path"); +QIcon::setFallbackSearchPaths(QIcon::fallbackSearchPaths() << "my/search/path"); //! [5] + +} // wrapper2 +} // src_gui_image_qicon diff --git a/src/gui/doc/snippets/code/src_gui_image_qimage.cpp b/src/gui/doc/snippets/code/src_gui_image_qimage.cpp index e4e641a5e0..b36d12018a 100644 --- a/src/gui/doc/snippets/code/src_gui_image_qimage.cpp +++ b/src/gui/doc/snippets/code/src_gui_image_qimage.cpp @@ -47,7 +47,11 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ +#include <QImage> +#include <QRgb> +namespace src_gui_image_qimage { +void wrapper0() { //! [0] QImage image(3, 3, QImage::Format_RGB32); QRgb value; @@ -63,6 +67,9 @@ value = qRgb(237, 187, 51); // 0xffedba31 image.setPixel(2, 1, value); //! [0] +} // wrapper0 +void wrapper1() { + //! [1] QImage image(3, 3, QImage::Format_Indexed8); @@ -88,5 +95,10 @@ image.setPixel(2, 1, 1); static const char * const start_xpm[] = { "16 15 8 1", "a c #cec6bd", -.... + // etc. +}; //! [2] + +Q_UNUSED(start_xpm); +} // wrapper1 +} // src_gui_image_qimage diff --git a/src/gui/doc/snippets/code/src_gui_image_qimagereader.cpp b/src/gui/doc/snippets/code/src_gui_image_qimagereader.cpp index ac26126758..88330523b3 100644 --- a/src/gui/doc/snippets/code/src_gui_image_qimagereader.cpp +++ b/src/gui/doc/snippets/code/src_gui_image_qimagereader.cpp @@ -47,12 +47,19 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ +#include <QImage> +#include <QImageReader> + +namespace src_gui_image_qimagereader { +void wrapper0() { //! [0] QImageReader reader; reader.setFormat("png"); // same as reader.setFormat("PNG"); //! [0] +} // wrapper0 + //! [1] QImageReader reader("image.png"); @@ -60,6 +67,8 @@ QImageReader reader("image.png"); //! [1] +void wrapper1() { + //! [2] QImage icon(64, 64, QImage::Format_RGB32); QImageReader reader("icon_64x64.bmp"); @@ -68,9 +77,16 @@ if (reader.read(&icon)) { } //! [2] +} // wrapper1 + + +void wrapper2() { //! [3] QImageReader reader(":/image.png"); if (reader.supportsOption(QImageIOHandler::Size)) qDebug() << "Size:" << reader.size(); //! [3] + +} // wrapper2 +} // src_gui_image_qimagereader diff --git a/src/gui/doc/snippets/code/src_gui_image_qimagewriter.cpp b/src/gui/doc/snippets/code/src_gui_image_qimagewriter.cpp index c0b2544858..1bf141d8f9 100644 --- a/src/gui/doc/snippets/code/src_gui_image_qimagewriter.cpp +++ b/src/gui/doc/snippets/code/src_gui_image_qimagewriter.cpp @@ -47,12 +47,22 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ +#include <QImage> +#include <QImageWriter> + +namespace src_gui_image_qimagewriter { + +void wrapper0() { //! [0] QImageWriter writer; writer.setFormat("png"); // same as writer.setFormat("PNG"); //! [0] +} // wrapper0 + + +void wrapper1() { //! [1] QImage image("some/image.jpeg"); @@ -61,6 +71,11 @@ writer.setText("Author", "John Smith"); writer.write(image); //! [1] +} // wrapper1 + + +void wrapper2() { +QString fileName; //! [2] QImageWriter writer(fileName); @@ -68,9 +83,18 @@ if (writer.supportsOption(QImageIOHandler::Description)) writer.setText("Author", "John Smith"); //! [2] +} // wrapper 2 + + +void wrapper3() { +QImage image; + //! [3] QImageWriter writer("some/image.dds"); if (writer.supportsOption(QImageIOHandler::SubType)) writer.setSubType("A8R8G8B8"); writer.write(image); //! [3] + +} // wrapper3 +} // src_gui_image_qimagewriter diff --git a/src/gui/doc/snippets/code/src_gui_image_qmovie.cpp b/src/gui/doc/snippets/code/src_gui_image_qmovie.cpp index 3ed458a3db..c9371ba1b5 100644 --- a/src/gui/doc/snippets/code/src_gui_image_qmovie.cpp +++ b/src/gui/doc/snippets/code/src_gui_image_qmovie.cpp @@ -47,6 +47,13 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ +#include <QLabel> +#include <QMovie> + +namespace src_gui_image_qmovie { + +void wrapper0() { + //! [0] QLabel label; @@ -56,8 +63,15 @@ label.setMovie(movie); movie->start(); //! [0] +} // wrapper0 + + +void wrapper1() { //! [1] QMovie movie("racecar.gif"); movie.setSpeed(200); // 2x speed //! [1] + +} // wrapper1 +} // src_gui_image_qmovie diff --git a/src/gui/doc/snippets/code/src_gui_image_qpixmap.cpp b/src/gui/doc/snippets/code/src_gui_image_qpixmap.cpp index b76e7b6e8d..9c52a5075f 100644 --- a/src/gui/doc/snippets/code/src_gui_image_qpixmap.cpp +++ b/src/gui/doc/snippets/code/src_gui_image_qpixmap.cpp @@ -47,22 +47,28 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ +#include <QBitmap> +#include <QPixmap> -//! [0] -static const char * const start_xpm[]={ - "16 15 8 1", - "a c #cec6bd", -.... -//! [0] +namespace src_gui_image_qpixmap { +void wrapper0() { //! [1] QPixmap myPixmap; myPixmap.setMask(myPixmap.createHeuristicMask()); //! [1] +} // wrapper0 + + +void wrapper1() { + //! [2] QPixmap pixmap("background.png"); QRegion exposed; pixmap.scroll(10, 10, pixmap.rect(), &exposed); //! [2] + +} // wrapper1 +} // src_gui_image_qpixmap diff --git a/src/gui/doc/snippets/code/src_gui_image_qpixmapcache.cpp b/src/gui/doc/snippets/code/src_gui_image_qpixmapcache.cpp index 9d2e5cbc79..80be2af9bd 100644 --- a/src/gui/doc/snippets/code/src_gui_image_qpixmapcache.cpp +++ b/src/gui/doc/snippets/code/src_gui_image_qpixmapcache.cpp @@ -53,9 +53,7 @@ namespace src_gui_image_qpixmapcache { -void wrapper0() { -QPainter *painter = nullptr; - +void wrapper0(QPainter *painter) { //! [1] QPixmap pm; if (!QPixmapCache::find("my_big_image", &pm)) { |