Вставка изображений

Команды для работы с графикой позволяют вставлять изображения в документацию. Изображения могут быть отображены как отдельные абзацы или внутри текста.

\image

Команда \image отображает изображение, указанное в первом аргументе, центрированно в отдельном абзаце.

Команда принимает два аргумента. Первый аргумент — имя файла изображения. Второй аргумент является необязательным и представляет собой краткое описание изображения, аналогичное атрибуту alt="" в теге изображения HTML. Описание используется для всплывающих подсказок и для браузеров, не поддерживающих изображения, например, текстового браузера Lynx.

Текст, следующий за именем файла, является необязательным аргументом описания. Убедитесь, что после имени файла или описания стоит перевод строки. Фигурные скобки требуются, если аргумент описания занимает несколько строк.

/ *!
    Qt is a C++ toolkit for cross-platform GUI application development.

    \image happyguy.jpg "Happy guy"

    Qt provides single-source portability across Microsoft
    Windows, macOS, Linux, and all major commercial Unix
    variants. It is also available for embedded devices.
* /

QDoc отображает это так:

Qt — это кроссплатформенный инструментарий C++ для разработки графических приложений.

Qt обеспечивает переносимость кода между Microsoft Windows, macOS, Linux и всеми основными коммерческими вариантами Unix. Он также доступен для встроенных устройств.

См. также \inlineimage и \caption.

\inlineimage

Команда \inlineimage отображает изображение, указанное в её аргументе. Изображение отображается в строке текста.

Команда принимает два аргумента. Первый аргумент — имя файла изображения. Второй аргумент является необязательным и представляет собой краткое описание изображения, аналогичное атрибуту alt="" в теге изображения HTML. Описание используется для всплывающих подсказок и для браузеров, не поддерживающих изображения, например, текстового браузера Lynx.

Наиболее распространённое использование команды \inlineimage — в списках и таблицах. Вот пример вставки встроенных изображений в список:

/ *!
    \list 1
      \li \inlineimage happy.gif Oh so happy!
      \li \inlineimage happy.gif Oh so happy!
      \li \inlineimage happy.gif Oh so happy!
    \endlist
* /

QDoc отображает это так:

Вот пример вставки встроенных изображений в таблицу:

/ *!
    \table
    \header
        \li Qt
        \li Qt Creator
    \row
        \li \inlineimage happy.gif Oh so happy!
        \li \inlineimage happy.gif Oh so happy!
    \row
        \li \inlineimage happy.gif Oh so happy!
        \li \inlineimage happy.gif Oh so happy!
    \endtable
* /

QDoc отображает это так:

Qt	Qt Creator

Команда также может использоваться для вставки изображения в строку текста.

/ *!
    \inlineimage training.jpg Qt Training
    The Qt Programming course is offered as a
    five day Open Enrollment Course. The classes
    are open to the public. Although the course is open
    to anyone who wants to learn, attendees should
    have significant experience in C++ development
    to derive maximum benefit from the course.
* /

QDoc отображает это так:

Курс программирования на Qt предлагается как пятидневный курс открытой записи. Занятия открыты для публики. Хотя курс открыт для всех желающих изучить этот язык, участникам следует иметь значительный опыт разработки на C++, чтобы извлечь максимальную пользу из курса.

См. также \image и \caption.

\caption

Команда \caption предоставляет подпись к изображению.

Команда использует весь текст до конца абзаца как подпись. Экспериментируйте, чтобы получить желаемый эффект.

/ *!
  \table 100%
    \row
      \li \image windowsvista-pushbutton.png
         \caption The QPushButton widget provides a command button.
      \li \image windowsvista-toolbutton.png
         \caption The QToolButton class provides a quick-access button to commands
         or options, usually used inside a QToolBar.
   \endtable
* /

QDoc отображает это так:

См. также \image и \inlineimage