Qcoreapplication a argc argv что это
Небольшой тест скорости QCoreApplication
Для надежности и безопасности, часто имеет смысл разделить функционал приложения на множество небольших исполняемых файлов (демонов), вместо того, чтобы поддерживать крупное и монолитное приложение.
В своё время, Qt4 была разделена на несколько модулей, что в частности позволило создавать приложения, не требующих графического интерфейса. Благодаря сильной фокусировке на архитектуре встраиваемых систем и нескольким здравомыслящим решениям в области архитектуры, Qt5 вывела данный подход на новый уровень.
Давайте посмотрим на простую функцию:
Это Qt-приложение, не имеющее графического интерфейса. Оно работает 3 секунды и затем завершается.
На моей Kubuntu 12.04 со стандартным ядром и Qt 4.8.1 Valgrind показывает пиковое использование кучи в 102 кб, в то время как Callgrind сообщает о выполнении 1.9 (*) миллиона инструкций процессора.
Давайте посмотрим на цифры полученные на сегодняшней сборке Qt 5: Valgrind сообщает 4,9 Кб выделения памяти в куче, а Callgrind сообщает примерно о 114 000 инструкций процессора.
Это означает, что Qt 5 использует примерно в 20 раз меньше памяти и примерно в 16 раз меньше инструкций процессора в конструкторе QCoreApplication и на выполнение Event-loop.
Есть несколько причин для этого. В частности, Qt 5 предполагает, что все строки по умолчанию имеют Unicode-кодировку, так что инициализация преобразователя кодировок текста происходит только при появлении первой не-Unicode строки. Хотя в Qt 5 значительно улучшилась производительность загрузки плагинов, они просто не могут загружаться ещё быстрее.
На скорости сказались также и другие улучшения, к примеру внедрение поддержки C++11 в Qt5 позволило создавать Unicode-строки, не требующие выделения памяти в куче.
В общем, попробуйте весёлого написания своих демонов на Qt и если у вас появятся какие-либо идеи по оптимизации кода — милости просим в Qt Codereview.
(*) Предупреждение: Количество инструкций не показывает, как быстр код, а только количество инструкций фактически обработанных процессором. Обратите внимание, что во всех случаях я измерил производительность только функции main(), не обращая внимания на издержки загрузки разделяемых библиотек, так что приложение может быть дополнительно оптимизировано при помощи предварительного связывания или прямым форком от уже работающего процесса.
Описание Класса QCoreApplication
[модуль QtCore]
Класс QCoreApplication предоставляет обработку сообщений для консольного приложения Qt. Далее.
Открытые Типы
Свойства
Открытые Функции
Открытые Слоты
Сигналы
Статические Открытые Члены
Связанные Не-Члены
Макросы
Дополнительные Унаследованные Члены
Подробное Описание
Класс QCoreApplication предоставляет обработку сообщений для консольного приложения Qt.
Этот класс используется для реализации цикла обрабтки сообщений приложениями не предоставляющими GUI. У каждого не-GUI приложения, использующего Qt, должен быть один объект QCoreApplication. Для GUI-приложений, см. QApplication.
QCoreApplication содержит главный цикл обработки сообщений в котором обрабатываются и пересылаются далее все сообщения операционной системы (например, сообщения таймера и сети) и других источников. Также этот класс управляет инициализацией и закрытием приложений инициированных как операционной системой, так и приложениями.
Аргументы коммандной строки переданной QCoreApplication доступны как argc() и argv(). Цикл обработки сообщений начинается с вызова exec(). Доолгие управляющие операции могут вызывать processEvents() для поддержания приложения в состоянии готовности.
Некоторые классы Qt (например, QString) могут использоваться без объекта QCoreApplication. Однака, мы рекомендуем в большинстве случаев создавать объект QCoreApplication или QApplication в Вашей функции main() как можно раньше.
Приложежние имеет applicationDirPath() и applicationFilePath(). Файлы перевода могут быть добавлены или удалены с использованием installTranslator() и removeTranslator(). Строки приложения могут быть переведены с помощью функции translate(). Функция translate() использует функции QObject::tr() и QObject::trUtf8().
Класс предоставляет слот quit() и сигнал aboutToQuit().
Также предоставляется несколько статических функций для удобства. Доступ к объекту QCoreApplication можно получить через instance(). Сообщения можно послать или передать с помощью sendEvent(), postEvent() и sendPostedEvents(). Определенные события могут быть удалены с помощью removePostedEvents() и вызваны с помощью flush(). Путь к библиотеке (см. QLibrary) может быть получен с помощью libraryPaths() и изменен с помощью setLibraryPaths(), addLibraryPath() и removeLibraryPath().
Описание Типов Членов
enum QCoreApplication::Encoding
Данный тип перечисления определяет способ шифрования 8-битой символьной строки, переданных в качество аргумента в translate():
Константа | Значение | Описание |
---|---|---|
QCoreApplication::DefaultCodec | 0 | Кодировка определенная в QTextCodec::codecForTr() (Если ни один не был установлен, то Latin1) |
QCoreApplication::UnicodeUTF8 | 1 | UTF-8 |
typedef QCoreApplication::EventFilter
Функция, которая может использоваться с фильтром событий, имеет следующее определение:
Описание Свойств
applicationName : QString
Данное свойство хранит имя приложения.
Данное свойство используется классом QSettings при создании его экземпляра с помощью конструктора без параметров. Это избавляет от необходимости задавать это значение каждый раз при создании объекта QSettings.
organizationDomain : QString
Данное свойство хранин интернет-адрес организации написавшей приложение.
Данное свойство используется классом QSettings при создании его экземпляра с помощью конструктора без параметров. Это избавляет от необходимости задавать это значение каждый раз при создании объекта QSettings.
В системах Mac QSettings organizationDomain() использует данное свойство в качестве имени организации (если свойство не содержит пустую строку); в противном случае используется organizationName(). На всех других платформах QSettings использует в качестве имени организации organizationName().
organizationName : QString
Данное свойство хранит имя организации создавшей приложение.
Данное свойство используется классом QSettings при создании его экземпляра с помощью конструктора без параметров. Это избавляет от необходимости задавать это значение каждый раз при создании объекта QSettings.
В системах Mac QSettings organizationDomain() использует данное свойство в качестве имени организации (если свойство не содержит пустую строку); в противном случае используется organizationName(). На всех других платформах QSettings использует в качестве имени организации organizationName().
Описание Функций-Членов
QCoreApplication::QCoreApplication ( int & argc, char ** argv )
Аргументы argc и argv доступны через функции argc() и argv().
QCoreApplication::
void QCoreApplication::aboutToQuit () [signal]
Данный сигнал испускается когда приложение сообирается завершить цикл обработки сообщений, например, когда уровень цикла обработки сообщений понижается до нуля. Это может случиться после того как поступит запрос quit() от внутренней части приложения или если пользователь закрывает основное окно.
Этот сигнал особенно полезен, если приложение должно убрать за собой после закрытия. Обратите внимание, что никакое взаимодействие с пользователем в этом состоянии невозможно.
void QCoreApplication::addLibraryPath ( const QString & path ) [static]
Добавляет path в конец списка путей к библиотекам. Если path пустой или уже присутствует в списке, то список не изменяется.
QString QCoreApplication::applicationDirPath () [static]
Возвращает имя директории, в которой установлено исполняемое приложение.
Например, если Вы установили Qt в директорию C:\Trolltech\Qt и запустили пример regexp, данная функция возвратит «C:/Trolltech/Qt/examples/tools/regexp».
В Mac OS X данная функция укажет на директорию, фактически содержащую выполняемый файл, который может находиться внутри связки приложений (если приложение связано).
Внимание: В Unix данная функция предполагает, что argv[0] содержит имя исполняемого файла (как это обычно и происходит). Также предполагается, что текущая директория не была изменена приложением.
QString QCoreApplication::applicationFilePath () [static]
Возвращает путь к исполняемому файлу приложения.
Например, если Вы установили Qt в директорию /usr/local/qt и запустили пример regexp, то данная функцию возвратит «/usr/local/qt/examples/tools/regexp/regexp».
Внимание: В Unix данная функция предполагает, что argv[0] содержит имя исполняемого файла (как это обычно и происходит). Также предполагается, что текущая директория не была изменена приложением.
QStringList QCoreApplication::arguments () [static]
Возвращает список аргументов командной строки.
Вызов данной функции занимает продолжительное время. При парсинге командной строки, Вам лучше сохранить результат этой функции в переменной.
Внимание: В Unix этот список создается из параметров argc и argv, переданных в функцию main(). Строки в argv интерпретируются с помощью QString::fromLocal8Bit(); в результате, нет возможности разобрать, например, японские аргументы командной строки в системах, основанных на latin1. Большинство современных Unix-систем не имеют этого ограничения, так как они основаны на Unicode.
В NT-подобных Windows это ограничение также не действует.
Данная функция добавлена Qt 4.1.
bool QCoreApplication::closingDown () [static]
Возвращает true если объект приложения разрушается; в противном случае возвращает false.
int QCoreApplication::exec () [static]
Запускает основной цикл обработки сообщений и ждет вызова exit(). Возвращает значение установленное в exit() (значение равно 0 если exit() вызвано через quit()).
Данную функцию необходимо вызвать для начала обработки сообщений. Основной цикл обработки сообщений получает сообщения от оконной системы и перенаправляет их виджетам приложения.
Чтобы заставить приложение выполнять какие-либо действия в отсутствие сообщений используют QTimer с интервалом равным 0. Более продвинутые схемы обработки ожидания создают с использованием processEvents().
void QCoreApplication::exit ( int returnCode = 0 ) [static]
Посылает сообщение о выходе с нужным возвращаемым кодом.
После вызова этой функции приложение покидает главный цикл обработки сообщений и завершает функцию exec(). Функция exec() возвращает returnCode.
В соответствии с соглашением returnCode равный 0 говорит об успешном завершении, а отличный от 0 указывает на ошибку.
bool QCoreApplication::filterEvent ( void * message, long * result )
Посылает сообщение message в фильтр сообщений установленный с помощью setEventFilter(). Если фильтр сообщений не был установлен, данная функция возвращает false; в противном случае данная функция возвращает результат работы функции фильтр, который установливается в параметр result.
void QCoreApplication::flush () [static]
Обрабатывает специфические для платформы события.
Если Вы делаете графические изменения в цикле и не передаете управление циклу обработки сообщений на асинхронных оконных системах подобных X11 или используете двойную буферизацию подобно Mac OS X, и хотите визуализировать эти изменения немедленно (например, Splash Screens), вызывайте эту функцию.
bool QCoreApplication::hasPendingEvents () [static]
Данная функция возвращает true если в очереди есть события; в противном случае возвращает false. События в очереди могут быть посланы системой или другими частями приложения с использованием postEvent().
void QCoreApplication::installTranslator ( QTranslator * messageFile ) [static]
Добавляет файл сообщений messageFile к списку файлов сообщений используемых для перевода.
Может быть установлено несколько файлов сообщений. Переводчик сперва ищет в последнем установленном файле, затем в предпоследнем и т.д. до первого файла. Поиск останавливается как только переводимое сообщение будет найдено.
QCoreApplication * QCoreApplication::instance () [static]
Возвращает указатель на приложение QCoreApplication (или QApplication).
QStringList QCoreApplication::libraryPaths () [static]
Если Вы хотите перебрать список, то можно воспользоваться псевдоключевым словом foreach:
bool QCoreApplication::notify ( QObject * receiver, QEvent * event ) [virtual]
Посылает сообщение event получателю receiver: receiver->event(event). Возвращает значение возвращенное обработчиком сообщений получателя.
Для некоторых типов событий (например сообщения мыши и клавиатуры) сообщения будут пересылаться родителю получателя и далее до объекта самого верхнего уровня если получатель не заинтересован в событии (т.е. его обработчик возвращает false).
Есть пять различных способов обработки сообщений; переопределение этой виртуальной функции только один из них. Далее следует краткое описание этих подходов:
void QCoreApplication::postEvent ( QObject * receiver, QEvent * event ) [static]
Добавляет сообщение event в очередь сообщений объекта-приемника receiver и немедленно возвращает управление.
Сообщение должно быть размещено в куче, т.к. очередь сообщений возьмет его значение и удалит объект сообщения как только сообщение будет послано. Эта функция не гарантирует возможность изменять и удалять сообщение после того, как оно будет послано.
Когда управление возвращается к главному циклу обработки сообщений, все сообщения стоящие в очереди будут посланы с использованием функции notify().
Обратите внимание: Данная функция является потокобезопасной.
См. также sendEvent(), notify() и sendPostedEvent().
void QCoreApplication::processEvents ( QEventLoop::ProcessEventsFlags flags = QEventLoop::AllEvents ) [static]
Обрабатывает все ожидающие события в соответствии с флагами flags пока не будет исчерпана очередь.
Вы можете вызывать данную функцию в некоторых случаях когда программа выполняет длительное действие (например копирование файла).
void QCoreApplication::processEvents ( QEventLoop::ProcessEventsFlags flags, int maxtime ) [static]
Данная перегруженная функция-член предоставлена для удобства. Ее поведение аналогично поведению вышеприведенной фунции.
Обрабатывает ожидающие сообщения в течение maxtime миллисекунд или меньше, если не больше событий.
Вы можете вызывать данную функцию в некоторых случаях когда программа выполняет длительное действие (например копирование файла).
void QCoreApplication::quit () [static slot]
Сообщает, что приложение завершило свою работу и возвратило код 0 (успешное завершение). Эквивалентно вызову QCoreApplication::exit(0).
Обычно соединяют сигнал QApplication::lastWindowClosed() с quit(), также часто соединяют, например, QAbstractButton::clicked() или сигналы в QAction, QMenu или QMenuBar с данный слотом.
void QCoreApplication::removeLibraryPath ( const QString & path ) [static]
Удаляет путь path из списка путей к библиотекам. Если path является пустым значением или отсутствует в списке, то список не изменяется.
void QCoreApplication::removePostedEvents ( QObject * receiver ) [static]
Удаляет все сообщения посланные приемнику receiver с помощью postEvent().
События не будут посланы, вместо этого они будут удалены из очереди. Никогда не используйте эту функция. Если Вы все-же вызвали ее, то знайте, что уничножение событий заставляет приемник прерывать один или более инвариантов.
Обратите внимание: Данная функция является потокобезопасной.
void QCoreApplication::removeTranslator ( QTranslator * messageFile ) [static]
Удаляет файл перевода messageFile из списка файлов перевода используемых приложением. (Файл не удаляется из файловой системы.)
bool QCoreApplication::sendEvent ( QObject * receiver, QEvent * event ) [static]
Посылает сообщение event непосредственно приемнику receiver используя функцию notify(). Возвращает значение возвращенное обработчиком сообщений.
Сообщение не удаляется после отправки. Нормальный подход состоит в том, чтобы создавать сообщения в стеке, например:
void QCoreApplication::sendPostedEvents ( QObject * receiver, int event_type ) [static]
Немедленно посылает события ранее поставленные в очередь приемника receiver функцией QCoreApplication::postEvent() receiver и имеющие тип события event_type.
Обратите внимание, что события оконной системы посылаются не этой функцией, а processEvents().
Если receiver равно null, то посылаются все события с типом event_type всем объектам. Если event_type равно 0, то посылаются все события приемника receiver.
void QCoreApplication::sendPostedEvents () [static]
Данная перегруженная функция-член предоставлена для удобства. Ее поведение аналогично поведению вышеприведенной фунции.
Отправляет все посланные сообщения, т.е. освобождает очередь сообщений.
EventFilter QCoreApplication::setEventFilter ( EventFilter filter )
Устанавливает фильтр сообщений filter. Возвращает указатель на ранее определенную функцию-фильтр.
Функция возвращает true для остановки обработки сообщения Qt, или false для стандартной обработки сообщения.
Может быть определен только один фильтр сообщений, но фильтр может использовать возвращаемое значение для вызова ранее установленного фильтра. По умолчанию фильтр не установлен (т.е. функция возвращает 0).
void QCoreApplication::setLibraryPaths ( const QStringList & paths ) [static]
Устанавливает в качестве списка директорий в которых будут искаться подключаемые библиотеки paths. Все ранее установленные пути будут удалены и список путей будет состоять только из строк включенных в paths.
bool QCoreApplication::startingUp () [static]
Возвращает true если объект приложения не был создан; в противном случае возвращает false.
QString QCoreApplication::translate ( const char * context, const char * sourceText, const char * comment = 0, Encoding encoding = DefaultCodec ) [static]
Возвращает перевод текста sourceText, который ищет в ранее установленных файлах перевода. Перевод ищется начиная с наиболее поздно установленного файла переводов назад к первому установленному.
QObject::tr() и QObject::trUtf8() предоставляют аналогичные возможности в более удобной форме.
Для получения более подробной информации о contexts и comments, см. QTranslator.
Данная функция не является виртуальной. Для реализации альтернативной технологии перевода, Вы можете создать подкласс QTranslator.
Внимание: Данный механизм работает только если файлы перевода были установлены до вызова этого метода. Установка и удаление файлов перевода в процессе перевода не поддерживается. Несоблюдение этого правила может закончится аварией или другими неожиданными действиями программы.
Обратите внимание: Данная функция является монопоточной.
bool QCoreApplication::winEventFilter ( MSG * msg, long * result ) [virtual]
Эта функция вызывается при получении каждого сообщения. Осуществите повторно реализацию данной функции если Вы хотите обрабатывать сообщения оконной системы msg, необработанные Qt. Если Вы не хотите, чтобы сообщение было обработано Qt, возвратите true и установите result в значение, которой должна вернуть оконная процедура. В противном случае возвратите false.
Связанные Не-Члены
void qAddPostRoutine ( QtCleanUpFunction ptr )
Добавляет глобальную функцию, которая будет использоваться в деструкторе объекта QApplication. Данную функцию обычно используют для дообавления уборки мусора для программных расширений после завершения работы.
Функция указанная в ptr не должна принимать никаких аргументов и не должна ничего возвращать. Например:
Обратите внимание, что для уборки за расширением приложения или модуля функция qAddPostRoutine() не всегда подходит. Например, если программа разделена не несколько динамически подключаемых модулей, нужный модуль может быть выгружен намного раньше, чем вызывается деструктор QApplication.
Использование счетчиков ссылок для модулей и подключаемых библиотек и механизма родительских и дочерних объектов Qt может быть намного удобнее. Вот пример класса, который использует механизм родительских и дочерних объектов для вызова функции уборки в нужное время:
Правильно выбрав родительский объект часто можно решить проблему уборки данных модуля точно в нужный момент.
Описание Макросов
Q_DECLARE_TR_FUNCTIONS ( context )
Данный макрос удобен, если Вы хотите использовать функцию QObject::tr() или QObject::trUtf8() в классе, не являющемся наследником QObject.
Q_DECLARE_TR_FUNCTIONS() должен быть размещен в самом верху определения класса (до самого первого оператора public: или protected:). Например:
Параметр context, обычно, является именем класса.
Qt Documentation
Contents
The QCoreApplication class provides an event loop for console Qt applications. More.
Public Types
Properties
Public Functions
QCoreApplication()
Public Slots
Signals
Static Public Members
void | addLibraryPath(const QString & path) |
QString | applicationDirPath() |
QString | applicationFilePath() |
QString | applicationName() |
qint64 | applicationPid() |
QString | applicationVersion() |
QStringList | arguments() |
bool | closingDown() |
int | exec() |
void | exit(int returnCode = 0) |
void | flush() |
bool | hasPendingEvents() |
void | installTranslator(QTranslator * translationFile) |
QCoreApplication * | instance() |
QStringList | libraryPaths() |
QString | organizationDomain() |
QString | organizationName() |
void | postEvent(QObject * receiver, QEvent * event) |
void | postEvent(QObject * receiver, QEvent * event, int priority) |
void | processEvents(QEventLoop::ProcessEventsFlags flags = QEventLoop::AllEvents) |
void | processEvents(QEventLoop::ProcessEventsFlags flags, int maxtime) |
void | removeLibraryPath(const QString & path) |
void | removePostedEvents(QObject * receiver) |
void | removePostedEvents(QObject * receiver, int eventType) |
void | removeTranslator(QTranslator * translationFile) |
bool | sendEvent(QObject * receiver, QEvent * event) |
void | sendPostedEvents(QObject * receiver, int event_type) |
void | sendPostedEvents() |
void | setApplicationName(const QString & application) |
void | setApplicationVersion(const QString & version) |
void | setAttribute(Qt::ApplicationAttribute attribute, bool on = true) |
void | setLibraryPaths(const QStringList & paths) |
void | setOrganizationDomain(const QString & orgDomain) |
void | setOrganizationName(const QString & orgName) |
bool | startingUp() |
bool | testAttribute(Qt::ApplicationAttribute attribute) |
QString | translate(const char * context, const char * sourceText, const char * disambiguation, Encoding encoding, int n) |
QString | translate(const char * context, const char * sourceText, const char * disambiguation = 0, Encoding encoding = CodecForTr) |
Reimplemented Protected Functions
Related Non-Members
Macros
Detailed Description
The QCoreApplication class provides an event loop for console Qt applications.
This class is used by non-GUI applications to provide their event loop. For non-GUI application that uses Qt, there should be exactly one QCoreApplication object. For GUI applications, see QApplication.
QCoreApplication contains the main event loop, where all events from the operating system (e.g., timer and network events) and other sources are processed and dispatched. It also handles the application’s initialization and finalization, as well as system-wide and application-wide settings.
The Event Loop and Event Handling
The event loop is started with a call to exec(). Long running operations can call processEvents() to keep the application responsive.
In general, we recommend that you create a QCoreApplication or a QApplication object in your main() function as early as possible. exec() will not return until the event loop exits; e.g., when quit() is called.
Several static convenience functions are also provided. The QCoreApplication object is available from instance(). Events can be sent or posted using sendEvent(), postEvent(), and sendPostedEvents(). Pending events can be removed with removePostedEvents() or flushed with flush().
The class provides a quit() slot and an aboutToQuit() signal.
Application and Library Paths
Internationalization and Translations
Translation files can be added or removed using installTranslator() and removeTranslator(). Application strings can be translated using translate(). The QObject::tr() and QObject::trUtf8() functions are implemented in terms of translate().
Accessing Command Line Arguments
The command line arguments which are passed to QCoreApplication’s constructor should be accessed using the arguments() function. Note that some arguments supplied by the user may have been processed and removed by QCoreApplication.
In cases where command line arguments need to be obtained using the argv() function, you must convert them from the local string encoding using QString::fromLocal8Bit().
Locale Settings
On Unix/Linux Qt is configured to use the system locale settings by default. This can cause a conflict when using POSIX functions, for instance, when converting between data types such as floats and strings, since the notation may differ between locales. To get around this problem, call the POSIX function setlocale(LC_NUMERIC,»C») right after initializing QApplication or QCoreApplication to reset the locale that is used for number formatting to «C»-locale.
Member Type Documentation
enum QCoreApplication:: Encoding
This enum type defines the 8-bit encoding of character string arguments to translate():
Constant | Value | Description |
---|---|---|
QCoreApplication::CodecForTr | 0 | The encoding specified by QTextCodec::codecForTr() (Latin-1 if none has been set). |
QCoreApplication::UnicodeUTF8 | 1 | UTF-8. |
QCoreApplication::DefaultCodec | CodecForTr | (Obsolete) Use CodecForTr instead. |
typedef QCoreApplication:: EventFilter
A function with the following signature that can be used as an event filter:
Property Documentation
applicationName : QString
This property holds the name of this application.
The value is used by the QSettings class when it is constructed using the empty constructor. This saves having to repeat this information each time a QSettings object is created.
On BlackBerry this property is read-only. It is obtained from the BAR application descriptor file.
QString | applicationName () |
void | setApplicationName (const QString & application) |
applicationVersion : QString
This property holds the version of this application.
On BlackBerry this property is read-only. It is obtained from the BAR application descriptor file.
This property was introduced in Qt 4.4.
QString | applicationVersion () |
void | setApplicationVersion (const QString & version) |
organizationDomain : QString
This property holds the Internet domain of the organization that wrote this application.
The value is used by the QSettings class when it is constructed using the empty constructor. This saves having to repeat this information each time a QSettings object is created.
On Mac, QSettings uses organizationDomain() as the organization if it’s not an empty string; otherwise it uses organizationName(). On all other platforms, QSettings uses organizationName() as the organization.
QString | organizationDomain () |
void | setOrganizationDomain (const QString & orgDomain) |
organizationName : QString
This property holds the name of the organization that wrote this application.
The value is used by the QSettings class when it is constructed using the empty constructor. This saves having to repeat this information each time a QSettings object is created.
On Mac, QSettings uses organizationDomain() as the organization if it’s not an empty string; otherwise it uses organizationName(). On all other platforms, QSettings uses organizationName() as the organization.
On BlackBerry this property is read-only. It is obtained from the BAR application descriptor file.
QString | organizationName () |
void | setOrganizationName (const QString & orgName) |
Member Function Documentation
QCoreApplication:: QCoreApplication ( int & argc, char ** argv)
Constructs a Qt kernel application. Kernel applications are applications without a graphical user interface. These type of applications are used at the console or as server processes.
The argc and argv arguments are processed by the application, and made available in a more convenient form by the arguments() function.
Warning: The data referred to by argc and argv must stay valid for the entire lifetime of the QCoreApplication object. In addition, argc must be greater than zero and argv must contain at least one valid character string.
QCoreApplication::
[signal] void QCoreApplication:: aboutToQuit ()
This signal is emitted when the application is about to quit the main event loop, e.g. when the event loop level drops to zero. This may happen either after a call to quit() from inside the application or when the users shuts down the entire desktop session.
The signal is particularly useful if your application has to do some last-second cleanup. Note that no user interaction is possible in this state.
[static] void QCoreApplication:: addLibraryPath (const QString & path)
Prepends path to the beginning of the library path list, ensuring that it is searched for libraries first. If path is empty or already in the path list, the path list is not changed.
In Symbian this function is only useful for adding paths for finding Qt extension plugin stubs, since the OS can only load libraries from the /sys/bin directory.
[static] QString QCoreApplication:: applicationDirPath ()
Returns the directory that contains the application executable.
For example, if you have installed Qt in the C:\Trolltech\Qt directory, and you run the regexp example, this function will return «C:/Trolltech/Qt/examples/tools/regexp».
On Mac OS X this will point to the directory actually containing the executable, which may be inside of an application bundle (if the application is bundled).
Warning: On Linux, this function will try to get the path from the /proc file system. If that fails, it assumes that argv[0] contains the absolute file name of the executable. The function also assumes that the current directory has not been changed by the application.
[static] QString QCoreApplication:: applicationFilePath ()
Returns the file path of the application executable.
For example, if you have installed Qt in the /usr/local/qt directory, and you run the regexp example, this function will return «/usr/local/qt/examples/tools/regexp/regexp».
Warning: On Linux, this function will try to get the path from the /proc file system. If that fails, it assumes that argv[0] contains the absolute file name of the executable. The function also assumes that the current directory has not been changed by the application.
[static] qint64 QCoreApplication:: applicationPid ()
Returns the current process ID for the application.
This function was introduced in Qt 4.4.
[static] QStringList QCoreApplication:: arguments ()
Returns the list of command-line arguments.
Usually arguments().at(0) is the program name, arguments().at(1) is the first argument, and arguments().last() is the last argument. See the note below about Windows.
Warning: On Unix, this list is built from the argc and argv parameters passed to the constructor in the main() function. The string-data in argv is interpreted using QString::fromLocal8Bit(); hence it is not possible to pass, for example, Japanese command line arguments on a system that runs in a Latin1 locale. Most modern Unix systems do not have this limitation, as they are Unicode-based.
On NT-based Windows, this limitation does not apply either. On Windows, the arguments() are not built from the contents of argv/argc, as the content does not support Unicode. Instead, the arguments() are constructed from the return value of GetCommandLine(). As a result of this, the string given by arguments().at(0) might not be the program name on Windows, depending on how the application was started.
For Symbian applications started with RApaLsSession::StartApp one can specify arguments using CApaCommandLine::SetTailEndL function. Such arguments are only available via this method; they will not be passed to main function. Also note that only 8-bit string data set with CApaCommandLine::SetTailEndL is supported by this function.
This function was introduced in Qt 4.1.
[static] bool QCoreApplication:: closingDown ()
Returns true if the application objects are being destroyed; otherwise returns false.
[virtual protected] bool QCoreApplication:: event ( QEvent * e)
[static] int QCoreApplication:: exec ()
Enters the main event loop and waits until exit() is called. Returns the value that was set to exit() (which is 0 if exit() is called via quit()).
It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets.
To make your application perform idle processing (i.e. executing a special function whenever there are no pending events), use a QTimer with 0 timeout. More advanced idle processing schemes can be achieved using processEvents().
We recommend that you connect clean-up code to the aboutToQuit() signal, instead of putting it in your application’s main() function because on some platforms the QCoreApplication::exec() call may not return. For example, on Windows when the user logs off, the system terminates the process after Qt closes all top-level windows. Hence, there is no guarantee that the application will have time to exit its event loop and execute code at the end of the main() function after the QCoreApplication::exec() call.
[static] void QCoreApplication:: exit ( int returnCode = 0)
Tells the application to exit with a return code.
After this function has been called, the application leaves the main event loop and returns from the call to exec(). The exec() function returns returnCode. If the event loop is not running, this function does nothing.
By convention, a returnCode of 0 means success, and any non-zero value indicates an error.
bool QCoreApplication:: filterEvent ( void * message, long * result)
Sends message through the event filter that was set by setEventFilter(). If no event filter has been set, this function returns false; otherwise, this function returns the result of the event filter function in the result parameter.
[static] void QCoreApplication:: flush ()
Flushes the platform specific event queues.
If you are doing graphical changes inside a loop that does not return to the event loop on asynchronous window systems like X11 or double buffered window systems like Mac OS X, and you want to visualize these changes immediately (e.g. Splash Screens), call this function.
[static] bool QCoreApplication:: hasPendingEvents ()
This function returns true if there are pending events; otherwise returns false. Pending events can be either from the window system or posted events using postEvent().
[static] void QCoreApplication:: installTranslator ( QTranslator * translationFile)
Adds the translation file translationFile to the list of translation files to be used for translations.
Multiple translation files can be installed. Translations are searched for in the reverse order in which they were installed, so the most recently installed translation file is searched first and the first translation file installed is searched last. The search stops as soon as a translation containing a matching string is found.
Installing or removing a QTranslator, or changing an installed QTranslator generates a LanguageChange event for the QCoreApplication instance. A QApplication instance will propagate the event to all toplevel windows, where a reimplementation of changeEvent can re-translate the user interface by passing user-visible strings via the tr() function to the respective property setters. User-interface classes generated by Qt Designer provide a retranslateUi() function that can be called.
[static] QCoreApplication * QCoreApplication:: instance ()
Returns a pointer to the application’s QCoreApplication (or QApplication) instance.
If no instance has been allocated, null is returned.
[static] QStringList QCoreApplication:: libraryPaths ()
Returns a list of paths that the application will search when dynamically loading libraries.
Qt provides default library paths, but they can also be set using a qt.conf file. Paths specified in this file will override default values.
If you want to iterate over the list, you can use the foreach pseudo-keyword:
[virtual] bool QCoreApplication:: notify ( QObject * receiver, QEvent * event)
Sends event to receiver: receiver->event(event). Returns the value that is returned from the receiver’s event handler. Note that this function is called for all events sent to any object in any thread.
For certain types of events (e.g. mouse and key events), the event will be propagated to the receiver’s parent and so on up to the top-level object if the receiver is not interested in the event (i.e., it returns false).
There are five different ways that events can be processed; reimplementing this virtual function is just one of them. All five approaches are listed below:
[static] void QCoreApplication:: postEvent ( QObject * receiver, QEvent * event)
Adds the event event, with the object receiver as the receiver of the event, to an event queue and returns immediately.
The event must be allocated on the heap since the post event queue will take ownership of the event and delete it once it has been posted. It is not safe to access the event after it has been posted.
When control returns to the main event loop, all events that are stored in the queue will be sent using the notify() function.
Events are processed in the order posted. For more control over the processing order, use the postEvent() overload below, which takes a priority argument. This function posts all event with a Qt::NormalEventPriority.
[static] void QCoreApplication:: postEvent ( QObject * receiver, QEvent * event, int priority)
This function overloads postEvent().
Adds the event event, with the object receiver as the receiver of the event, to an event queue and returns immediately.
The event must be allocated on the heap since the post event queue will take ownership of the event and delete it once it has been posted. It is not safe to access the event after it has been posted.
When control returns to the main event loop, all events that are stored in the queue will be sent using the notify() function.
Events are sorted in descending priority order, i.e. events with a high priority are queued before events with a lower priority. The priority can be any integer value, i.e. between INT_MAX and INT_MIN, inclusive; see Qt::EventPriority for more details. Events with equal priority will be processed in the order posted.
This function was introduced in Qt 4.3.
[static] void QCoreApplication:: processEvents ( QEventLoop::ProcessEventsFlags flags = QEventLoop::AllEvents)
Processes all pending events for the calling thread according to the specified flags until there are no more events to process.
You can call this function occasionally when your program is busy performing a long operation (e.g. copying a file).
In event you are running a local loop which calls this function continuously, without an event loop, the DeferredDelete events will not be processed. This can affect the behaviour of widgets, e.g. QToolTip, that rely on DeferredDelete events to function properly. An alternative would be to call sendPostedEvents() from within that local loop.
Calling this function processes events only for the calling thread.
[static] void QCoreApplication:: processEvents ( QEventLoop::ProcessEventsFlags flags, int maxtime)
This function overloads processEvents().
Processes pending events for the calling thread for maxtime milliseconds or until there are no more events to process, whichever is shorter.
You can call this function occasionally when you program is busy doing a long operation (e.g. copying a file).
Calling this function processes events only for the calling thread.
[static slot] void QCoreApplication:: quit ()
Tells the application to exit with return code 0 (success). Equivalent to calling QCoreApplication::exit(0).
It’s common to connect the QApplication::lastWindowClosed() signal to quit(), and you also often connect e.g. QAbstractButton::clicked() or signals in QAction, QMenu, or QMenuBar to it.
[static] void QCoreApplication:: removeLibraryPath (const QString & path)
Removes path from the library path list. If path is empty or not in the path list, the list is not changed.
[static] void QCoreApplication:: removePostedEvents ( QObject * receiver)
Removes all events posted using postEvent() for receiver.
The events are not dispatched, instead they are removed from the queue. You should never need to call this function. If you do call it, be aware that killing events may cause receiver to break one or more invariants.
[static] void QCoreApplication:: removePostedEvents ( QObject * receiver, int eventType)
Removes all events of the given eventType that were posted using postEvent() for receiver.
The events are not dispatched, instead they are removed from the queue. You should never need to call this function. If you do call it, be aware that killing events may cause receiver to break one or more invariants.
If receiver is null, the events of eventType are removed for all objects. If eventType is 0, all the events are removed for receiver.
This function was introduced in Qt 4.3.
[static] void QCoreApplication:: removeTranslator ( QTranslator * translationFile)
Removes the translation file translationFile from the list of translation files used by this application. (It does not delete the translation file from the file system.)
[static] bool QCoreApplication:: sendEvent ( QObject * receiver, QEvent * event)
Sends event event directly to receiver receiver, using the notify() function. Returns the value that was returned from the event handler.
The event is not deleted when the event has been sent. The normal approach is to create the event on the stack, for example:
[static] void QCoreApplication:: sendPostedEvents ( QObject * receiver, int event_type)
Immediately dispatches all events which have been previously queued with QCoreApplication::postEvent() and which are for the object receiver and have the event type event_type.
Events from the window system are not dispatched by this function, but by processEvents().
If receiver is null, the events of event_type are sent for all objects. If event_type is 0, all the events are sent for receiver.
Note: This method must be called from the same thread as its QObject parameter, receiver.
[static] void QCoreApplication:: sendPostedEvents ()
Dispatches all posted events, i.e. empties the event queue.
[static] void QCoreApplication:: setAttribute ( Qt::ApplicationAttribute attribute, bool on = true)
Sets the attribute attribute if on is true; otherwise clears the attribute.
One of the attributes that can be set with this method is Qt::AA_ImmediateWidgetCreation. It tells Qt to create toplevel windows immediately. Normally, resources for widgets are allocated on demand to improve efficiency and minimize resource usage. Therefore, if it is important to minimize resource consumption, do not set this attribute.
EventFilter QCoreApplication:: setEventFilter ( EventFilter filter)
Replaces the event filter function for the QCoreApplication with filter and returns the pointer to the replaced event filter function. Only the current event filter function is called. If you want to use both filter functions, save the replaced EventFilter in a place where yours can call it.
The event filter function set here is called for all messages received by all threads meant for all Qt objects. It is not called for messages that are not meant for Qt objects.
The event filter function should return true if the message should be filtered, (i.e. stopped). It should return false to allow processing the message to continue.
By default, no event filter function is set (i.e., this function returns a null EventFilter the first time it is called).
Note: The filter function set here receives native messages, i.e. MSG or XEvent structs, that are going to Qt objects. It is called by QCoreApplication::filterEvent(). If the filter function returns false to indicate the message should be processed further, the native message can then be translated into a QEvent and handled by the standard Qt event filering, e.g. QObject::installEventFilter().
Note: The filter function set here is different form the filter function set via QAbstractEventDispatcher::setEventFilter(), which gets all messages received by its thread, even messages meant for objects that are not handled by Qt.
[static] void QCoreApplication:: setLibraryPaths (const QStringList & paths)
Sets the list of directories to search when loading libraries to paths. All existing paths will be deleted and the path list will consist of the paths given in paths.
In Symbian this function is only useful for setting paths for finding Qt extension plugin stubs, since the OS can only load libraries from the /sys/bin directory.
[static] bool QCoreApplication:: startingUp ()
Returns true if an application object has not been created yet; otherwise returns false.
[static] bool QCoreApplication:: testAttribute ( Qt::ApplicationAttribute attribute)
Returns true if attribute attribute is set; otherwise returns false.
[static] QString QCoreApplication:: translate (const char * context, const char * sourceText, const char * disambiguation, Encoding encoding, int n)
Returns the translation text for sourceText, by querying the installed translation files. The translation files are searched from the most recently installed file back to the first installed file.
QObject::tr() and QObject::trUtf8() provide this functionality more conveniently.
context is typically a class name (e.g., «MyDialog») and sourceText is either English text or a short identifying text.
disambiguation is an identifying string, for when the same sourceText is used in different roles within the same context. By default, it is null.
See the QTranslator and QObject::tr() documentation for more information about contexts, disambiguations and comments.
encoding indicates the 8-bit encoding of character strings.
n is used in conjunction with %n to support plural forms. See QObject::tr() for details.
If none of the translation files contain a translation for sourceText in context, this function returns a QString equivalent of sourceText. The encoding of sourceText is specified by encoding; it defaults to CodecForTr.
This function is not virtual. You can use alternative translation techniques by subclassing QTranslator.
Warning: This method is reentrant only if all translators are installed before calling this method. Installing or removing translators while performing translations is not supported. Doing so will most likely result in crashes or other undesirable behavior.
This function was introduced in Qt 4.5.
[static] QString QCoreApplication:: translate (const char * context, const char * sourceText, const char * disambiguation = 0, Encoding encoding = CodecForTr)
This function overloads translate().
[virtual] bool QCoreApplication:: winEventFilter ( MSG * msg, long * result)
The message procedure calls this function for every message received. Reimplement this function if you want to process window messages msg that are not processed by Qt. If you don’t want the event to be processed by Qt, then return true and set result to the value that the window procedure should return. Otherwise return false.
It is only directly addressed messages that are filtered. To handle system wide messages, such as messages from a registered hot key, you need to install an event filter on the event dispatcher, which is returned from QAbstractEventDispatcher::instance().
Related Non-Members
void qAddPostRoutine ( QtCleanUpFunction ptr)
Adds a global routine that will be called from the QApplication destructor. This function is normally used to add cleanup routines for program-wide functionality.
The function specified by ptr should take no arguments and should return nothing. For example:
Note that for an application- or module-wide cleanup, qAddPostRoutine() is often not suitable. For example, if the program is split into dynamically loaded modules, the relevant module may be unloaded long before the QApplication destructor is called.
For modules and libraries, using a reference-counted initialization manager or Qt’s parent-child deletion mechanism may be better. Here is an example of a private class that uses the parent-child mechanism to call a cleanup function at the right time:
By selecting the right parent object, this can often be made to clean up the module’s data at the right moment.
Macro Documentation
Q_DECLARE_TR_FUNCTIONS ( context)
This macro is useful if you want to use QObject::tr() or QObject::trUtf8() in classes that don’t inherit from QObject.
Q_DECLARE_TR_FUNCTIONS() must appear at the very top of the class definition (before the first public: or protected: ). For example:
The context parameter is normally the class name, but it can be any string.
В© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.