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

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

\image

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

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