Включение изображений

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

\image

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

Команда принимает два аргумента. Первый аргумент — имя файла изображения. Второй аргумент (необязательный) — простое описание изображения, эквивалентное атрибуту HTML alt="" в теге изображения. Описание используется для всплывающих подсказок и для браузеров, не поддерживающих изображения, например, текстового браузера 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 отображает изображение, указанное в качестве аргумента, встроеным в текст.

Команда принимает два аргумента. Первый аргумент — имя файла изображения. Второй аргумент (необязательный) — простое описание изображения, эквивалентное атрибуту HTML alt="" в теге изображения. Описание используется для всплывающих подсказок и для браузеров, не поддерживающих изображения, например, текстового браузера 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 предлагается как пятидневный курс открытой записи. Занятия открыты для всех. Хотя курс открыт для любого желающего изучить 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