!206 合并openkylin/yangtze,处理编译问题与部分lintian检查问题

Merge pull request !206 from xibowen/debian/unstable
This commit is contained in:
MouseZhang 2024-01-26 10:10:36 +00:00 committed by Gitee
commit 18c29cbd0a
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
356 changed files with 17656 additions and 10800 deletions

53
.gitignore vendored
View File

@ -1,53 +0,0 @@
# C++ objects and libs
*.slo
*.lo
*.o
*.a
*.la
*.lai
*.so
*.so.*
*.rc
*.dll
*.dylib
# Qt-es
object_script.*.Release
object_script.*.Debug
*_plugin_import.cpp
/.qmake.cache
/.qmake.stash
*.pro.user
*.pro.user.*
*.qbs.user
*.qbs.user.*
*.moc
moc_*.cpp
moc_*.h
qrc_*.cpp
ui_*.h
*.qmlc
*.jsc
Makefile*
*build-*
*.qm
*.prl
# Qt unit tests
target_wrapper.*
# QtCreator
*.autosave
# QtCreator Qml
*.qmlproject.user
*.qmlproject.user.*
# QtCreator CMake
CMakeLists.txt.user*
# QtCreator 4.8< compilation database
compile_commands.json
# QtCreator local machine specific files for imported projects
*creator.user*

View File

@ -1,224 +0,0 @@
Changelog
=========
__3.0.18__
----------
* Fallback to standard QApplication class on iOS and Android systems where
the library is not supported.
__3.0.17__
----------
* Fixed compilation warning/error caused by `geteuid()` on unix based systems.
_Iakov Kirilenko_
* Added CMake support
_Hennadii Chernyshchyk_
__3.0.16__
----------
* Use geteuid and getpwuid to get username on Unix, fallback to environment variable.
_Jonas Kvinge_
__3.0.15__
----------
* Bug Fix: sendMessage() might return false even though data was actually written.
_Jonas Kvinge_
__3.0.14__
----------
* Fixed uninitialised variables in the `SingleApplicationPrivate` constructor.
__3.0.13a__
----------
* Process socket events asynchronously
* Fix undefined variable error on Windows
_Francis Giraldeau_
__3.0.12a__
----------
* Removed signal handling.
__3.0.11a__
----------
* Fixed bug where the message sent by the second process was not received
correctly when the message is sent immediately following a connection.
_Francis Giraldeau_
* Refactored code and implemented shared memory block consistency checks
via `qChecksum()` (CRC-16).
* Explicit `qWarning` and `qCritical` when the library is unable to initialise
correctly.
__3.0.10__
----------
* Removed C style casts and eliminated all clang warnings. Fixed `instanceId`
reading from only one byte in the message deserialization. Cleaned up
serialization code using `QDataStream`. Changed connection type to use
`quint8 enum` rather than `char`.
* Renamed `SingleAppConnectionType` to `ConnectionType`. Added initialization
values to all `ConnectionType` enum cases.
_Jedidiah Buck McCready_
__3.0.9__
---------
* Added SingleApplicationPrivate::primaryPid() as a solution to allow
bringing the primary window of an application to the foreground on
Windows.
_Eelco van Dam from Peacs BV_
__3.0.8__
---------
* Bug fix - changed QApplication::instance() to QCoreApplication::instance()
_Evgeniy Bazhenov_
__3.0.7a__
----------
* Fixed compilation error with Mingw32 in MXE thanks to Vitaly Tonkacheyev.
* Removed QMutex used for thread safe behaviour. The implementation now uses
QCoreApplication::instance() to get an instance to SingleApplication for
memory deallocation.
__3.0.6a__
----------
* Reverted GetUserName API usage on Windows. Fixed bug with missing library.
* Fixed bug in the Calculator example, preventing it's window to be raised
on Windows.
Special thanks to Charles Gunawan.
__3.0.5a__
----------
* Fixed a memory leak in the SingleApplicationPrivate destructor.
_Sergei Moiseev_
__3.0.4a__
----------
* Fixed shadow and uninitialised variable warnings.
_Paul Walmsley_
__3.0.3a__
----------
* Removed Microsoft Windows specific code for getting username due to
multiple problems and compiler differences on Windows platforms. On
Windows the shared memory block in User mode now includes the user's
home path (which contains the user's username).
* Explicitly getting absolute path of the user's home directory as on Unix
a relative path (`~`) may be returned.
__3.0.2a__
----------
* Fixed bug on Windows when username containing wide characters causes the
library to crash.
_Le Liu_
__3.0.1a__
----------
* Allows the application path and version to be excluded from the server name
hash. The following flags were added for this purpose:
* `SingleApplication::Mode::ExcludeAppVersion`
* `SingleApplication::Mode::ExcludeAppPath`
* Allow a non elevated process to connect to a local server created by an
elevated process run by the same user on Windows
* Fixes a problem with upper case letters in paths on Windows
_Le Liu_
__v3.0a__
---------
* Deprecated secondary instances count.
* Added a sendMessage() method to send a message to the primary instance.
* Added a receivedMessage() signal, emitted when a message is received from a
secondary instance.
* The SingleApplication constructor's third parameter is now a bool
specifying if the current instance should be allowed to run as a secondary
instance if there is already a primary instance.
* The SingleApplication constructor accept a fourth parameter specifying if
the SingleApplication block should be User-wide or System-wide.
* SingleApplication no longer relies on `applicationName` and
`organizationName` to be set. It instead concatenates all of the following
data and computes a `SHA256` hash which is used as the key of the
`QSharedMemory` block and the `QLocalServer`. Since at least
`applicationFilePath` is always present there is no need to explicitly set
any of the following prior to initialising `SingleApplication`.
* `QCoreApplication::applicationName`
* `QCoreApplication::applicationVersion`
* `QCoreApplication::applicationFilePath`
* `QCoreApplication::organizationName`
* `QCoreApplication::organizationDomain`
* User name or home directory path if in User mode
* The primary instance is no longer notified when a secondary instance had
been started by default. A `Mode` flag for this feature exists.
* Added `instanceNumber()` which represents a unique identifier for each
secondary instance started. When called from the primary instance will
return `0`.
__v2.4__
--------
* Stability improvements
* Support for secondary instances.
* The library now recovers safely after the primary process has crashed
and the shared memory had not been deleted.
__v2.3__
--------
* Improved pimpl design and inheritance safety.
_Vladislav Pyatnichenko_
__v2.2__
--------
* The `QAPPLICATION_CLASS` macro can now be defined in the file including the
Single Application header or with a `DEFINES+=` statement in the project file.
__v2.1__
--------
* A race condition can no longer occur when starting two processes nearly
simultaneously.
Fix issue [#3](https://github.com/itay-grudev/SingleApplication/issues/3)
__v2.0__
--------
* SingleApplication is now being passed a reference to `argc` instead of a
copy.
Fix issue [#1](https://github.com/itay-grudev/SingleApplication/issues/1)
* Improved documentation.

View File

@ -1,43 +0,0 @@
cmake_minimum_required(VERSION 3.1.0)
project(SingleApplication)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_AUTOMOC ON)
# SingleApplication base class
set(QAPPLICATION_CLASS QCoreApplication CACHE STRING "Inheritance class for SingleApplication")
set_property(CACHE QAPPLICATION_CLASS PROPERTY STRINGS QApplication QGuiApplication QCoreApplication)
# Libary target
add_library(${PROJECT_NAME} STATIC
singleapplication.cpp
singleapplication_p.cpp
)
# Find dependencies
find_package(Qt5Network)
if(QAPPLICATION_CLASS STREQUAL QApplication)
find_package(Qt5 COMPONENTS Widgets REQUIRED)
elseif(QAPPLICATION_CLASS STREQUAL QGuiApplication)
find_package(Qt5 COMPONENTS Gui REQUIRED)
else()
find_package(Qt5 COMPONENTS Core REQUIRED)
endif()
add_compile_definitions(QAPPLICATION_CLASS=${QAPPLICATION_CLASS})
# Link dependencies
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Network)
if(QAPPLICATION_CLASS STREQUAL QApplication)
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Widgets)
elseif(QAPPLICATION_CLASS STREQUAL QGuiApplication)
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Gui)
else()
target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Core)
endif()
if(WIN32)
target_link_libraries(${PROJECT_NAME} PRIVATE advapi32)
endif()
target_include_directories(${PROJECT_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})

View File

@ -1,24 +0,0 @@
The MIT License (MIT)
Copyright (c) Itay Grudev 2015 - 2016
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Note: Some of the examples include code not distributed under the terms of the
MIT License.

View File

@ -1,277 +0,0 @@
SingleApplication
=================
This is a replacement of the QtSingleApplication for `Qt5`.
Keeps the Primary Instance of your Application and kills each subsequent
instances. It can (if enabled) spawn secondary (non-related to the primary)
instances and can send data to the primary instance from secondary instances.
Usage
-----
The `SingleApplication` class inherits from whatever `Q[Core|Gui]Application`
class you specify via the `QAPPLICATION_CLASS` macro (`QCoreApplication` is the
default). Further usage is similar to the use of the `Q[Core|Gui]Application`
classes.
The library sets up a `QLocalServer` and a `QSharedMemory` block. The first
instance of your Application is your Primary Instance. It would check if the
shared memory block exists and if not it will start a `QLocalServer` and listen
for connections. Each subsequent instance of your application would check if the
shared memory block exists and if it does, it will connect to the QLocalServer
to notify the primary instance that a new instance had been started, after which
it would terminate with status code `0`. In the Primary Instance
`SingleApplication` would emit the `instanceStarted()` signal upon detecting
that a new instance had been started.
The library uses `stdlib` to terminate the program with the `exit()` function.
You can use the library as if you use any other `QCoreApplication` derived
class:
```cpp
#include <QApplication>
#include <SingleApplication.h>
int main( int argc, char* argv[] )
{
SingleApplication app( argc, argv );
return app.exec();
}
```
To include the library files I would recommend that you add it as a git
submodule to your project and include it's contents with a `.pri` file. Here is
how:
```bash
git submodule add git@github.com:itay-grudev/SingleApplication.git singleapplication
```
**Qmake:**
Then include the `singleapplication.pri` file in your `.pro` project file.
```qmake
include(singleapplication/singleapplication.pri)
DEFINES += QAPPLICATION_CLASS=QApplication
```
**CMake:**
Then include the subdirectory in your `CMakeLists.txt` project file.
```cmake
set(QAPPLICATION_CLASS QApplication CACHE STRING "Inheritance class for SingleApplication")
add_subdirectory(src/third-party/singleapplication)
```
Also don't forget to specify which `QCoreApplication` class your app is using if it
is not `QCoreApplication` as in examples above.
The `Instance Started` signal
------------------------
The SingleApplication class implements a `instanceStarted()` signal. You can
bind to that signal to raise your application's window when a new instance had
been started, for example.
```cpp
// window is a QWindow instance
QObject::connect(
&app,
&SingleApplication::instanceStarted,
&window,
&QWindow::raise
);
```
Using `SingleApplication::instance()` is a neat way to get the
`SingleApplication` instance for binding to it's signals anywhere in your
program.
__Note:__ On Windows the ability to bring the application windows to the
foreground is restricted. See [Windows specific implementations](Windows.md)
for a workaround and an example implementation.
Secondary Instances
-------------------
If you want to be able to launch additional Secondary Instances (not related to
your Primary Instance) you have to enable that with the third parameter of the
`SingleApplication` constructor. The default is `false` meaning no Secondary
Instances. Here is an example of how you would start a Secondary Instance send
a message with the command line arguments to the primary instance and then shut
down.
```cpp
int main(int argc, char *argv[])
{
SingleApplication app( argc, argv, true );
if( app.isSecondary() ) {
app.sendMessage( app.arguments().join(' ')).toUtf8() );
app.exit( 0 );
}
return app.exec();
}
```
*__Note:__ A secondary instance won't cause the emission of the
`instanceStarted()` signal by default. See `SingleApplication::Mode` for more
details.*
You can check whether your instance is a primary or secondary with the following
methods:
```cpp
app.isPrimary();
// or
app.isSecondary();
```
*__Note:__ If your Primary Instance is terminated a newly launched instance
will replace the Primary one even if the Secondary flag has been set.*
API
---
### Members
```cpp
SingleApplication::SingleApplication( int &argc, char *argv[], bool allowSecondary = false, Options options = Mode::User, int timeout = 100 )
```
Depending on whether `allowSecondary` is set, this constructor may terminate
your app if there is already a primary instance running. Additional `Options`
can be specified to set whether the SingleApplication block should work
user-wide or system-wide. Additionally the `Mode::SecondaryNotification` may be
used to notify the primary instance whenever a secondary instance had been
started (disabled by default). `timeout` specifies the maximum time in
milliseconds to wait for blocking operations.
*__Note:__ `argc` and `argv` may be changed as Qt removes arguments that it
recognizes.*
*__Note:__ `Mode::SecondaryNotification` only works if set on both the primary
and the secondary instance.*
*__Note:__ Operating system can restrict the shared memory blocks to the same
user, in which case the User/System modes will have no effect and the block will
be user wide.*
---
```cpp
bool SingleApplication::sendMessage( QByteArray message, int timeout = 100 )
```
Sends `message` to the Primary Instance. Uses `timeout` as a the maximum timeout
in milliseconds for blocking functions
---
```cpp
bool SingleApplication::isPrimary()
```
Returns if the instance is the primary instance.
---
```cpp
bool SingleApplication::isSecondary()
```
Returns if the instance is a secondary instance.
---
```cpp
quint32 SingleApplication::instanceId()
```
Returns a unique identifier for the current instance.
---
```cpp
qint64 SingleApplication::primaryPid()
```
Returns the process ID (PID) of the primary instance.
### Signals
```cpp
void SingleApplication::instanceStarted()
```
Triggered whenever a new instance had been started, except for secondary
instances if the `Mode::SecondaryNotification` flag is not specified.
---
```cpp
void SingleApplication::receivedMessage( quint32 instanceId, QByteArray message )
```
Triggered whenever there is a message received from a secondary instance.
---
### Flags
```cpp
enum SingleApplication::Mode
```
* `Mode::User` - The SingleApplication block should apply user wide. This adds
user specific data to the key used for the shared memory and server name.
This is the default functionality.
* `Mode::System` The SingleApplication block applies system-wide.
* `Mode::SecondaryNotification` Whether to trigger `instanceStarted()` even
whenever secondary instances are started.
* `Mode::ExcludeAppPath` Excludes the application path from the server name
(and memory block) hash.
* `Mode::ExcludeAppVersion` Excludes the application version from the server
name (and memory block) hash.
*__Note:__ `Mode::SecondaryNotification` only works if set on both the primary
and the secondary instance.*
*__Note:__ Operating system can restrict the shared memory blocks to the same
user, in which case the User/System modes will have no effect and the block will
be user wide.*
---
Versioning
----------
Each major version introduces either very significant changes or is not
backwards compatible with the previous version. Minor versions only add
additional features, bug fixes or performance improvements and are backwards
compatible with the previous release. See [`CHANGELOG.md`](CHANGELOG.md) for
more details.
Implementation
--------------
The library is implemented with a QSharedMemory block which is thread safe and
guarantees a race condition will not occur. It also uses a QLocalSocket to
notify the main process that a new instance had been spawned and thus invoke the
`instanceStarted()` signal and for messaging the primary instance.
Additionally the library can recover from being forcefully killed on *nix
systems and will reset the memory block given that there are no other
instances running.
License
-------
This library and it's supporting documentation are released under
`The MIT License (MIT)` with the exception of the Qt calculator examples which
is distributed under the BSD license.

View File

@ -1,46 +0,0 @@
Windows Specific Implementations
================================
Setting the foreground window
-----------------------------
In the `instanceStarted()` example in the `README` we demonstrated how an
application can bring it's primary instance window whenever a second copy
of the application is started.
On Windows the ability to bring the application windows to the foreground is
restricted, see [`AllowSetForegroundWindow()`][AllowSetForegroundWindow] for more
details.
The background process (the primary instance) can bring its windows to the
foreground if it is allowed by the current foreground process (the secondary
instance). To bypass this `SingleApplication` must be initialized with the
`allowSecondary` parameter set to `true` and the `options` parameter must
include `Mode::SecondaryNotification`, See `SingleApplication::Mode` for more
details.
Here is an example:
```cpp
if( app.isSecondary() ) {
// This API requires LIBS += User32.lib to be added to the project
AllowSetForegroundWindow( DWORD( app.primaryPid() ) );
}
if( app.isPrimary() ) {
QObject::connect(
&app,
&SingleApplication::instanceStarted,
this,
&App::instanceStarted
);
}
```
```cpp
void App::instanceStarted() {
QApplication::setActiveWindow( [window/widget to set to the foreground] );
}
```
[AllowSetForegroundWindow]: https://msdn.microsoft.com/en-us/library/windows/desktop/ms632668.aspx

View File

@ -1,181 +0,0 @@
// The MIT License (MIT)
//
// Copyright (c) Itay Grudev 2015 - 2018
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#include <QtCore/QTime>
#include <QtCore/QThread>
#include <QtCore/QDateTime>
#include <QtCore/QByteArray>
#include <QtCore/QSharedMemory>
#include "singleapplication.h"
#include "singleapplication_p.h"
/**
* @brief Constructor. Checks and fires up LocalServer or closes the program
* if another instance already exists
* @param argc
* @param argv
* @param {bool} allowSecondaryInstances
*/
SingleApplication::SingleApplication(int &argc, char *argv[], const char* appName, bool allowSecondary, Options options, int timeout )
: app_t( argc, argv ), d_ptr( new SingleApplicationPrivate( this ) )
{
Q_D(SingleApplication);
#if defined(Q_OS_ANDROID) || defined(Q_OS_IOS)
// On Android and iOS since the library is not supported fallback to
// standard QApplication behaviour by simply returning at this point.
qWarning() << "SingleApplication is not supported on Android and iOS systems.";
return;
#endif
// Store the current mode of the program
d->options = options;
// Generating an application ID used for identifying the shared memory
// block and QLocalServer
d->genBlockServerName(appName);
#ifdef Q_OS_UNIX
// By explicitly attaching it and then deleting it we make sure that the
// memory is deleted even after the process has crashed on Unix.
d->memory = new QSharedMemory( d->blockServerName );
d->memory->attach();
delete d->memory;
#endif
// Guarantee thread safe behaviour with a shared memory block.
d->memory = new QSharedMemory( d->blockServerName );
// Create a shared memory block
if( d->memory->create( sizeof( InstancesInfo ) ) ) {
// Initialize the shared memory block
d->memory->lock();
d->initializeMemoryBlock();
d->memory->unlock();
} else {
// Attempt to attach to the memory segment
if( ! d->memory->attach() ) {
qCritical() << "SingleApplication: Unable to attach to shared memory block.";
qCritical() << d->memory->errorString();
delete d;
::exit( EXIT_FAILURE );
}
}
InstancesInfo* inst = static_cast<InstancesInfo*>( d->memory->data() );
QTime time;
time.start();
// Make sure the shared memory block is initialised and in consistent state
while( true ) {
d->memory->lock();
if( d->blockChecksum() == inst->checksum ) break;
if( time.elapsed() > 5000 ) {
qWarning() << "SingleApplication: Shared memory block has been in an inconsistent state from more than 5s. Assuming primary instance failure.";
d->initializeMemoryBlock();
}
d->memory->unlock();
// Random sleep here limits the probability of a collision between two racing apps
qsrand( QDateTime::currentMSecsSinceEpoch() % std::numeric_limits<uint>::max() );
QThread::sleep( 8 + static_cast <unsigned long>( static_cast <float>( qrand() ) / RAND_MAX * 10 ) );
}
if( inst->primary == false) {
d->startPrimary();
d->memory->unlock();
return;
}
// Check if another instance can be started
if( allowSecondary ) {
inst->secondary += 1;
inst->checksum = d->blockChecksum();
d->instanceNumber = inst->secondary;
d->startSecondary();
if( d->options & Mode::SecondaryNotification ) {
d->connectToPrimary( timeout, SingleApplicationPrivate::SecondaryInstance );
}
d->memory->unlock();
return;
}
d->memory->unlock();
d->connectToPrimary( timeout, SingleApplicationPrivate::NewInstance );
delete d;
::exit( EXIT_SUCCESS );
}
/**
* @brief Destructor
*/
SingleApplication::~SingleApplication()
{
Q_D(SingleApplication);
delete d;
}
bool SingleApplication::isPrimary()
{
Q_D(SingleApplication);
return d->server != nullptr;
}
bool SingleApplication::isSecondary()
{
Q_D(SingleApplication);
return d->server == nullptr;
}
quint32 SingleApplication::instanceId()
{
Q_D(SingleApplication);
return d->instanceNumber;
}
qint64 SingleApplication::primaryPid()
{
Q_D(SingleApplication);
return d->primaryPid();
}
bool SingleApplication::sendMessage( QByteArray message, int timeout )
{
Q_D(SingleApplication);
// Nobody to connect to
if( isPrimary() ) return false;
// Make sure the socket is connected
d->connectToPrimary( timeout, SingleApplicationPrivate::Reconnect );
d->socket->write( message );
bool dataWritten = d->socket->waitForBytesWritten( timeout );
d->socket->flush();
return dataWritten;
}

View File

@ -1,135 +0,0 @@
// The MIT License (MIT)
//
// Copyright (c) Itay Grudev 2015 - 2018
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#ifndef SINGLE_APPLICATION_H
#define SINGLE_APPLICATION_H
#include <QtCore/QtGlobal>
#include <QtNetwork/QLocalSocket>
#ifndef QAPPLICATION_CLASS
#define QAPPLICATION_CLASS QCoreApplication
#endif
#include QT_STRINGIFY(QAPPLICATION_CLASS)
class SingleApplicationPrivate;
/**
* @brief The SingleApplication class handles multiple instances of the same
* Application
* @see QCoreApplication
*/
class SingleApplication : public QAPPLICATION_CLASS
{
Q_OBJECT
typedef QAPPLICATION_CLASS app_t;
public:
/**
* @brief Mode of operation of SingleApplication.
* Whether the block should be user-wide or system-wide and whether the
* primary instance should be notified when a secondary instance had been
* started.
* @note Operating system can restrict the shared memory blocks to the same
* user, in which case the User/System modes will have no effect and the
* block will be user wide.
* @enum
*/
enum Mode {
User = 1 << 0,
System = 1 << 1,
SecondaryNotification = 1 << 2,
ExcludeAppVersion = 1 << 3,
ExcludeAppPath = 1 << 4
};
Q_DECLARE_FLAGS(Options, Mode)
/**
* @brief Intitializes a SingleApplication instance with argc command line
* arguments in argv
* @arg {int &} argc - Number of arguments in argv
* @arg {const char *[]} argv - Supplied command line arguments
* @arg {bool} allowSecondary - Whether to start the instance as secondary
* if there is already a primary instance.
* @arg {Mode} mode - Whether for the SingleApplication block to be applied
* User wide or System wide.
* @arg {int} timeout - Timeout to wait in milliseconds.
* @note argc and argv may be changed as Qt removes arguments that it
* recognizes
* @note Mode::SecondaryNotification only works if set on both the primary
* instance and the secondary instance.
* @note The timeout is just a hint for the maximum time of blocking
* operations. It does not guarantee that the SingleApplication
* initialisation will be completed in given time, though is a good hint.
* Usually 4*timeout would be the worst case (fail) scenario.
* @see See the corresponding QAPPLICATION_CLASS constructor for reference
*/
explicit SingleApplication(int &argc, char *argv[], const char *appName = "SingleApplication", bool allowSecondary = false, Options options = Mode::User, int timeout = 1000 );
~SingleApplication();
/**
* @brief Returns if the instance is the primary instance
* @returns {bool}
*/
bool isPrimary();
/**
* @brief Returns if the instance is a secondary instance
* @returns {bool}
*/
bool isSecondary();
/**
* @brief Returns a unique identifier for the current instance
* @returns {qint32}
*/
quint32 instanceId();
/**
* @brief Returns the process ID (PID) of the primary instance
* @returns {qint64}
*/
qint64 primaryPid();
/**
* @brief Sends a message to the primary instance. Returns true on success.
* @param {int} timeout - Timeout for connecting
* @returns {bool}
* @note sendMessage() will return false if invoked from the primary
* instance.
*/
bool sendMessage( QByteArray message, int timeout = 100 );
Q_SIGNALS:
void instanceStarted();
void receivedMessage( quint32 instanceId, QByteArray message );
private:
SingleApplicationPrivate *d_ptr;
Q_DECLARE_PRIVATE(SingleApplication)
};
Q_DECLARE_OPERATORS_FOR_FLAGS(SingleApplication::Options)
#endif // SINGLE_APPLICATION_H

View File

@ -1,19 +0,0 @@
QT += core network
CONFIG += c++11
HEADERS += $$PWD/singleapplication.h \
$$PWD/singleapplication_p.h
SOURCES += $$PWD/singleapplication.cpp \
$$PWD/singleapplication_p.cpp
INCLUDEPATH += $$PWD
win32 {
msvc:LIBS += Advapi32.lib
gcc:LIBS += -ladvapi32
}
DISTFILES += \
$$PWD/README.md \
$$PWD/CHANGELOG.md \
$$PWD/Windows.md

View File

@ -1,407 +0,0 @@
// The MIT License (MIT)
//
// Copyright (c) Itay Grudev 2015 - 2018
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// W A R N I N G !!!
// -----------------
//
// This file is not part of the SingleApplication API. It is used purely as an
// implementation detail. This header file may change from version to
// version without notice, or may even be removed.
//
#include <cstdlib>
#include <cstddef>
#include <QtCore/QDir>
#include <QtCore/QByteArray>
#include <QtCore/QDataStream>
#include <QtCore/QCryptographicHash>
#include <QtNetwork/QLocalServer>
#include <QtNetwork/QLocalSocket>
#include "singleapplication.h"
#include "singleapplication_p.h"
#ifdef Q_OS_UNIX
#include <unistd.h>
#include <sys/types.h>
#include <pwd.h>
#endif
#ifdef Q_OS_WIN
#include <windows.h>
#include <lmcons.h>
#endif
SingleApplicationPrivate::SingleApplicationPrivate( SingleApplication *q_ptr )
: q_ptr( q_ptr )
{
server = nullptr;
socket = nullptr;
memory = nullptr;
instanceNumber = -1;
}
SingleApplicationPrivate::~SingleApplicationPrivate()
{
if( socket != nullptr ) {
socket->close();
delete socket;
}
memory->lock();
InstancesInfo* inst = static_cast<InstancesInfo*>(memory->data());
if( server != nullptr ) {
server->close();
delete server;
inst->primary = false;
inst->primaryPid = -1;
inst->checksum = blockChecksum();
}
memory->unlock();
delete memory;
}
void SingleApplicationPrivate::genBlockServerName(const char* appName)
{
QCryptographicHash appData( QCryptographicHash::Sha256 );
appData.addData( appName, 17 );
appData.addData( SingleApplication::app_t::applicationName().toUtf8() );
appData.addData( SingleApplication::app_t::organizationName().toUtf8() );
appData.addData( SingleApplication::app_t::organizationDomain().toUtf8() );
if( ! (options & SingleApplication::Mode::ExcludeAppVersion) ) {
appData.addData( SingleApplication::app_t::applicationVersion().toUtf8() );
}
if( ! (options & SingleApplication::Mode::ExcludeAppPath) ) {
#ifdef Q_OS_WIN
appData.addData( SingleApplication::app_t::applicationFilePath().toLower().toUtf8() );
#else
appData.addData( SingleApplication::app_t::applicationFilePath().toUtf8() );
#endif
}
// User level block requires a user specific data in the hash
if( options & SingleApplication::Mode::User ) {
#ifdef Q_OS_WIN
wchar_t username [ UNLEN + 1 ];
// Specifies size of the buffer on input
DWORD usernameLength = UNLEN + 1;
if( GetUserNameW( username, &usernameLength ) ) {
appData.addData( QString::fromWCharArray(username).toUtf8() );
} else {
appData.addData( qgetenv("USERNAME") );
}
#endif
#ifdef Q_OS_UNIX
QByteArray username;
uid_t uid = geteuid();
struct passwd *pw = getpwuid(uid);
if( pw ) {
username = pw->pw_name;
}
if( username.isEmpty() ) {
username = qgetenv("USER");
}
appData.addData(username);
#endif
}
appData.addData(qgetenv("DISPLAY"));
// Replace the backslash in RFC 2045 Base64 [a-zA-Z0-9+/=] to comply with
// server naming requirements.
blockServerName = appData.result().toBase64().replace("/", "_");
}
void SingleApplicationPrivate::initializeMemoryBlock()
{
InstancesInfo* inst = static_cast<InstancesInfo*>( memory->data() );
inst->primary = false;
inst->secondary = 0;
inst->primaryPid = -1;
inst->checksum = blockChecksum();
}
void SingleApplicationPrivate::startPrimary()
{
Q_Q(SingleApplication);
// Successful creation means that no main process exists
// So we start a QLocalServer to listen for connections
QLocalServer::removeServer( blockServerName );
server = new QLocalServer();
// Restrict access to the socket according to the
// SingleApplication::Mode::User flag on User level or no restrictions
if( options & SingleApplication::Mode::User ) {
server->setSocketOptions( QLocalServer::UserAccessOption );
} else {
server->setSocketOptions( QLocalServer::WorldAccessOption );
}
server->listen( blockServerName );
QObject::connect(
server,
&QLocalServer::newConnection,
this,
&SingleApplicationPrivate::slotConnectionEstablished
);
// Reset the number of connections
InstancesInfo* inst = static_cast <InstancesInfo*>( memory->data() );
inst->primary = true;
inst->primaryPid = q->applicationPid();
inst->checksum = blockChecksum();
instanceNumber = 0;
}
void SingleApplicationPrivate::startSecondary()
{
}
void SingleApplicationPrivate::connectToPrimary( int msecs, ConnectionType connectionType )
{
// Connect to the Local Server of the Primary Instance if not already
// connected.
if( socket == nullptr ) {
socket = new QLocalSocket();
}
// If already connected - we are done;
if( socket->state() == QLocalSocket::ConnectedState )
return;
// If not connect
if( socket->state() == QLocalSocket::UnconnectedState ||
socket->state() == QLocalSocket::ClosingState ) {
socket->connectToServer( blockServerName );
}
// Wait for being connected
if( socket->state() == QLocalSocket::ConnectingState ) {
socket->waitForConnected( msecs );
}
// Initialisation message according to the SingleApplication protocol
if( socket->state() == QLocalSocket::ConnectedState ) {
// Notify the parent that a new instance had been started;
QByteArray initMsg;
QDataStream writeStream(&initMsg, QIODevice::WriteOnly);
#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
writeStream.setVersion(QDataStream::Qt_5_6);
#endif
writeStream << blockServerName.toLatin1();
writeStream << static_cast<quint8>(connectionType);
writeStream << instanceNumber;
quint16 checksum = qChecksum(initMsg.constData(), static_cast<quint32>(initMsg.length()));
writeStream << checksum;
// The header indicates the message length that follows
QByteArray header;
QDataStream headerStream(&header, QIODevice::WriteOnly);
#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
headerStream.setVersion(QDataStream::Qt_5_6);
#endif
headerStream << static_cast <quint64>( initMsg.length() );
socket->write( header );
socket->write( initMsg );
socket->flush();
socket->waitForBytesWritten( msecs );
}
}
quint16 SingleApplicationPrivate::blockChecksum()
{
return qChecksum(
static_cast <const char *>( memory->data() ),
offsetof( InstancesInfo, checksum )
);
}
qint64 SingleApplicationPrivate::primaryPid()
{
qint64 pid;
memory->lock();
InstancesInfo* inst = static_cast<InstancesInfo*>( memory->data() );
pid = inst->primaryPid;
memory->unlock();
return pid;
}
/**
* @brief Executed when a connection has been made to the LocalServer
*/
void SingleApplicationPrivate::slotConnectionEstablished()
{
QLocalSocket *nextConnSocket = server->nextPendingConnection();
connectionMap.insert(nextConnSocket, ConnectionInfo());
QObject::connect(nextConnSocket, &QLocalSocket::aboutToClose,
[nextConnSocket, this]() {
auto &info = connectionMap[nextConnSocket];
Q_EMIT this->slotClientConnectionClosed( nextConnSocket, info.instanceId );
}
);
QObject::connect(nextConnSocket, &QLocalSocket::disconnected,
[nextConnSocket, this]() {
connectionMap.remove(nextConnSocket);
nextConnSocket->deleteLater();
}
);
QObject::connect(nextConnSocket, &QLocalSocket::readyRead,
[nextConnSocket, this]() {
auto &info = connectionMap[nextConnSocket];
switch(info.stage) {
case StageHeader:
readInitMessageHeader(nextConnSocket);
break;
case StageBody:
readInitMessageBody(nextConnSocket);
break;
case StageConnected:
Q_EMIT this->slotDataAvailable( nextConnSocket, info.instanceId );
break;
default:
break;
};
}
);
}
void SingleApplicationPrivate::readInitMessageHeader( QLocalSocket *sock )
{
if (!connectionMap.contains( sock )) {
return;
}
if( sock->bytesAvailable() < ( qint64 )sizeof( quint64 ) ) {
return;
}
QDataStream headerStream( sock );
#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
headerStream.setVersion( QDataStream::Qt_5_6 );
#endif
// Read the header to know the message length
quint64 msgLen = 0;
headerStream >> msgLen;
ConnectionInfo &info = connectionMap[sock];
info.stage = StageBody;
info.msgLen = msgLen;
if ( sock->bytesAvailable() >= (qint64) msgLen ) {
readInitMessageBody( sock );
}
}
void SingleApplicationPrivate::readInitMessageBody( QLocalSocket *sock )
{
Q_Q(SingleApplication);
if (!connectionMap.contains( sock )) {
return;
}
ConnectionInfo &info = connectionMap[sock];
if( sock->bytesAvailable() < ( qint64 )info.msgLen ) {
return;
}
// Read the message body
QByteArray msgBytes = sock->read(info.msgLen);
QDataStream readStream(msgBytes);
#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
readStream.setVersion( QDataStream::Qt_5_6 );
#endif
// server name
QByteArray latin1Name;
readStream >> latin1Name;
// connection type
ConnectionType connectionType = InvalidConnection;
quint8 connTypeVal = InvalidConnection;
readStream >> connTypeVal;
connectionType = static_cast <ConnectionType>( connTypeVal );
// instance id
quint32 instanceId = 0;
readStream >> instanceId;
// checksum
quint16 msgChecksum = 0;
readStream >> msgChecksum;
const quint16 actualChecksum = qChecksum( msgBytes.constData(), static_cast<quint32>( msgBytes.length() - sizeof( quint16 ) ) );
bool isValid = readStream.status() == QDataStream::Ok &&
QLatin1String(latin1Name) == blockServerName &&
msgChecksum == actualChecksum;
if( !isValid ) {
sock->close();
return;
}
info.instanceId = instanceId;
info.stage = StageConnected;
if( connectionType == NewInstance ||
( connectionType == SecondaryInstance &&
options & SingleApplication::Mode::SecondaryNotification ) )
{
Q_EMIT q->instanceStarted();
}
if (sock->bytesAvailable() > 0) {
Q_EMIT this->slotDataAvailable( sock, instanceId );
}
}
void SingleApplicationPrivate::slotDataAvailable( QLocalSocket *dataSocket, quint32 instanceId )
{
Q_Q(SingleApplication);
Q_EMIT q->receivedMessage( instanceId, dataSocket->readAll() );
}
void SingleApplicationPrivate::slotClientConnectionClosed( QLocalSocket *closedSocket, quint32 instanceId )
{
if( closedSocket->bytesAvailable() > 0 )
Q_EMIT slotDataAvailable( closedSocket, instanceId );
}

View File

@ -1,99 +0,0 @@
// The MIT License (MIT)
//
// Copyright (c) Itay Grudev 2015 - 2016
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// W A R N I N G !!!
// -----------------
//
// This file is not part of the SingleApplication API. It is used purely as an
// implementation detail. This header file may change from version to
// version without notice, or may even be removed.
//
#ifndef SINGLEAPPLICATION_P_H
#define SINGLEAPPLICATION_P_H
#include <QtCore/QSharedMemory>
#include <QtNetwork/QLocalServer>
#include <QtNetwork/QLocalSocket>
#include "singleapplication.h"
struct InstancesInfo {
bool primary;
quint32 secondary;
qint64 primaryPid;
quint16 checksum;
};
struct ConnectionInfo {
explicit ConnectionInfo() :
msgLen(0), instanceId(0), stage(0) {}
qint64 msgLen;
quint32 instanceId;
quint8 stage;
};
class SingleApplicationPrivate : public QObject {
Q_OBJECT
public:
enum ConnectionType : quint8 {
InvalidConnection = 0,
NewInstance = 1,
SecondaryInstance = 2,
Reconnect = 3
};
enum ConnectionStage : quint8 {
StageHeader = 0,
StageBody = 1,
StageConnected = 2,
};
Q_DECLARE_PUBLIC(SingleApplication)
SingleApplicationPrivate( SingleApplication *q_ptr );
~SingleApplicationPrivate();
void genBlockServerName(const char *appName);
void initializeMemoryBlock();
void startPrimary();
void startSecondary();
void connectToPrimary(int msecs, ConnectionType connectionType );
quint16 blockChecksum();
qint64 primaryPid();
void readInitMessageHeader(QLocalSocket *socket);
void readInitMessageBody(QLocalSocket *socket);
SingleApplication *q_ptr;
QSharedMemory *memory;
QLocalSocket *socket;
QLocalServer *server;
quint32 instanceNumber;
QString blockServerName;
SingleApplication::Options options;
QMap<QLocalSocket*, ConnectionInfo> connectionMap;
public Q_SLOTS:
void slotConnectionEstablished();
void slotDataAvailable( QLocalSocket*, quint32 );
void slotClientConnectionClosed( QLocalSocket*, quint32 );
};
#endif // SINGLEAPPLICATION_P_H

View File

@ -0,0 +1,16 @@
cmake_minimum_required(VERSION 3.16)
project(qtsingleapplication)
find_package(QT NAMES Qt6 Qt5 COMPONENTS Core Gui Widgets Network REQUIRED)
find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Core Gui Widgets Network REQUIRED)
include_directories(src)
set(SRCS src/qtsingleapplication.h src/qtsingleapplication.cpp src/qtlocalpeer.h src/qtlocalpeer.cpp)
add_library(${PROJECT_NAME} STATIC ${SRCS})
target_include_directories(${PROJECT_NAME} PRIVATE src)
target_link_libraries(${PROJECT_NAME} PRIVATE
Qt${QT_VERSION_MAJOR}::Core
Qt${QT_VERSION_MAJOR}::Gui
Qt${QT_VERSION_MAJOR}::Widgets
Qt${QT_VERSION_MAJOR}::Network)

View File

@ -0,0 +1,254 @@
INSTALLATION INSTRUCTIONS
These instructions refer to the package you are installing as
some-package.tar.gz or some-package.zip. The .zip file is intended for use
on Windows.
The directory you choose for the installation will be referred to as
your-install-dir.
Note to Qt Visual Studio Integration users: In the instructions below,
instead of building from command line with nmake, you can use the menu
command 'Qt->Open Solution from .pro file' on the .pro files in the
example and plugin directories, and then build from within Visual
Studio.
Unpacking and installation
--------------------------
1. Unpacking the archive (if you have not done so already).
On Unix and Mac OS X (in a terminal window):
cd your-install-dir
gunzip some-package.tar.gz
tar xvf some-package.tar
This creates the subdirectory some-package containing the files.
On Windows:
Unpack the .zip archive by right-clicking it in explorer and
choosing "Extract All...". If your version of Windows does not
have zip support, you can use the infozip tools available
from www.info-zip.org.
If you are using the infozip tools (in a command prompt window):
cd your-install-dir
unzip some-package.zip
2. Configuring the package.
The configure script is called "configure" on unix/mac and
"configure.bat" on Windows. It should be run from a command line
after cd'ing to the package directory.
You can choose whether you want to use the component by including
its source code directly into your project, or build the component
as a dynamic shared library (DLL) that is loaded into the
application at run-time. The latter may be preferable for
technical or licensing (LGPL) reasons. If you want to build a DLL,
run the configure script with the argument "-library". Also see
the note about usage below.
(Components that are Qt plugins, e.g. styles and image formats,
are by default built as a plugin DLL.)
The configure script will prompt you in some cases for further
information. Answer these questions and carefully read the license text
before accepting the license conditions. The package cannot be used if
you do not accept the license conditions.
3. Building the component and examples (when required).
If a DLL is to be built, or if you would like to build the
examples, next give the commands
qmake
make [or nmake if your are using Microsoft Visual C++]
The example program(s) can be found in the directory called
"examples" or "example".
Components that are Qt plugins, e.g. styles and image formats, are
ready to be used as soon as they are built, so the rest of this
installation instruction can be skipped.
4. Building the Qt Designer plugin (optional).
Some of the widget components are provided with plugins for Qt
Designer. To build and install the plugin, cd into the
some-package/plugin directory and give the commands
qmake
make [or nmake if your are using Microsoft Visual C++]
Restart Qt Designer to make it load the new widget plugin.
Note: If you are using the built-in Qt Designer from the Qt Visual
Studio Integration, you will need to manually copy the plugin DLL
file, i.e. copy
%QTDIR%\plugins\designer\some-component.dll
to the Qt Visual Studio Integration plugin path, typically:
C:\Program Files\Trolltech\Qt VS Integration\plugins
Note: If you for some reason are using a Qt Designer that is built
in debug mode, you will need to build the plugin in debug mode
also. Edit the file plugin.pro in the plugin directory, changing
'release' to 'debug' in the CONFIG line, before running qmake.
Solutions components are intended to be used directly from the package
directory during development, so there is no 'make install' procedure.
Using a component in your project
---------------------------------
To use this component in your project, add the following line to the
project's .pro file (or do the equivalent in your IDE):
include(your-install-dir/some-package/src/some-package.pri)
This adds the package's sources and headers to the SOURCES and HEADERS
project variables respectively (or, if the component has been
configured as a DLL, it adds that library to the LIBS variable), and
updates INCLUDEPATH to contain the package's src
directory. Additionally, the .pri file may include some dependencies
needed by the package.
To include a header file from the package in your sources, you can now
simply use:
#include <SomeClass>
or alternatively, in pre-Qt 4 style:
#include <some-class.h>
Refer to the documentation to see the classes and headers this
components provides.
Install documentation (optional)
--------------------------------
The HTML documentation for the package's classes is located in the
your-install-dir/some-package/doc/html/index.html. You can open this
file and read the documentation with any web browser.
To install the documentation into Qt Assistant (for Qt version 4.4 and
later):
1. In Assistant, open the Edit->Preferences dialog and choose the
Documentation tab. Click the Add... button and select the file
your-install-dir/some-package/doc/html/some-package.qch
For Qt versions prior to 4.4, do instead the following:
1. The directory your-install-dir/some-package/doc/html contains a
file called some-package.dcf. Execute the following commands in a
shell, command prompt or terminal window:
cd your-install-dir/some-package/doc/html/
assistant -addContentFile some-package.dcf
The next time you start Qt Assistant, you can access the package's
documentation.
Removing the documentation from assistant
-----------------------------------------
If you have installed the documentation into Qt Assistant, and want to uninstall it, do as follows, for Qt version 4.4 and later:
1. In Assistant, open the Edit->Preferences dialog and choose the
Documentation tab. In the list of Registered Documentation, select
the item com.nokia.qtsolutions.some-package_version, and click
the Remove button.
For Qt versions prior to 4.4, do instead the following:
1. The directory your-install-dir/some-package/doc/html contains a
file called some-package.dcf. Execute the following commands in a
shell, command prompt or terminal window:
cd your-install-dir/some-package/doc/html/
assistant -removeContentFile some-package.dcf
Using the component as a DLL
----------------------------
1. Normal components
The shared library (DLL) is built and placed in the
some-package/lib directory. It is intended to be used directly
from there during development. When appropriate, both debug and
release versions are built, since the run-time linker will in some
cases refuse to load a debug-built DLL into a release-built
application or vice versa.
The following steps are taken by default to help the dynamic
linker to locate the DLL at run-time (during development):
Unix: The some-package.pri file will add linker instructions to
add the some-package/lib directory to the rpath of the
executable. (When distributing, or if your system does not support
rpath, you can copy the shared library to another place that is
searched by the dynamic linker, e.g. the "lib" directory of your
Qt installation.)
Mac: The full path to the library is hardcoded into the library
itself, from where it is copied into the executable at link time,
and ready by the dynamic linker at run-time. (When distributing,
you will want to edit these hardcoded paths in the same way as for
the Qt DLLs. Refer to the document "Deploying an Application on
Mac OS X" in the Qt Reference Documentation.)
Windows: the .dll file(s) are copied into the "bin" directory of
your Qt installation. The Qt installation will already have set up
that directory to be searched by the dynamic linker.
2. Plugins
For Qt Solutions plugins (e.g. image formats), both debug and
release versions of the plugin are built by default when
appropriate, since in some cases the release Qt library will not
load a debug plugin, and vice versa. The plugins are automatically
copied into the plugins directory of your Qt installation when
built, so no further setup is required.
Plugins may also be built statically, i.e. as a library that will be
linked into your application executable, and so will not need to
be redistributed as a separate plugin DLL to end users. Static
building is required if Qt itself is built statically. To do it,
just add "static" to the CONFIG variable in the plugin/plugin.pro
file before building. Refer to the "Static Plugins" section in the
chapter "How to Create Qt Plugins" for explanation of how to use a
static plugin in your application. The source code of the example
program(s) will also typically contain the relevant instructions
as comments.
Uninstalling
------------
The following command will remove any fils that have been
automatically placed outside the package directory itself during
installation and building
make distclean [or nmake if your are using Microsoft Visual C++]
If Qt Assistant documentation or Qt Designer plugins have been
installed, they can be uninstalled manually, ref. above.
Enjoy! :)
- The Qt Solutions Team.

View File

@ -0,0 +1,33 @@
Qt Solutions Component: Single Application
The QtSingleApplication component provides support for
applications that can be only started once per user.
Version history:
2.0: - Version 1.3 ported to Qt 4.
2.1: - Fix compilation problem on Mac.
2.2: - Really fix the Mac compilation problem.
- Mac: fix crash due to wrong object releasing.
- Mac: Fix memory leak.
2.3: - Windows: Force creation of internal widget to make it work
with Qt 4.2.
2.4: - Fix the system for automatic window raising on message
reception. NOTE: minor API change.
2.5: - Mac: Fix isRunning() to work and report correctly.
2.6: - - initialize() is now obsolete, no longer necessary to call
it
- - Fixed race condition where multiple instances migth be started
- - QtSingleCoreApplication variant provided for non-GUI (console)
usage
- Complete reimplementation. Visible changes:
- LGPL release.

View File

@ -0,0 +1,13 @@
TEMPLATE=lib
CONFIG += qt dll qtsingleapplication-buildlib
mac:CONFIG += absolute_library_soname
win32|mac:!wince*:!win32-msvc:!macx-xcode:CONFIG += debug_and_release build_all
include(../src/qtsingleapplication.pri)
TARGET = $$QTSINGLEAPPLICATION_LIBNAME
DESTDIR = $$QTSINGLEAPPLICATION_LIBDIR
win32 {
DLLDESTDIR = $$[QT_INSTALL_BINS]
QMAKE_DISTCLEAN += $$[QT_INSTALL_BINS]\\$${QTSINGLEAPPLICATION_LIBNAME}.dll
}
target.path = $$DESTDIR
INSTALLS += target

View File

@ -0,0 +1,14 @@
exists(config.pri):infile(config.pri, SOLUTIONS_LIBRARY, yes): CONFIG += qtsingleapplication-uselib
TEMPLATE += fakelib
greaterThan(QT_MAJOR_VERSION, 5)|\
if(equals(QT_MAJOR_VERSION, 5):greaterThan(QT_MINOR_VERSION, 4))|\
if(equals(QT_MAJOR_VERSION, 5):equals(QT_MINOR_VERSION, 4):greaterThan(QT_PATCH_VERSION, 1)) {
QTSINGLEAPPLICATION_LIBNAME = $$qt5LibraryTarget(QtSolutions_SingleApplication-head)
} else {
QTSINGLEAPPLICATION_LIBNAME = $$qtLibraryTarget(QtSolutions_SingleApplication-head)
}
TEMPLATE -= fakelib
QTSINGLEAPPLICATION_LIBDIR = $$PWD/lib
unix:qtsingleapplication-uselib:!qtsingleapplication-buildlib:QMAKE_RPATHDIR += $$QTSINGLEAPPLICATION_LIBDIR

25
3rd-parties/qtsingleapplication/configure vendored Executable file
View File

@ -0,0 +1,25 @@
#!/bin/sh
if [ "x$1" != "x" -a "x$1" != "x-library" ]; then
echo "Usage: $0 [-library]"
echo
echo "-library: Build the component as a dynamic library (DLL). Default is to"
echo " include the component source code directly in the application."
echo
exit 0
fi
rm -f config.pri
if [ "x$1" = "x-library" ]; then
echo "Configuring to build this component as a dynamic library."
echo "SOLUTIONS_LIBRARY = yes" > config.pri
fi
echo
echo "This component is now configured."
echo
echo "To build the component library (if requested) and example(s),"
echo "run qmake and your make command."
echo
echo "To remove or reconfigure, run make distclean."
echo

View File

@ -0,0 +1,43 @@
:: Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
:: SPDX-License-Identifier: BSD-3-Clause
@echo off
rem
rem "Main"
rem
if not "%1"=="" (
if not "%1"=="-library" (
call :PrintUsage
goto EOF
)
)
if exist config.pri. del config.pri
if "%1"=="-library" (
echo Configuring to build this component as a dynamic library.
echo SOLUTIONS_LIBRARY = yes > config.pri
)
echo .
echo This component is now configured.
echo .
echo To build the component library (if requested) and example(s),
echo run qmake and your make or nmake command.
echo .
echo To remove or reconfigure, run make (nmake) distclean.
echo .
goto EOF
:PrintUsage
echo Usage: configure.bat [-library]
echo .
echo -library: Build the component as a dynamic library (DLL). Default is to
echo include the component source directly in the application.
echo A DLL may be preferable for technical or licensing (LGPL) reasons.
echo .
goto EOF
:EOF

View File

@ -0,0 +1,284 @@
BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
font-family: Arial, Geneva, Helvetica, sans-serif;
}
H1 {
text-align: center;
font-size: 160%;
}
H2 {
font-size: 120%;
}
H3 {
font-size: 100%;
}
h3.fn,span.fn
{
background-color: #eee;
border-width: 1px;
border-style: solid;
border-color: #ddd;
font-weight: bold;
padding: 6px 0px 6px 10px;
margin: 42px 0px 0px 0px;
}
hr {
border: 0;
color: #a0a0a0;
background-color: #ccc;
height: 1px;
width: 100%;
text-align: left;
margin: 34px 0px 34px 0px;
}
table.valuelist {
border-width: 1px 1px 1px 1px;
border-style: solid;
border-color: #dddddd;
border-collapse: collapse;
background-color: #f0f0f0;
}
table.indextable {
border-width: 1px 1px 1px 1px;
border-style: solid;
border-collapse: collapse;
background-color: #f0f0f0;
border-color:#555;
font-size: 100%;
}
table td.largeindex {
border-width: 1px 1px 1px 1px;
border-collapse: collapse;
background-color: #f0f0f0;
border-color:#555;
font-size: 120%;
}
table.valuelist th {
border-width: 1px 1px 1px 2px;
padding: 4px;
border-style: solid;
border-color: #666;
color:white;
background-color:#666;
}
th.titleheader {
border-width: 1px 0px 1px 0px;
padding: 2px;
border-style: solid;
border-color: #666;
color:white;
background-color:#555;
background-image:url('images/gradient.png')};
background-repeat: repeat-x;
font-size: 100%;
}
th.largeheader {
border-width: 1px 0px 1px 0px;
padding: 4px;
border-style: solid;
border-color: #444;
color:white;
background-color:#555555;
font-size: 120%;
}
p {
margin-left: 4px;
margin-top: 8px;
margin-bottom: 8px;
}
a:link
{
color: #0046ad;
text-decoration: none
}
a:visited
{
color: #672967;
text-decoration: none
}
a.obsolete
{
color: #661100;
text-decoration: none
}
a.compat
{
color: #661100;
text-decoration: none
}
a.obsolete:visited
{
color: #995500;
text-decoration: none
}
a.compat:visited
{
color: #995500;
text-decoration: none
}
body
{
background: #ffffff;
color: black
}
table.generic, table.annotated
{
border-width: 1px;
border-color:#bbb;
border-style:solid;
border-collapse:collapse;
}
table td.memItemLeft {
width: 180px;
padding: 2px 0px 0px 8px;
margin: 4px;
border-width: 1px;
border-color: #E0E0E0;
border-style: none;
font-size: 100%;
white-space: nowrap
}
table td.memItemRight {
padding: 2px 8px 0px 8px;
margin: 4px;
border-width: 1px;
border-color: #E0E0E0;
border-style: none;
font-size: 100%;
}
table tr.odd {
background: #f0f0f0;
color: black;
}
table tr.even {
background: #e4e4e4;
color: black;
}
table.annotated th {
padding: 3px;
text-align: left
}
table.annotated td {
padding: 3px;
}
table tr pre
{
padding-top: 0px;
padding-bottom: 0px;
padding-left: 0px;
padding-right: 0px;
border: none;
background: none
}
tr.qt-style
{
background: #96E066;
color: black
}
body pre
{
padding: 0.2em;
border: #e7e7e7 1px solid;
background: #f1f1f1;
color: black
}
table tr.qt-code pre
{
padding: 0.2em;
border: #e7e7e7 1px solid;
background: #f1f1f1;
color: black
}
span.preprocessor, span.preprocessor a
{
color: darkblue;
}
span.comment
{
color: darkred;
font-style: italic
}
span.string,span.char
{
color: darkgreen;
}
.title
{
text-align: center
}
.subtitle
{
font-size: 0.8em
}
.small-subtitle
{
font-size: 0.65em
}
.qmlitem {
padding: 0;
}
.qmlname {
white-space: nowrap;
}
.qmltype {
text-align: center;
font-size: 160%;
}
.qmlproto {
background-color: #eee;
border-width: 1px;
border-style: solid;
border-color: #ddd;
font-weight: bold;
padding: 6px 10px 6px 10px;
margin: 42px 0px 0px 0px;
}
.qmlreadonly {
float: right;
color: red
}
.qmldoc {
}
*.qmlitem p {
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB

View File

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- index.qdoc -->
<head>
<title>Single Application</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">Single Application<br /><span class="subtitle"></span>
</h1>
<a name="description"></a>
<h2>Description</h2>
<p>The <a href="qtsingleapplication.html">QtSingleApplication</a> component provides support for applications that can be only started once per user.</p>
<p>For some applications it is useful or even critical that they are started only once by any user. Future attempts to start the application should activate any already running instance, and possibly perform requested actions, e.g&#x2e; loading a file, in that instance.</p>
<p>The <a href="qtsingleapplication.html">QtSingleApplication</a> class provides an interface to detect a running instance, and to send command strings to that instance. For console (non-GUI) applications, the <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a> variant is provided, which avoids dependency on <a href="http://qt.nokia.com/doc/4.6/qtgui.html">QtGui</a>.</p>
<a name="classes"></a>
<h2>Classes</h2>
<ul>
<li><a href="qtsingleapplication.html">QtSingleApplication</a></li>
<li><a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a></li>
</ul>
<a name="examples"></a>
<h2>Examples</h2>
<ul>
<li><a href="qtsingleapplication-example-trivial.html">A Trivial Example</a></li>
<li><a href="qtsingleapplication-example-loader.html">Loading Documents</a></li>
<li><a href="qtsinglecoreapplication-example-console.html">A Non-GUI Example</a></li>
</ul>
<a name="tested-platforms"></a>
<h2>Tested platforms</h2>
<ul>
<li>Qt 4.4, 4.5 / Windows XP / MSVC.NET 2005</li>
<li>Qt 4.4, 4.5 / Linux / gcc</li>
<li>Qt 4.4, 4.5 / MacOS X 10.5 / gcc</li>
</ul>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,177 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- loader.qdoc -->
<head>
<title>Loading Documents</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">Loading Documents<br /><span class="subtitle"></span>
</h1>
<p>The application in this example loads or prints the documents passed as commandline parameters to further instances of this application.</p>
<pre><span class="comment"> /****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** You may use this file under the terms of the BSD license as follows:
**
** &quot;Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
** the names of its contributors may be used to endorse or promote
** products derived from this software without specific prior written
** permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.&quot;
**
****************************************************************************/</span>
#include &lt;qtsingleapplication.h&gt;
#include &lt;QtCore/QFile&gt;
#include &lt;QtGui/QMainWindow&gt;
#include &lt;QtGui/QPrinter&gt;
#include &lt;QtGui/QPainter&gt;
#include &lt;QtGui/QTextEdit&gt;
#include &lt;QtGui/QMdiArea&gt;
#include &lt;QtCore/QTextStream&gt;
class MainWindow : public QMainWindow
{
Q_OBJECT
public:
MainWindow();
public slots:
void handleMessage(const QString&amp; message);
signals:
void needToShow();
private:
QMdiArea *workspace;
};</pre>
<p>The user interface in this application is a <a href="http://qt.nokia.com/doc/4.6/qmainwindow.html">QMainWindow</a> subclass with a <a href="http://qt.nokia.com/doc/4.6/qmdiarea.html">QMdiArea</a> as the central widget. It implements a slot <tt>handleMessage()</tt> that will be connected to the messageReceived() signal of the <a href="qtsingleapplication.html">QtSingleApplication</a> class.</p>
<pre> MainWindow::MainWindow()
{
workspace = new QMdiArea(this);
setCentralWidget(workspace);
}</pre>
<p>The <a href="http://qt.nokia.com/doc/4.6/designer-to-know.html">MainWindow</a> constructor creates a minimal user interface.</p>
<pre> void MainWindow::handleMessage(const QString&amp; message)
{
enum Action {
Nothing,
Open,
Print
} action;
action = Nothing;
QString filename = message;
if (message.toLower().startsWith(&quot;/print &quot;)) {
filename = filename.mid(7);
action = Print;
} else if (!message.isEmpty()) {
action = Open;
}
if (action == Nothing) {
emit needToShow();
return;
}
QFile file(filename);
QString contents;
if (file.open(QIODevice::ReadOnly))
contents = file.readAll();
else
contents = &quot;[[Error: Could not load file &quot; + filename + &quot;]]&quot;;
QTextEdit *view = new QTextEdit;
view-&gt;setPlainText(contents);
switch(action) {</pre>
<p>The handleMessage() slot interprets the message passed in as a filename that can be prepended with <i>/print</i> to indicate that the file should just be printed rather than loaded.</p>
<pre> case Print:
{
QPrinter printer;
view-&gt;print(&amp;printer);
delete view;
}
break;
case Open:
{
workspace-&gt;addSubWindow(view);
view-&gt;setWindowTitle(message);
view-&gt;show();
emit needToShow();
}
break;
default:
break;
};
}</pre>
<p>Loading the file will also activate the window.</p>
<pre> #include &quot;main.moc&quot;
int main(int argc, char **argv)
{
QtSingleApplication instance(&quot;File loader QtSingleApplication example&quot;, argc, argv);
QString message;
for (int a = 1; a &lt; argc; ++a) {
message += argv[a];
if (a &lt; argc-1)
message += &quot; &quot;;
}
if (instance.sendMessage(message))
return 0;</pre>
<p>The <tt>main</tt> entry point function creates a <a href="qtsingleapplication.html">QtSingleApplication</a> object, and creates a message to send to a running instance of the application. If the message was sent successfully the process exits immediately.</p>
<pre> MainWindow mw;
mw.handleMessage(message);
mw.show();
QObject::connect(&amp;instance, SIGNAL(messageReceived(const QString&amp;)),
&amp;mw, SLOT(handleMessage(const QString&amp;)));
instance.setActivationWindow(&amp;mw, false);
QObject::connect(&amp;mw, SIGNAL(needToShow()), &amp;instance, SLOT(activateWindow()));
return instance.exec();
}</pre>
<p>If the message could not be sent the application starts up. Note that <tt>false</tt> is passed to the call to setActivationWindow() to prevent automatic activation for every message received, e.g&#x2e; when
the application should just print a file. Instead, the message handling function determines whether activation is requested, and signals that by emitting the needToShow() signal. This is then simply connected
directly to <a href="qtsingleapplication.html">QtSingleApplication</a>'s activateWindow() slot.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,101 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- trivial.qdoc -->
<head>
<title>A Trivial Example</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">A Trivial Example<br /><span class="subtitle"></span>
</h1>
<p>The application in this example has a log-view that displays messages sent by further instances of the same application.</p>
<p>The example demonstrates the use of the <a href="qtsingleapplication.html">QtSingleApplication</a> class to detect and communicate with a running instance of the application using the sendMessage() API. The messageReceived() signal is used to display received messages in a <a href="http://qt.nokia.com/doc/4.6/qtextedit.html">QTextEdit</a> log.</p>
<pre><span class="comment"> /****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** You may use this file under the terms of the BSD license as follows:
**
** &quot;Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
** the names of its contributors may be used to endorse or promote
** products derived from this software without specific prior written
** permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.&quot;
**
****************************************************************************/</span>
#include &lt;qtsingleapplication.h&gt;
#include &lt;QtGui/QTextEdit&gt;
class TextEdit : public QTextEdit
{
Q_OBJECT
public:
TextEdit(QWidget *parent = 0)
: QTextEdit(parent)
{}
public slots:
void append(const QString &amp;str)
{
QTextEdit::append(str);
}
};
#include &quot;main.moc&quot;
int main(int argc, char **argv)
{
QtSingleApplication instance(argc, argv);</pre>
<p>The example has only the <tt>main</tt> entry point function. A <a href="qtsingleapplication.html">QtSingleApplication</a> object is created immediately.</p>
<pre> if (instance.sendMessage(&quot;Wake up!&quot;))
return 0;</pre>
<p>If another instance of this application is already running, sendMessage() will succeed, and this instance just exits immediately.</p>
<pre> TextEdit logview;
logview.setReadOnly(true);
logview.show();</pre>
<p>Otherwise the instance continues as normal and creates the user interface.</p>
<pre> instance.setActivationWindow(&amp;logview);
QObject::connect(&amp;instance, SIGNAL(messageReceived(const QString&amp;)),
&amp;logview, SLOT(append(const QString&amp;)));
return instance.exec();</pre>
<p>The <tt>logview</tt> object is also set as the application's activation window. Every time a message is received, the window will be raised and activated automatically.</p>
<p>The messageReceived() signal is also connected to the <a href="http://qt.nokia.com/doc/4.6/qtextedit.html">QTextEdit</a>'s append() slot. Every message received from further instances of this application will be displayed in the log.</p>
<p>Finally the event loop is entered.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,235 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qtsingleapplication.cpp -->
<head>
<title>List of All Members for QtSingleApplication</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">List of All Members for QtSingleApplication</h1>
<p>This is the complete list of members for <a href="qtsingleapplication.html">QtSingleApplication</a>, including inherited members.</p>
<p><table class="propsummary" width="100%" border="0" cellpadding="0" cellspacing="0">
<tr><td width="45%" valign="top"><ul>
<li><div class="fn">enum <b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#ColorSpec-enum">ColorSpec</a></b></div></li>
<li><div class="fn">enum <b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#Encoding-enum">Encoding</a></b></div></li>
<li><div class="fn">typedef <b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#EventFilter-typedef">EventFilter</a></b></div></li>
<li><div class="fn">typedef <b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#QS60MainApplicationFactory-typedef">QS60MainApplicationFactory</a></b></div></li>
<li><div class="fn">enum <b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#Type-enum">Type</a></b></div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#QtSingleApplication">QtSingleApplication</a></b> ( int &amp;, char **, bool )</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#QtSingleApplication-2">QtSingleApplication</a></b> ( const QString &amp;, int &amp;, char ** )</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#QtSingleApplication-3">QtSingleApplication</a></b> ( int &amp;, char **, Type )</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#QtSingleApplication-4">QtSingleApplication</a></b> ( Display *, Qt::HANDLE, Qt::HANDLE )</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#QtSingleApplication-5">QtSingleApplication</a></b> ( Display *, int &amp;, char **, Qt::HANDLE, Qt::HANDLE )</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#QtSingleApplication-6">QtSingleApplication</a></b> ( Display *, const QString &amp;, int, char **, Qt::HANDLE, Qt::HANDLE )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#aboutQt">aboutQt</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#aboutToQuit">aboutToQuit</a></b> ()</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#activateWindow">activateWindow</a></b> ()</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#activationWindow">activationWindow</a></b> () const : QWidget *</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#activeModalWidget">activeModalWidget</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#activePopupWidget">activePopupWidget</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#activeWindow">activeWindow</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#addLibraryPath">addLibraryPath</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#alert">alert</a></b> ( QWidget *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#allWidgets">allWidgets</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationDirPath">applicationDirPath</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationFilePath">applicationFilePath</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationName-prop">applicationName</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationPid">applicationPid</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationVersion-prop">applicationVersion</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#arguments">arguments</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#autoMaximizeThreshold-prop">autoMaximizeThreshold</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#autoSipEnabled-prop">autoSipEnabled</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#beep">beep</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#blockSignals">blockSignals</a></b> ( bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#changeOverrideCursor">changeOverrideCursor</a></b> ( const QCursor &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#childEvent">childEvent</a></b> ( QChildEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#children">children</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#clipboard">clipboard</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#closeAllWindows">closeAllWindows</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#closingDown">closingDown</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#colorSpec">colorSpec</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#commitData">commitData</a></b> ( QSessionManager &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#commitDataRequest">commitDataRequest</a></b> ( QSessionManager &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#connect">connect</a></b> ( const QObject *, const char *, const QObject *, const char *, Qt::ConnectionType )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#connect-2">connect</a></b> ( const QObject *, const char *, const char *, Qt::ConnectionType ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#connectNotify">connectNotify</a></b> ( const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#cursorFlashTime-prop">cursorFlashTime</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#customEvent">customEvent</a></b> ( QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#d_ptr-var">d_ptr</a></b> : </div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#deleteLater">deleteLater</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#desktop">desktop</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#desktopSettingsAware">desktopSettingsAware</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#destroyed">destroyed</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnect">disconnect</a></b> ( const QObject *, const char *, const QObject *, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnect-2">disconnect</a></b> ( const char *, const QObject *, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnect-3">disconnect</a></b> ( const QObject *, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnectNotify">disconnectNotify</a></b> ( const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#doubleClickInterval-prop">doubleClickInterval</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#dumpObjectInfo">dumpObjectInfo</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#dumpObjectTree">dumpObjectTree</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#dynamicPropertyNames">dynamicPropertyNames</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#event">event</a></b> ( QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#eventFilter">eventFilter</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#exec">exec</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#exit">exit</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#filterEvent">filterEvent</a></b> ( void *, long * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#findChild">findChild</a></b> ( const QString &amp; ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#findChildren">findChildren</a></b> ( const QString &amp; ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#findChildren-2">findChildren</a></b> ( const QRegExp &amp; ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#flush">flush</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#focusChanged">focusChanged</a></b> ( QWidget *, QWidget * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#focusWidget">focusWidget</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#font">font</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#font-2">font</a></b> ( const QWidget * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#font-3">font</a></b> ( const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#fontDatabaseChanged">fontDatabaseChanged</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#fontMetrics">fontMetrics</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#globalStrut-prop">globalStrut</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#hasPendingEvents">hasPendingEvents</a></b> ()</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#id">id</a></b> () const : QString</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#inherits">inherits</a></b> ( const char * ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#inputContext">inputContext</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#installEventFilter">installEventFilter</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#installTranslator">installTranslator</a></b> ( QTranslator * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#instance">instance</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#isEffectEnabled">isEffectEnabled</a></b> ( Qt::UIEffect )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#isLeftToRight">isLeftToRight</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#isRightToLeft">isRightToLeft</a></b> ()</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#isRunning">isRunning</a></b> () : bool</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#isSessionRestored">isSessionRestored</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#isWidgetType">isWidgetType</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#keyboardInputDirection">keyboardInputDirection</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#keyboardInputInterval-prop">keyboardInputInterval</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#keyboardInputLocale">keyboardInputLocale</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#keyboardModifiers">keyboardModifiers</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#keypadNavigationEnabled">keypadNavigationEnabled</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#killTimer">killTimer</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#lastWindowClosed">lastWindowClosed</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#layoutDirection-prop">layoutDirection</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#libraryPaths">libraryPaths</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#macEventFilter">macEventFilter</a></b> ( EventHandlerCallRef, EventRef )</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#messageReceived">messageReceived</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#metaObject">metaObject</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#mouseButtons">mouseButtons</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#moveToThread">moveToThread</a></b> ( QThread * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#navigationMode">navigationMode</a></b> ()</div></li>
</ul></td><td valign="top"><ul>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#notify">notify</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#objectName-prop">objectName</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationDomain-prop">organizationDomain</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationName-prop">organizationName</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#overrideCursor">overrideCursor</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#palette">palette</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#palette-2">palette</a></b> ( const QWidget * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#palette-3">palette</a></b> ( const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#parent">parent</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#postEvent">postEvent</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#postEvent-2">postEvent</a></b> ( QObject *, QEvent *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#processEvents">processEvents</a></b> ( QFlags&lt;QEventLoop::ProcessEventsFlag&gt; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#processEvents-2">processEvents</a></b> ( QFlags&lt;QEventLoop::ProcessEventsFlag&gt;, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#property">property</a></b> ( const char * ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#quit">quit</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#quitOnLastWindowClosed-prop">quitOnLastWindowClosed</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#qwsDecoration">qwsDecoration</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#qwsEventFilter">qwsEventFilter</a></b> ( QWSEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#qwsSetCustomColors">qwsSetCustomColors</a></b> ( QRgb *, int, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#qwsSetDecoration">qwsSetDecoration</a></b> ( QDecoration * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#qwsSetDecoration-2">qwsSetDecoration</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#receivers">receivers</a></b> ( const char * ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#removeEventFilter">removeEventFilter</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removeLibraryPath">removeLibraryPath</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removePostedEvents">removePostedEvents</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removePostedEvents-2">removePostedEvents</a></b> ( QObject *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removeTranslator">removeTranslator</a></b> ( QTranslator * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#restoreOverrideCursor">restoreOverrideCursor</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#saveState">saveState</a></b> ( QSessionManager &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#saveStateRequest">saveStateRequest</a></b> ( QSessionManager &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#sendEvent">sendEvent</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#sendMessage">sendMessage</a></b> ( const QString &amp;, int ) : bool</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#sendPostedEvents">sendPostedEvents</a></b> ( QObject *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#sendPostedEvents-2">sendPostedEvents</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#sender">sender</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#sessionId">sessionId</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#sessionKey">sessionKey</a></b> () const</div></li>
<li><div class="fn"><b><a href="qtsingleapplication.html#setActivationWindow">setActivationWindow</a></b> ( QWidget *, bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setActiveWindow">setActiveWindow</a></b> ( QWidget * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationName-prop">setApplicationName</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationVersion-prop">setApplicationVersion</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#setAttribute">setAttribute</a></b> ( Qt::ApplicationAttribute, bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#autoMaximizeThreshold-prop">setAutoMaximizeThreshold</a></b> ( const int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#autoSipEnabled-prop">setAutoSipEnabled</a></b> ( const bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setColorSpec">setColorSpec</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#cursorFlashTime-prop">setCursorFlashTime</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setDesktopSettingsAware">setDesktopSettingsAware</a></b> ( bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#doubleClickInterval-prop">setDoubleClickInterval</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setEffectEnabled">setEffectEnabled</a></b> ( Qt::UIEffect, bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#setEventFilter">setEventFilter</a></b> ( EventFilter )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setFont">setFont</a></b> ( const QFont &amp;, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#globalStrut-prop">setGlobalStrut</a></b> ( const QSize &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setGraphicsSystem">setGraphicsSystem</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setInputContext">setInputContext</a></b> ( QInputContext * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#keyboardInputInterval-prop">setKeyboardInputInterval</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#layoutDirection-prop">setLayoutDirection</a></b> ( Qt::LayoutDirection )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#setLibraryPaths">setLibraryPaths</a></b> ( const QStringList &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setNavigationMode">setNavigationMode</a></b> ( Qt::NavigationMode )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#objectName-prop">setObjectName</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationDomain-prop">setOrganizationDomain</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationName-prop">setOrganizationName</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setOverrideCursor">setOverrideCursor</a></b> ( const QCursor &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setPalette">setPalette</a></b> ( const QPalette &amp;, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#setParent">setParent</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#setProperty">setProperty</a></b> ( const char *, const QVariant &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#quitOnLastWindowClosed-prop">setQuitOnLastWindowClosed</a></b> ( bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#startDragDistance-prop">setStartDragDistance</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#startDragTime-prop">setStartDragTime</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setStyle">setStyle</a></b> ( QStyle * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#setStyle-2">setStyle</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#styleSheet-prop">setStyleSheet</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#wheelScrollLines-prop">setWheelScrollLines</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#windowIcon-prop">setWindowIcon</a></b> ( const QIcon &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#signalsBlocked">signalsBlocked</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#startDragDistance-prop">startDragDistance</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#startDragTime-prop">startDragTime</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#startTimer">startTimer</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#startingUp">startingUp</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#staticMetaObject-var">staticMetaObject</a></b> : </div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#staticQtMetaObject-var">staticQtMetaObject</a></b> : </div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#style">style</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#styleSheet-prop">styleSheet</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#symbianEventFilter">symbianEventFilter</a></b> ( const QSymbianEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#symbianProcessEvent">symbianProcessEvent</a></b> ( const QSymbianEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#syncX">syncX</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#testAttribute">testAttribute</a></b> ( Qt::ApplicationAttribute )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#thread">thread</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#timerEvent">timerEvent</a></b> ( QTimerEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#topLevelAt">topLevelAt</a></b> ( const QPoint &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#topLevelAt-2">topLevelAt</a></b> ( int, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#topLevelWidgets">topLevelWidgets</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#tr">tr</a></b> ( const char *, const char *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#trUtf8">trUtf8</a></b> ( const char *, const char *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#translate">translate</a></b> ( const char *, const char *, const char *, Encoding, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#translate-2">translate</a></b> ( const char *, const char *, const char *, Encoding )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#type">type</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#wheelScrollLines-prop">wheelScrollLines</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#widgetAt">widgetAt</a></b> ( const QPoint &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#widgetAt-4">widgetAt</a></b> ( int, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#winEventFilter">winEventFilter</a></b> ( MSG *, long * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#windowIcon-prop">windowIcon</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#x11EventFilter">x11EventFilter</a></b> ( XEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qapplication.html#x11ProcessEvent">x11ProcessEvent</a></b> ( XEvent * )</div></li>
</ul>
</td></tr>
</table></p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qtsingleapplication.cpp -->
<head>
<title>Obsolete Members for QtSingleApplication</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">Obsolete Members for QtSingleApplication</h1>
<p><b>The following class members are obsolete.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p>
<p><ul><li><a href="qtsingleapplication.html">QtSingleApplication class reference</a></li></ul></p>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication-obsolete.html#initialize">initialize</a></b> ( bool <i>dummy</i> = true )&nbsp;&nbsp;<tt> (obsolete)</tt></td></tr>
</table>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="initialize"></a>void QtSingleApplication::initialize ( bool <i>dummy</i> = true )</h3>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,40 @@
<!DOCTYPE DCF>
<DCF ref="index.html" icon="qtsingleapplication.png" imagedir="../../gif" title="Qt Solutions: Single Application Documentation">
<section ref="classes.html" title="Classes">
<section ref="qtsingleapplication.html" title="QtSingleApplication Class Reference">
<keyword ref="qtsingleapplication.html">QtSingleApplication</keyword>
<keyword ref="qtsingleapplication.html#activateWindow">activateWindow</keyword>
<keyword ref="qtsingleapplication.html#activationWindow">activationWindow</keyword>
<keyword ref="qtsingleapplication.html#id">id</keyword>
<keyword ref="qtsingleapplication.html#isRunning">isRunning</keyword>
<keyword ref="qtsingleapplication.html#messageReceived">messageReceived</keyword>
<keyword ref="qtsingleapplication.html#sendMessage">sendMessage</keyword>
<keyword ref="qtsingleapplication.html#setActivationWindow">setActivationWindow</keyword>
<section ref="qtsingleapplication-members.html" title="List of all members"/>
<section ref="qtsingleapplication-obsolete.html" title="Obsolete members"/>
</section>
<section ref="qtsinglecoreapplication.html" title="QtSingleCoreApplication Class Reference">
<keyword ref="qtsinglecoreapplication.html">QtSingleCoreApplication</keyword>
<keyword ref="qtsinglecoreapplication.html#id">id</keyword>
<keyword ref="qtsinglecoreapplication.html#isRunning">isRunning</keyword>
<keyword ref="qtsinglecoreapplication.html#messageReceived">messageReceived</keyword>
<keyword ref="qtsinglecoreapplication.html#sendMessage">sendMessage</keyword>
<section ref="qtsinglecoreapplication-members.html" title="List of all members"/>
</section>
</section>
<section ref="overviews.html" title="Overviews">
<section ref="qtsinglecoreapplication-example-console.html" title="A non-GUI example">
<keyword ref="qtsinglecoreapplication-example-console.html">A non-GUI example</keyword>
</section>
<section ref="qtsingleapplication-example-trivial.html" title="A Trivial Example">
<keyword ref="qtsingleapplication-example-trivial.html">A Trivial Example</keyword>
</section>
<section ref="qtsingleapplication-example-loader.html" title="Loading Documents">
<keyword ref="qtsingleapplication-example-loader.html">Loading Documents</keyword>
</section>
<section ref="index.html" title="Single Application">
<keyword ref="index.html">Single Application</keyword>
</section>
</section>
<section ref="examples.html" title="Tutorial &amp; Examples"/>
</DCF>

View File

@ -0,0 +1,174 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qtsingleapplication.cpp -->
<head>
<title>QtSingleApplication Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">QtSingleApplication Class Reference</h1>
<p>The QtSingleApplication class provides an API to detect and communicate with running instances of an application. <a href="#details">More...</a></p>
<pre> #include &lt;QtSingleApplication&gt;</pre><p>Inherits <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a>.</p>
<ul>
<li><a href="qtsingleapplication-members.html">List of all members, including inherited members</a></li>
<li><a href="qtsingleapplication-obsolete.html">Obsolete members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#QtSingleApplication">QtSingleApplication</a></b> ( int &amp; <i>argc</i>, char ** <i>argv</i>, bool <i>GUIenabled</i> = true )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#QtSingleApplication-2">QtSingleApplication</a></b> ( const QString &amp; <i>appId</i>, int &amp; <i>argc</i>, char ** <i>argv</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#QtSingleApplication-3">QtSingleApplication</a></b> ( int &amp; <i>argc</i>, char ** <i>argv</i>, Type <i>type</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#QtSingleApplication-4">QtSingleApplication</a></b> ( Display * <i>dpy</i>, Qt::HANDLE <i>visual</i> = 0, Qt::HANDLE <i>cmap</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#QtSingleApplication-5">QtSingleApplication</a></b> ( Display * <i>dpy</i>, int &amp; <i>argc</i>, char ** <i>argv</i>, Qt::HANDLE <i>visual</i> = 0, Qt::HANDLE <i>cmap</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#QtSingleApplication-6">QtSingleApplication</a></b> ( Display * <i>dpy</i>, const QString &amp; <i>appId</i>, int <i>argc</i>, char ** <i>argv</i>, Qt::HANDLE <i>visual</i> = 0, Qt::HANDLE <i>cmap</i> = 0 )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QWidget * </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#activationWindow">activationWindow</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#id">id</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#isRunning">isRunning</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#setActivationWindow">setActivationWindow</a></b> ( QWidget * <i>aw</i>, bool <i>activateOnMessage</i> = true )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>16 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qapplication.html#public-functions">QApplication</a></li>
<li><div bar="2" class="fn"></div>4 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#public-functions">QCoreApplication</a></li>
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-functions">QObject</a></li>
</ul>
<hr />
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#activateWindow">activateWindow</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#sendMessage">sendMessage</a></b> ( const QString &amp; <i>message</i>, int <i>timeout</i> = 5000 )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>7 public slots inherited from <a href="http://qt.nokia.com/doc/4.6/qapplication.html#public-slots">QApplication</a></li>
<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#public-slots">QCoreApplication</a></li>
<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-slots">QObject</a></li>
</ul>
<hr />
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qtsingleapplication.html#messageReceived">messageReceived</a></b> ( const QString &amp; <i>message</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>5 signals inherited from <a href="http://qt.nokia.com/doc/4.6/qapplication.html#signals">QApplication</a></li>
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#signals">QCoreApplication</a></li>
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>13 properties inherited from <a href="http://qt.nokia.com/doc/4.6/qapplication.html#properties">QApplication</a></li>
<li><div class="fn"></div>4 properties inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#properties">QCoreApplication</a></li>
<li><div class="fn"></div>1 property inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>73 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qapplication.html#static-public-members">QApplication</a></li>
<li><div class="fn"></div>38 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#static-public-members">QCoreApplication</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>1 protected function inherited from <a href="http://qt.nokia.com/doc/4.6/qapplication.html#protected-functions">QApplication</a></li>
<li><div class="fn"></div>1 protected function inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#protected-functions">QCoreApplication</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QtSingleApplication class provides an API to detect and communicate with running instances of an application.</p>
<p>This class allows you to create applications where only one instance should be running at a time. I.e&#x2e;, if the user tries to launch another instance, the already running instance will be activated
instead. Another usecase is a client-server system, where the first started instance will assume the role of server, and the later instances will act as clients of that server.</p>
<p>By default, the full path of the executable file is used to determine whether two processes are instances of the same application. You can also provide an explicit identifier string that will be compared instead.</p>
<p>The application should create the QtSingleApplication object early in the startup phase, and call <a href="qtsingleapplication.html#isRunning">isRunning</a>() to find out if another instance of this
application is already running. If <a href="qtsingleapplication.html#isRunning">isRunning</a>() returns false, it means that no other instance is running, and this instance has assumed the role as the
running instance. In this case, the application should continue with the initialization of the application user interface before entering the event loop with <a href="http://qt.nokia.com/doc/4.6/qapplication.html#exec">exec</a>(), as normal.</p>
<p>The <a href="qtsingleapplication.html#messageReceived">messageReceived</a>() signal will be emitted when the running application receives messages from another instance of the same application. When
a message is received it might be helpful to the user to raise the application so that it becomes visible. To facilitate this, QtSingleApplication provides
the <a href="qtsingleapplication.html#setActivationWindow">setActivationWindow</a>() function and the <a href="qtsingleapplication.html#activateWindow">activateWindow</a>() slot.</p>
<p>If <a href="qtsingleapplication.html#isRunning">isRunning</a>() returns true, another instance is already running. It may be alerted to the fact that another instance has started by using
the <a href="qtsingleapplication.html#sendMessage">sendMessage</a>() function. Also data such as startup parameters (e.g&#x2e; the name of the file the user wanted this new instance to open) can
be passed to the running instance with this function. Then, the application should terminate (or enter client mode).</p>
<p>If <a href="qtsingleapplication.html#isRunning">isRunning</a>() returns true, but <a href="qtsingleapplication.html#sendMessage">sendMessage</a>() fails, that is an indication that the running instance is frozen.</p>
<p>Here's an example that shows how to convert an existing application to use QtSingleApplication. It is very simple and does not make use of all QtSingleApplication's functionality (see the examples for that).</p>
<pre><span class="comment"> // Original</span>
int main(int argc, char **argv)
{
QApplication app(argc, argv);
MyMainWidget mmw;
mmw.show();
return app.exec();
}
<span class="comment"> // Single instance</span>
int main(int argc, char **argv)
{
QtSingleApplication app(argc, argv);
if (app.isRunning())
return !app.sendMessage(someDataString);
MyMainWidget mmw;
app.setActivationWindow(&amp;mmw);
mmw.show();
return app.exec();
}</pre>
<p>Once this QtSingleApplication instance is destroyed (normally when the process exits or crashes), when the user next attempts to run the application this instance will not, of course, be encountered.
The next instance to call <a href="qtsingleapplication.html#isRunning">isRunning</a>() or <a href="qtsingleapplication.html#sendMessage">sendMessage</a>() will assume the role as the new running instance.</p>
<p>For console (non-GUI) applications, <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a> may be used instead of this class, to avoid the dependency on the <a href="http://qt.nokia.com/doc/4.6/qtgui.html">QtGui</a> library.</p>
<p>See also <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QtSingleApplication"></a>QtSingleApplication::QtSingleApplication ( int &amp; <i>argc</i>, char ** <i>argv</i>, bool <i>GUIenabled</i> = true )</h3>
<p>Creates a <a href="qtsingleapplication.html">QtSingleApplication</a> object. The application identifier will be <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationFilePath">QCoreApplication::applicationFilePath</a>(). <i>argc</i>, <i>argv</i>, and <i>GUIenabled</i> are passed on to the QAppliation constructor.</p>
<p>If you are creating a console application (i.e&#x2e; setting <i>GUIenabled</i> to false), you may consider using <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a> instead.</p>
<h3 class="fn"><a name="QtSingleApplication-2"></a>QtSingleApplication::QtSingleApplication ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>appId</i>, int &amp; <i>argc</i>, char ** <i>argv</i> )</h3>
<p>Creates a <a href="qtsingleapplication.html">QtSingleApplication</a> object with the application identifier <i>appId</i>. <i>argc</i> and <i>argv</i> are passed on to the QAppliation constructor.</p>
<h3 class="fn"><a name="QtSingleApplication-3"></a>QtSingleApplication::QtSingleApplication ( int &amp; <i>argc</i>, char ** <i>argv</i>, <a href="http://qt.nokia.com/doc/4.6/qapplication.html#Type-enum">Type</a> <i>type</i> )</h3>
<p>Creates a <a href="qtsingleapplication.html">QtSingleApplication</a> object. The application identifier will be <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationFilePath">QCoreApplication::applicationFilePath</a>(). <i>argc</i>, <i>argv</i>, and <i>type</i> are passed on to the QAppliation constructor.</p>
<h3 class="fn"><a name="QtSingleApplication-4"></a>QtSingleApplication::QtSingleApplication ( Display * <i>dpy</i>, <a href="http://qt.nokia.com/doc/4.6/qt.html#HANDLE-typedef">Qt::HANDLE</a> <i>visual</i> = 0, <a href="http://qt.nokia.com/doc/4.6/qt.html#HANDLE-typedef">Qt::HANDLE</a> <i>cmap</i> = 0 )</h3>
<p>Special constructor for X11, ref. the documentation of <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a>'s corresponding constructor. The application identifier will
be <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationFilePath">QCoreApplication::applicationFilePath</a>(). <i>dpy</i>, <i>visual</i>, and <i>cmap</i> are passed on to
the <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a> constructor.</p>
<h3 class="fn"><a name="QtSingleApplication-5"></a>QtSingleApplication::QtSingleApplication ( Display * <i>dpy</i>, int &amp; <i>argc</i>, char ** <i>argv</i>, <a href="http://qt.nokia.com/doc/4.6/qt.html#HANDLE-typedef">Qt::HANDLE</a> <i>visual</i> = 0, <a href="http://qt.nokia.com/doc/4.6/qt.html#HANDLE-typedef">Qt::HANDLE</a> <i>cmap</i> = 0 )</h3>
<p>Special constructor for X11, ref. the documentation of <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a>'s corresponding constructor. The application identifier will
be <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationFilePath">QCoreApplication::applicationFilePath</a>(). <i>dpy</i>, <i>argc</i>, <i>argv</i>, <i>visual</i>, and <i>cmap</i> are
passed on to the <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a> constructor.</p>
<h3 class="fn"><a name="QtSingleApplication-6"></a>QtSingleApplication::QtSingleApplication ( Display * <i>dpy</i>, const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>appId</i>, int <i>argc</i>, char ** <i>argv</i>, <a href="http://qt.nokia.com/doc/4.6/qt.html#HANDLE-typedef">Qt::HANDLE</a> <i>visual</i> = 0, <a href="http://qt.nokia.com/doc/4.6/qt.html#HANDLE-typedef">Qt::HANDLE</a> <i>cmap</i> = 0 )</h3>
<p>Special constructor for X11, ref. the documentation of <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a>'s corresponding constructor. The application identifier will be <i>appId</i>. <i>dpy</i>, <i>argc</i>, <i>argv</i>, <i>visual</i>, and <i>cmap</i> are passed on to the <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a> constructor.</p>
<h3 class="fn"><a name="activateWindow"></a>void QtSingleApplication::activateWindow ()&nbsp;&nbsp;<tt> [slot]</tt></h3>
<p>De-minimizes, raises, and activates this application's activation window. This function does nothing if no activation window has been set.</p>
<p>This is a convenience function to show the user that this application instance has been activated when he has tried to start another instance.</p>
<p>This function should typically be called in response to the <a href="qtsingleapplication.html#messageReceived">messageReceived</a>() signal. By default, that will happen automatically, if an activation window has been set.</p>
<p>See also <a href="qtsingleapplication.html#setActivationWindow">setActivationWindow</a>(), <a href="qtsingleapplication.html#messageReceived">messageReceived</a>(), and <a href="qtsingleapplication-obsolete.html#initialize" class="obsolete">initialize</a>().</p>
<h3 class="fn"><a name="activationWindow"></a><a href="http://qt.nokia.com/doc/4.6/qwidget.html">QWidget</a> * QtSingleApplication::activationWindow () const</h3>
<p>Returns the applications activation window if one has been set by calling <a href="qtsingleapplication.html#setActivationWindow">setActivationWindow</a>(), otherwise returns 0.</p>
<p>See also <a href="qtsingleapplication.html#setActivationWindow">setActivationWindow</a>().</p>
<h3 class="fn"><a name="id"></a><a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> QtSingleApplication::id () const</h3>
<p>Returns the application identifier. Two processes with the same identifier will be regarded as instances of the same application.</p>
<h3 class="fn"><a name="isRunning"></a>bool QtSingleApplication::isRunning ()</h3>
<p>Returns true if another instance of this application is running; otherwise false.</p>
<p>This function does not find instances of this application that are being run by a different user (on Windows: that are running in another session).</p>
<p>See also <a href="qtsingleapplication.html#sendMessage">sendMessage</a>().</p>
<h3 class="fn"><a name="messageReceived"></a>void QtSingleApplication::messageReceived ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>message</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
<p>This signal is emitted when the current instance receives a <i>message</i> from another instance of this application.</p>
<p>See also <a href="qtsingleapplication.html#sendMessage">sendMessage</a>(), <a href="qtsingleapplication.html#setActivationWindow">setActivationWindow</a>(), and <a href="qtsingleapplication.html#activateWindow">activateWindow</a>().</p>
<h3 class="fn"><a name="sendMessage"></a>bool QtSingleApplication::sendMessage ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>message</i>, int <i>timeout</i> = 5000 )&nbsp;&nbsp;<tt> [slot]</tt></h3>
<p>Tries to send the text <i>message</i> to the currently running instance. The <a href="qtsingleapplication.html">QtSingleApplication</a> object in the running instance will emit the <a href="qtsingleapplication.html#messageReceived">messageReceived</a>() signal when it receives the message.</p>
<p>This function returns true if the message has been sent to, and processed by, the current instance. If there is no instance currently running, or if the running instance fails to process the message within <i>timeout</i> milliseconds, this function return false.</p>
<p>See also <a href="qtsingleapplication.html#isRunning">isRunning</a>() and <a href="qtsingleapplication.html#messageReceived">messageReceived</a>().</p>
<h3 class="fn"><a name="setActivationWindow"></a>void QtSingleApplication::setActivationWindow ( <a href="http://qt.nokia.com/doc/4.6/qwidget.html">QWidget</a> * <i>aw</i>, bool <i>activateOnMessage</i> = true )</h3>
<p>Sets the activation window of this application to <i>aw</i>. The activation window is the widget that will be activated by <a href="qtsingleapplication.html#activateWindow">activateWindow</a>(). This is typically the application's main window.</p>
<p>If <i>activateOnMessage</i> is true (the default), the window will be activated automatically every time a message is received, just prior to the <a href="qtsingleapplication.html#messageReceived">messageReceived</a>() signal being emitted.</p>
<p>See also <a href="qtsingleapplication.html#activationWindow">activationWindow</a>(), <a href="qtsingleapplication.html#activateWindow">activateWindow</a>(), and <a href="qtsingleapplication.html#messageReceived">messageReceived</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,90 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE QDOCINDEX>
<INDEX url="" title="Qt Solutions: Single Application Documentation" version="">
<namespace access="public" threadsafety="unspecified" status="commendable" name="" href="" location="" module="">
<class access="public" threadsafety="unspecified" status="commendable" name="QtSingleCoreApplication" href="qtsinglecoreapplication.html" location="qtsinglecoreapplication.h" bases="QCoreApplication" module="">
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleCoreApplication" fullname="QtSingleCoreApplication::QtSingleCoreApplication" href="qtsinglecoreapplication.html#QtSingleCoreApplication" location="qtsinglecoreapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="false" type="" signature="QtSingleCoreApplication(int &amp; argc, char ** argv)">
<parameter left="int &amp;" right="" name="argc" default=""/>
<parameter left="char **" right="" name="argv" default=""/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleCoreApplication" fullname="QtSingleCoreApplication::QtSingleCoreApplication" href="qtsinglecoreapplication.html#QtSingleCoreApplication-2" location="qtsinglecoreapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="true" overload-number="2" type="" signature="QtSingleCoreApplication(const QString &amp; appId, int &amp; argc, char ** argv)">
<parameter left="const QString &amp;" right="" name="appId" default=""/>
<parameter left="int &amp;" right="" name="argc" default=""/>
<parameter left="char **" right="" name="argv" default=""/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="isRunning" fullname="QtSingleCoreApplication::isRunning" href="qtsinglecoreapplication.html#isRunning" location="qtsinglecoreapplication.h" virtual="non" meta="plain" const="false" static="false" overload="false" type="bool" signature="isRunning()"/>
<function access="public" threadsafety="unspecified" status="commendable" name="id" fullname="QtSingleCoreApplication::id" href="qtsinglecoreapplication.html#id" location="qtsinglecoreapplication.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="QString" signature="id() const"/>
<function access="public" threadsafety="unspecified" status="commendable" name="sendMessage" fullname="QtSingleCoreApplication::sendMessage" href="qtsinglecoreapplication.html#sendMessage" location="qtsinglecoreapplication.h" virtual="non" meta="slot" const="false" static="false" overload="false" type="bool" signature="sendMessage(const QString &amp; message, int timeout)">
<parameter left="const QString &amp;" right="" name="message" default=""/>
<parameter left="int" right="" name="timeout" default="5000"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="messageReceived" fullname="QtSingleCoreApplication::messageReceived" href="qtsinglecoreapplication.html#messageReceived" location="qtsinglecoreapplication.h" virtual="non" meta="signal" const="false" static="false" overload="false" type="void" signature="messageReceived(const QString &amp; message)">
<parameter left="const QString &amp;" right="" name="message" default=""/>
</function>
</class>
<class access="public" threadsafety="unspecified" status="commendable" name="QtSingleApplication" href="qtsingleapplication.html" location="qtsingleapplication.h" bases="QApplication" module="">
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleApplication" fullname="QtSingleApplication::QtSingleApplication" href="qtsingleapplication.html#QtSingleApplication" location="qtsingleapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="false" type="" signature="QtSingleApplication(int &amp; argc, char ** argv, bool GUIenabled)">
<parameter left="int &amp;" right="" name="argc" default=""/>
<parameter left="char **" right="" name="argv" default=""/>
<parameter left="bool" right="" name="GUIenabled" default="true"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleApplication" fullname="QtSingleApplication::QtSingleApplication" href="qtsingleapplication.html#QtSingleApplication-2" location="qtsingleapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="true" overload-number="2" type="" signature="QtSingleApplication(const QString &amp; appId, int &amp; argc, char ** argv)">
<parameter left="const QString &amp;" right="" name="appId" default=""/>
<parameter left="int &amp;" right="" name="argc" default=""/>
<parameter left="char **" right="" name="argv" default=""/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleApplication" fullname="QtSingleApplication::QtSingleApplication" href="qtsingleapplication.html#QtSingleApplication-3" location="qtsingleapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="true" overload-number="3" type="" signature="QtSingleApplication(int &amp; argc, char ** argv, Type type)">
<parameter left="int &amp;" right="" name="argc" default=""/>
<parameter left="char **" right="" name="argv" default=""/>
<parameter left="Type" right="" name="type" default=""/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleApplication" fullname="QtSingleApplication::QtSingleApplication" href="qtsingleapplication.html#QtSingleApplication-4" location="qtsingleapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="true" overload-number="4" type="" signature="QtSingleApplication(Display * dpy, Qt::HANDLE visual, Qt::HANDLE cmap)">
<parameter left="Display *" right="" name="dpy" default=""/>
<parameter left="Qt::HANDLE" right="" name="visual" default="0"/>
<parameter left="Qt::HANDLE" right="" name="cmap" default="0"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleApplication" fullname="QtSingleApplication::QtSingleApplication" href="qtsingleapplication.html#QtSingleApplication-5" location="qtsingleapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="true" overload-number="5" type="" signature="QtSingleApplication(Display * dpy, int &amp; argc, char ** argv, Qt::HANDLE visual, Qt::HANDLE cmap)">
<parameter left="Display *" right="" name="dpy" default=""/>
<parameter left="int &amp;" right="" name="argc" default=""/>
<parameter left="char **" right="" name="argv" default=""/>
<parameter left="Qt::HANDLE" right="" name="visual" default="0"/>
<parameter left="Qt::HANDLE" right="" name="cmap" default="0"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="QtSingleApplication" fullname="QtSingleApplication::QtSingleApplication" href="qtsingleapplication.html#QtSingleApplication-6" location="qtsingleapplication.h" virtual="non" meta="constructor" const="false" static="false" overload="true" overload-number="6" type="" signature="QtSingleApplication(Display * dpy, const QString &amp; appId, int argc, char ** argv, Qt::HANDLE visual, Qt::HANDLE cmap)">
<parameter left="Display *" right="" name="dpy" default=""/>
<parameter left="const QString &amp;" right="" name="appId" default=""/>
<parameter left="int" right="" name="argc" default=""/>
<parameter left="char **" right="" name="argv" default=""/>
<parameter left="Qt::HANDLE" right="" name="visual" default="0"/>
<parameter left="Qt::HANDLE" right="" name="cmap" default="0"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="isRunning" fullname="QtSingleApplication::isRunning" href="qtsingleapplication.html#isRunning" location="qtsingleapplication.h" virtual="non" meta="plain" const="false" static="false" overload="false" type="bool" signature="isRunning()"/>
<function access="public" threadsafety="unspecified" status="commendable" name="id" fullname="QtSingleApplication::id" href="qtsingleapplication.html#id" location="qtsingleapplication.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="QString" signature="id() const"/>
<function access="public" threadsafety="unspecified" status="commendable" name="setActivationWindow" fullname="QtSingleApplication::setActivationWindow" href="qtsingleapplication.html#setActivationWindow" location="qtsingleapplication.h" virtual="non" meta="plain" const="false" static="false" overload="false" type="void" signature="setActivationWindow(QWidget * aw, bool activateOnMessage)">
<parameter left="QWidget *" right="" name="aw" default=""/>
<parameter left="bool" right="" name="activateOnMessage" default="true"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="activationWindow" fullname="QtSingleApplication::activationWindow" href="qtsingleapplication.html#activationWindow" location="qtsingleapplication.h" virtual="non" meta="plain" const="true" static="false" overload="false" type="QWidget *" signature="activationWindow() const"/>
<function access="public" threadsafety="unspecified" status="obsolete" name="initialize" fullname="QtSingleApplication::initialize" href="qtsingleapplication-obsolete.html#initialize" location="qtsingleapplication.h" virtual="non" meta="plain" const="false" static="false" overload="false" type="void" signature="initialize(bool dummy)">
<parameter left="bool" right="" name="dummy" default="true"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="sendMessage" fullname="QtSingleApplication::sendMessage" href="qtsingleapplication.html#sendMessage" location="qtsingleapplication.h" virtual="non" meta="slot" const="false" static="false" overload="false" type="bool" signature="sendMessage(const QString &amp; message, int timeout)">
<parameter left="const QString &amp;" right="" name="message" default=""/>
<parameter left="int" right="" name="timeout" default="5000"/>
</function>
<function access="public" threadsafety="unspecified" status="commendable" name="activateWindow" fullname="QtSingleApplication::activateWindow" href="qtsingleapplication.html#activateWindow" location="qtsingleapplication.h" virtual="non" meta="slot" const="false" static="false" overload="false" type="void" signature="activateWindow()"/>
<function access="public" threadsafety="unspecified" status="commendable" name="messageReceived" fullname="QtSingleApplication::messageReceived" href="qtsingleapplication.html#messageReceived" location="qtsingleapplication.h" virtual="non" meta="signal" const="false" static="false" overload="false" type="void" signature="messageReceived(const QString &amp; message)">
<parameter left="const QString &amp;" right="" name="message" default=""/>
</function>
</class>
<page access="public" status="commendable" name="index.html" href="index.html" subtype="page" title="Single Application" fulltitle="Single Application" subtitle="" location="index.qdoc">
<contents name="description" title="Description" level="1"/>
<contents name="classes" title="Classes" level="1"/>
<contents name="examples" title="Examples" level="1"/>
<contents name="tested-platforms" title="Tested platforms" level="1"/>
</page>
<page access="public" status="commendable" name="qtsingleapplication-example-trivial.html" href="qtsingleapplication-example-trivial.html" subtype="page" title="A Trivial Example" fulltitle="A Trivial Example" subtitle="" location="trivial.qdoc"/>
<page access="public" status="commendable" name="qtsinglecoreapplication-example-console.html" href="qtsinglecoreapplication-example-console.html" subtype="page" title="A non-GUI example" fulltitle="A non-GUI example" subtitle="" location="console.qdoc"/>
<page access="public" status="commendable" name="qtsingleapplication-example-loader.html" href="qtsingleapplication-example-loader.html" subtype="page" title="Loading Documents" fulltitle="Loading Documents" subtitle="" location="loader.qdoc"/>
</namespace>
</INDEX>

View File

@ -0,0 +1,53 @@
<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
<namespace>com.nokia.qtsolutions.qtsingleapplication_head</namespace>
<virtualFolder>qdoc</virtualFolder>
<customFilter name="Qt Solutions: Single Application">
<filterAttribute>qt</filterAttribute>
<filterAttribute>solutions</filterAttribute>
<filterAttribute>qtsingleapplication</filterAttribute>
</customFilter>
<filterSection>
<filterAttribute>qt</filterAttribute>
<filterAttribute>solutions</filterAttribute>
<filterAttribute>qtsingleapplication</filterAttribute>
<toc>
<section ref="index.html" title="Qt Solutions: Single Application Documentation">
<section ref="qtsingleapplication-example-trivial.html" title="A Trivial Example"/>
<section ref="qtsinglecoreapplication-example-console.html" title="A non-GUI example"/>
<section ref="qtsingleapplication-example-loader.html" title="Loading Documents"/>
<section ref="index.html" title="Single Application"/>
</section>
</toc>
<keywords>
<keyword name="A Trivial Example" id="A Trivial Example" ref="qtsingleapplication-example-trivial.html"/>
<keyword name="A non-GUI example" id="A non-GUI example" ref="qtsinglecoreapplication-example-console.html"/>
<keyword name="Loading Documents" id="Loading Documents" ref="qtsingleapplication-example-loader.html"/>
<keyword name="QtSingleApplication" id="QtSingleApplication" ref="qtsingleapplication.html"/>
<keyword name="activateWindow" id="QtSingleApplication::activateWindow" ref="qtsingleapplication.html#activateWindow"/>
<keyword name="activationWindow" id="QtSingleApplication::activationWindow" ref="qtsingleapplication.html#activationWindow"/>
<keyword name="id" id="QtSingleApplication::id" ref="qtsingleapplication.html#id"/>
<keyword name="initialize" id="QtSingleApplication::initialize" ref="qtsingleapplication-obsolete.html#initialize"/>
<keyword name="isRunning" id="QtSingleApplication::isRunning" ref="qtsingleapplication.html#isRunning"/>
<keyword name="messageReceived" id="QtSingleApplication::messageReceived" ref="qtsingleapplication.html#messageReceived"/>
<keyword name="sendMessage" id="QtSingleApplication::sendMessage" ref="qtsingleapplication.html#sendMessage"/>
<keyword name="setActivationWindow" id="QtSingleApplication::setActivationWindow" ref="qtsingleapplication.html#setActivationWindow"/>
<keyword name="QtSingleCoreApplication" id="QtSingleCoreApplication" ref="qtsinglecoreapplication.html"/>
<keyword name="id" id="QtSingleCoreApplication::id" ref="qtsinglecoreapplication.html#id"/>
<keyword name="isRunning" id="QtSingleCoreApplication::isRunning" ref="qtsinglecoreapplication.html#isRunning"/>
<keyword name="messageReceived" id="QtSingleCoreApplication::messageReceived" ref="qtsinglecoreapplication.html#messageReceived"/>
<keyword name="sendMessage" id="QtSingleCoreApplication::sendMessage" ref="qtsinglecoreapplication.html#sendMessage"/>
<keyword name="Single Application" id="Single Application" ref="index.html"/>
</keywords>
<files>
<file>qtsingleapplication.html</file>
<file>index.html</file>
<file>qtsingleapplication-example-trivial.html</file>
<file>qtsinglecoreapplication.html</file>
<file>qtsingleapplication-example-loader.html</file>
<file>qtsinglecoreapplication-example-console.html</file>
<file>classic.css</file>
<file>images/qt-logo.png</file>
</files>
</filterSection>
</QtHelpProject>

View File

@ -0,0 +1,118 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- console.qdoc -->
<head>
<title>A non-GUI example</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">A non-GUI example<br /><span class="subtitle"></span>
</h1>
<p>This example shows how to use the single-application functionality in a console application. It does not require the <tt>QtGui</tt> library at all.</p>
<p>The only differences from the GUI application usage demonstrated in the other examples are:</p>
<p>1) The <tt>.pro</tt> file should include <tt>qtsinglecoreapplication.pri</tt> instead of <tt>qtsingleapplication.pri</tt></p>
<p>2) The class name is <tt>QtSingleCoreApplication</tt> instead of <tt>QtSingleApplication</tt>.</p>
<p>3) No calls are made regarding window activation, for obvious reasons.</p>
<p>console.pro:</p>
<pre> TEMPLATE = app
CONFIG += console
SOURCES += main.cpp
include(../../src/qtsinglecoreapplication.pri)
QT -= gui</pre>
<p>main.cpp:</p>
<pre><span class="comment"> /****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** You may use this file under the terms of the BSD license as follows:
**
** &quot;Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
** the names of its contributors may be used to endorse or promote
** products derived from this software without specific prior written
** permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.&quot;
**
****************************************************************************/</span>
#include &quot;qtsinglecoreapplication.h&quot;
#include &lt;QtCore/QDebug&gt;
void report(const QString&amp; msg)
{
qDebug(&quot;[%i] %s&quot;, (int)QCoreApplication::applicationPid(), qPrintable(msg));
}
class MainClass : public QObject
{
Q_OBJECT
public:
MainClass()
: QObject()
{}
public slots:
void handleMessage(const QString&amp; message)
{
report( &quot;Message received: \&quot;&quot; + message + &quot;\&quot;&quot;);
}
};
int main(int argc, char **argv)
{
report(&quot;Starting up&quot;);
QtSingleCoreApplication app(argc, argv);
if (app.isRunning()) {
QString msg(QString(&quot;Hi master, I am %1.&quot;).arg(QCoreApplication::applicationPid()));
bool sentok = app.sendMessage(msg, 2000);
QString rep(&quot;Another instance is running, so I will exit.&quot;);
rep += sentok ? &quot; Message sent ok.&quot; : &quot; Message sending failed; the other instance may be frozen.&quot;;
report(rep);
return 0;
} else {
report(&quot;No other instance is running; so I will.&quot;);
MainClass mainObj;
QObject::connect(&amp;app, SIGNAL(messageReceived(const QString&amp;)),
&amp;mainObj, SLOT(handleMessage(const QString&amp;)));
return app.exec();
}
}
#include &quot;main.moc&quot;</pre>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,126 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qtsinglecoreapplication.cpp -->
<head>
<title>List of All Members for QtSingleCoreApplication</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">List of All Members for QtSingleCoreApplication</h1>
<p>This is the complete list of members for <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a>, including inherited members.</p>
<p><table class="propsummary" width="100%" border="0" cellpadding="0" cellspacing="0">
<tr><td width="45%" valign="top"><ul>
<li><div class="fn">enum <b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#Encoding-enum">Encoding</a></b></div></li>
<li><div class="fn">typedef <b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#EventFilter-typedef">EventFilter</a></b></div></li>
<li><div class="fn"><b><a href="qtsinglecoreapplication.html#QtSingleCoreApplication">QtSingleCoreApplication</a></b> ( int &amp;, char ** )</div></li>
<li><div class="fn"><b><a href="qtsinglecoreapplication.html#QtSingleCoreApplication-2">QtSingleCoreApplication</a></b> ( const QString &amp;, int &amp;, char ** )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#aboutToQuit">aboutToQuit</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#addLibraryPath">addLibraryPath</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationDirPath">applicationDirPath</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationFilePath">applicationFilePath</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationName-prop">applicationName</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationPid">applicationPid</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationVersion-prop">applicationVersion</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#arguments">arguments</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#blockSignals">blockSignals</a></b> ( bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#childEvent">childEvent</a></b> ( QChildEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#children">children</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#closingDown">closingDown</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#connect">connect</a></b> ( const QObject *, const char *, const QObject *, const char *, Qt::ConnectionType )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#connect-2">connect</a></b> ( const QObject *, const char *, const char *, Qt::ConnectionType ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#connectNotify">connectNotify</a></b> ( const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#customEvent">customEvent</a></b> ( QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#d_ptr-var">d_ptr</a></b> : </div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#deleteLater">deleteLater</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#destroyed">destroyed</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnect">disconnect</a></b> ( const QObject *, const char *, const QObject *, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnect-2">disconnect</a></b> ( const char *, const QObject *, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnect-3">disconnect</a></b> ( const QObject *, const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#disconnectNotify">disconnectNotify</a></b> ( const char * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#dumpObjectInfo">dumpObjectInfo</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#dumpObjectTree">dumpObjectTree</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#dynamicPropertyNames">dynamicPropertyNames</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#event">event</a></b> ( QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#eventFilter">eventFilter</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#exec">exec</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#exit">exit</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#filterEvent">filterEvent</a></b> ( void *, long * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#findChild">findChild</a></b> ( const QString &amp; ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#findChildren">findChildren</a></b> ( const QString &amp; ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#findChildren-2">findChildren</a></b> ( const QRegExp &amp; ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#flush">flush</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#hasPendingEvents">hasPendingEvents</a></b> ()</div></li>
<li><div class="fn"><b><a href="qtsinglecoreapplication.html#id">id</a></b> () const : QString</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#inherits">inherits</a></b> ( const char * ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#installEventFilter">installEventFilter</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#installTranslator">installTranslator</a></b> ( QTranslator * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#instance">instance</a></b> ()</div></li>
<li><div class="fn"><b><a href="qtsinglecoreapplication.html#isRunning">isRunning</a></b> () : bool</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#isWidgetType">isWidgetType</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#killTimer">killTimer</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#libraryPaths">libraryPaths</a></b> ()</div></li>
</ul></td><td valign="top"><ul>
<li><div class="fn"><b><a href="qtsinglecoreapplication.html#messageReceived">messageReceived</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#metaObject">metaObject</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#moveToThread">moveToThread</a></b> ( QThread * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#notify">notify</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#objectName-prop">objectName</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationDomain-prop">organizationDomain</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationName-prop">organizationName</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#parent">parent</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#postEvent">postEvent</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#postEvent-2">postEvent</a></b> ( QObject *, QEvent *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#processEvents">processEvents</a></b> ( QFlags&lt;QEventLoop::ProcessEventsFlag&gt; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#processEvents-2">processEvents</a></b> ( QFlags&lt;QEventLoop::ProcessEventsFlag&gt;, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#property">property</a></b> ( const char * ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#quit">quit</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#receivers">receivers</a></b> ( const char * ) const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#removeEventFilter">removeEventFilter</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removeLibraryPath">removeLibraryPath</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removePostedEvents">removePostedEvents</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removePostedEvents-2">removePostedEvents</a></b> ( QObject *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#removeTranslator">removeTranslator</a></b> ( QTranslator * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#sendEvent">sendEvent</a></b> ( QObject *, QEvent * )</div></li>
<li><div class="fn"><b><a href="qtsinglecoreapplication.html#sendMessage">sendMessage</a></b> ( const QString &amp;, int ) : bool</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#sendPostedEvents">sendPostedEvents</a></b> ( QObject *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#sendPostedEvents-2">sendPostedEvents</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#sender">sender</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationName-prop">setApplicationName</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationVersion-prop">setApplicationVersion</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#setAttribute">setAttribute</a></b> ( Qt::ApplicationAttribute, bool )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#setEventFilter">setEventFilter</a></b> ( EventFilter )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#setLibraryPaths">setLibraryPaths</a></b> ( const QStringList &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#objectName-prop">setObjectName</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationDomain-prop">setOrganizationDomain</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#organizationName-prop">setOrganizationName</a></b> ( const QString &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#setParent">setParent</a></b> ( QObject * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#setProperty">setProperty</a></b> ( const char *, const QVariant &amp; )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#signalsBlocked">signalsBlocked</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#startTimer">startTimer</a></b> ( int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#startingUp">startingUp</a></b> ()</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#staticMetaObject-var">staticMetaObject</a></b> : </div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#staticQtMetaObject-var">staticQtMetaObject</a></b> : </div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#testAttribute">testAttribute</a></b> ( Qt::ApplicationAttribute )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#thread">thread</a></b> () const</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#timerEvent">timerEvent</a></b> ( QTimerEvent * )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#tr">tr</a></b> ( const char *, const char *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qobject.html#trUtf8">trUtf8</a></b> ( const char *, const char *, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#translate">translate</a></b> ( const char *, const char *, const char *, Encoding, int )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#translate-2">translate</a></b> ( const char *, const char *, const char *, Encoding )</div></li>
<li><div class="fn"><b><a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#winEventFilter">winEventFilter</a></b> ( MSG *, long * )</div></li>
</ul>
</td></tr>
</table></p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

View File

@ -0,0 +1,98 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qtsinglecoreapplication.cpp -->
<head>
<title>QtSingleCoreApplication Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="57" height="67" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
</tr></table><h1 class="title">QtSingleCoreApplication Class Reference</h1>
<p>A variant of the <a href="qtsingleapplication.html">QtSingleApplication</a> class for non-GUI applications. <a href="#details">More...</a></p>
<pre> #include &lt;QtSingleCoreApplication&gt;</pre><p>Inherits <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html">QCoreApplication</a>.</p>
<ul>
<li><a href="qtsinglecoreapplication-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsinglecoreapplication.html#QtSingleCoreApplication">QtSingleCoreApplication</a></b> ( int &amp; <i>argc</i>, char ** <i>argv</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtsinglecoreapplication.html#QtSingleCoreApplication-2">QtSingleCoreApplication</a></b> ( const QString &amp; <i>appId</i>, int &amp; <i>argc</i>, char ** <i>argv</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qtsinglecoreapplication.html#id">id</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtsinglecoreapplication.html#isRunning">isRunning</a></b> ()</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>4 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#public-functions">QCoreApplication</a></li>
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-functions">QObject</a></li>
</ul>
<hr />
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtsinglecoreapplication.html#sendMessage">sendMessage</a></b> ( const QString &amp; <i>message</i>, int <i>timeout</i> = 5000 )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#public-slots">QCoreApplication</a></li>
<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-slots">QObject</a></li>
</ul>
<hr />
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qtsinglecoreapplication.html#messageReceived">messageReceived</a></b> ( const QString &amp; <i>message</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#signals">QCoreApplication</a></li>
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>4 properties inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#properties">QCoreApplication</a></li>
<li><div class="fn"></div>1 property inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>38 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#static-public-members">QCoreApplication</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>1 protected function inherited from <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#protected-functions">QCoreApplication</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>A variant of the <a href="qtsingleapplication.html">QtSingleApplication</a> class for non-GUI applications.</p>
<p>This class is a variant of <a href="qtsingleapplication.html">QtSingleApplication</a> suited for use in console (non-GUI) applications. It is an extension of <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html">QCoreApplication</a> (instead of <a href="http://qt.nokia.com/doc/4.6/qapplication.html">QApplication</a>). It does not require the <a href="http://qt.nokia.com/doc/4.6/qtgui.html">QtGui</a> library.</p>
<p>The API and usage is identical to <a href="qtsingleapplication.html">QtSingleApplication</a>, except that functions relating to the &quot;activation window&quot; are not present, for obvious reasons. Please refer to the <a href="qtsingleapplication.html">QtSingleApplication</a> documentation for explanation of the usage.</p>
<p>A QtSingleCoreApplication instance can communicate to a <a href="qtsingleapplication.html">QtSingleApplication</a> instance if they share the same application id. Hence, this class can be used to create a light-weight command-line tool that sends commands to a GUI application.</p>
<p>See also <a href="qtsingleapplication.html">QtSingleApplication</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QtSingleCoreApplication"></a>QtSingleCoreApplication::QtSingleCoreApplication ( int &amp; <i>argc</i>, char ** <i>argv</i> )</h3>
<p>Creates a <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a> object. The application identifier will be <a href="http://qt.nokia.com/doc/4.6/qcoreapplication.html#applicationFilePath">QCoreApplication::applicationFilePath</a>(). <i>argc</i> and <i>argv</i> are passed on to the QCoreAppliation constructor.</p>
<h3 class="fn"><a name="QtSingleCoreApplication-2"></a>QtSingleCoreApplication::QtSingleCoreApplication ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>appId</i>, int &amp; <i>argc</i>, char ** <i>argv</i> )</h3>
<p>Creates a <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a> object with the application identifier <i>appId</i>. <i>argc</i> and <i>argv</i> are passed on to the QCoreAppliation constructor.</p>
<h3 class="fn"><a name="id"></a><a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> QtSingleCoreApplication::id () const</h3>
<p>Returns the application identifier. Two processes with the same identifier will be regarded as instances of the same application.</p>
<h3 class="fn"><a name="isRunning"></a>bool QtSingleCoreApplication::isRunning ()</h3>
<p>Returns true if another instance of this application is running; otherwise false.</p>
<p>This function does not find instances of this application that are being run by a different user (on Windows: that are running in another session).</p>
<p>See also <a href="qtsinglecoreapplication.html#sendMessage">sendMessage</a>().</p>
<h3 class="fn"><a name="messageReceived"></a>void QtSingleCoreApplication::messageReceived ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>message</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
<p>This signal is emitted when the current instance receives a <i>message</i> from another instance of this application.</p>
<p>See also <a href="qtsinglecoreapplication.html#sendMessage">sendMessage</a>().</p>
<h3 class="fn"><a name="sendMessage"></a>bool QtSingleCoreApplication::sendMessage ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>message</i>, int <i>timeout</i> = 5000 )&nbsp;&nbsp;<tt> [slot]</tt></h3>
<p>Tries to send the text <i>message</i> to the currently running instance. The <a href="qtsinglecoreapplication.html">QtSingleCoreApplication</a> object in the running instance will emit the <a href="qtsinglecoreapplication.html#messageReceived">messageReceived</a>() signal when it receives the message.</p>
<p>This function returns true if the message has been sent to, and processed by, the current instance. If there is no instance currently running, or if the running instance fails to process the message within <i>timeout</i> milliseconds, this function return false.</p>
<p>See also <a href="qtsinglecoreapplication.html#isRunning">isRunning</a>() and <a href="qtsinglecoreapplication.html#messageReceived">messageReceived</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="40%" align="center"><a href="http://qt.nokia.com/doc/trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt Solutions</div></td>
</tr></table></div></address></body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB

View File

@ -0,0 +1,50 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
/*!
\page index.html
\title Single Application
\section1 Description
The QtSingleApplication component provides support
for applications that can be only started once per user.
For some applications it is useful or even critical that they are started
only once by any user. Future attempts to start the application should
activate any already running instance, and possibly perform requested
actions, e.g. loading a file, in that instance.
The QtSingleApplication class provides an interface to detect a running
instance, and to send command strings to that instance.
For console (non-GUI) applications, the QtSingleCoreApplication variant is provided, which avoids dependency on QtGui.
\section1 Classes
\list
\i QtSingleApplication \i QtSingleCoreApplication\endlist
\section1 Examples
\list
\i \link qtsingleapplication-example-trivial.html A Trivial Example \endlink \i \link qtsingleapplication-example-loader.html Loading Documents \endlink \i \link qtsinglecoreapplication-example-console.html A Non-GUI Example \endlink \endlist
\section1 Tested platforms
\list
\i Qt 4.4, 4.5 / Windows XP / MSVC.NET 2005
\i Qt 4.4, 4.5 / Linux / gcc
\i Qt 4.4, 4.5 / MacOS X 10.5 / gcc
\endlist
*/

View File

@ -0,0 +1,5 @@
TEMPLATE = app
CONFIG += console
SOURCES += main.cpp
include(../../src/qtsinglecoreapplication.pri)
QT -= gui

View File

@ -0,0 +1,28 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
/*! \page qtsinglecoreapplication-example-console.html
\title A non-GUI example
This example shows how to use the single-application functionality
in a console application. It does not require the \c QtGui library
at all.
The only differences from the GUI application usage demonstrated
in the other examples are:
1) The \c.pro file should include \c qtsinglecoreapplication.pri
instead of \c qtsingleapplication.pri
2) The class name is \c QtSingleCoreApplication instead of \c
QtSingleApplication.
3) No calls are made regarding window activation, for obvious reasons.
console.pro:
\quotefile console/console.pro
main.cpp:
\quotefile console/main.cpp
*/

View File

@ -0,0 +1,52 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include "qtsinglecoreapplication.h"
#include <QDebug>
void report(const QString& msg)
{
qDebug("[%i] %s", (int)QCoreApplication::applicationPid(), qPrintable(msg));
}
class MainClass : public QObject
{
Q_OBJECT
public:
MainClass()
: QObject()
{}
public slots:
void handleMessage(const QString& message)
{
report( "Message received: \"" + message + "\"");
}
};
int main(int argc, char **argv)
{
report("Starting up");
QtSingleCoreApplication app(argc, argv);
if (app.isRunning()) {
QString msg(QString("Hi master, I am %1.").arg(QCoreApplication::applicationPid()));
bool sentok = app.sendMessage(msg, 2000);
QString rep("Another instance is running, so I will exit.");
rep += sentok ? " Message sent ok." : " Message sending failed; the other instance may be frozen.";
report(rep);
return 0;
} else {
report("No other instance is running; so I will.");
MainClass mainObj;
QObject::connect(&app, SIGNAL(messageReceived(const QString&)),
&mainObj, SLOT(handleMessage(const QString&)));
return app.exec();
}
}
#include "main.moc"

View File

@ -0,0 +1,4 @@
TEMPLATE = subdirs
SUBDIRS = trivial \
loader \
console

View File

@ -0,0 +1 @@
File 1

View File

@ -0,0 +1 @@
File 2

View File

@ -0,0 +1,6 @@
greaterThan(QT_MAJOR_VERSION, 4): QT += printsupport
TEMPLATE = app
include(../../src/qtsingleapplication.pri)
SOURCES += main.cpp

View File

@ -0,0 +1,44 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
/*! \page qtsingleapplication-example-loader.html
\title Loading Documents
The application in this example loads or prints the documents
passed as commandline parameters to further instances of this
application.
\quotefromfile loader/main.cpp
\printuntil };
The user interface in this application is a QMainWindow subclass
with a QMdiArea as the central widget. It implements a slot
\c handleMessage() that will be connected to the messageReceived()
signal of the QtSingleApplication class.
\printuntil }
The MainWindow constructor creates a minimal user interface.
\printto case Print:
The handleMessage() slot interprets the message passed in as a
filename that can be prepended with \e /print to indicate that
the file should just be printed rather than loaded.
\printto #include
Loading the file will also activate the window.
\printto mw
The \c main entry point function creates a QtSingleApplication
object, and creates a message to send to a running instance
of the application. If the message was sent successfully the
process exits immediately.
\printuntil }
If the message could not be sent the application starts up. Note
that \c false is passed to the call to setActivationWindow() to
prevent automatic activation for every message received, e.g. when
the application should just print a file. Instead, the message
handling function determines whether activation is requested, and
signals that by emitting the needToShow() signal. This is then
simply connected directly to QtSingleApplication's
activateWindow() slot.
*/

View File

@ -0,0 +1,115 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include <qtsingleapplication.h>
#include <QFile>
#include <QMainWindow>
#include <QPrinter>
#include <QPainter>
#include <QTextEdit>
#include <QMdiArea>
#include <QTextStream>
class MainWindow : public QMainWindow
{
Q_OBJECT
public:
MainWindow();
public slots:
void handleMessage(const QString& message);
signals:
void needToShow();
private:
QMdiArea *workspace;
};
MainWindow::MainWindow()
{
workspace = new QMdiArea(this);
setCentralWidget(workspace);
}
void MainWindow::handleMessage(const QString& message)
{
enum Action {
Nothing,
Open,
Print
} action;
action = Nothing;
QString filename = message;
if (message.toLower().startsWith("/print ")) {
filename = filename.mid(7);
action = Print;
} else if (!message.isEmpty()) {
action = Open;
}
if (action == Nothing) {
emit needToShow();
return;
}
QFile file(filename);
QString contents;
if (file.open(QIODevice::ReadOnly))
contents = file.readAll();
else
contents = "[[Error: Could not load file " + filename + "]]";
QTextEdit *view = new QTextEdit;
view->setPlainText(contents);
switch(action) {
case Print:
{
QPrinter printer;
view->print(&printer);
delete view;
}
break;
case Open:
{
workspace->addSubWindow(view);
view->setWindowTitle(message);
view->show();
emit needToShow();
}
break;
default:
break;
};
}
#include "main.moc"
int main(int argc, char **argv)
{
QtSingleApplication instance("File loader QtSingleApplication example", argc, argv);
QString message;
for (int a = 1; a < argc; ++a) {
message += argv[a];
if (a < argc-1)
message += " ";
}
if (instance.sendMessage(message))
return 0;
MainWindow mw;
mw.handleMessage(message);
mw.show();
QObject::connect(&instance, SIGNAL(messageReceived(const QString&)),
&mw, SLOT(handleMessage(const QString&)));
instance.setActivationWindow(&mw, false);
QObject::connect(&mw, SIGNAL(needToShow()), &instance, SLOT(activateWindow()));
return instance.exec();
}

View File

@ -0,0 +1,41 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include <qtsingleapplication.h>
#include <QTextEdit>
class TextEdit : public QTextEdit
{
Q_OBJECT
public:
TextEdit(QWidget *parent = 0)
: QTextEdit(parent)
{}
public slots:
void append(const QString &str)
{
QTextEdit::append(str);
}
};
#include "main.moc"
int main(int argc, char **argv)
{
QtSingleApplication instance(argc, argv);
if (instance.sendMessage("Wake up!"))
return 0;
TextEdit logview;
logview.setReadOnly(true);
logview.show();
instance.setActivationWindow(&logview);
QObject::connect(&instance, SIGNAL(messageReceived(const QString&)),
&logview, SLOT(append(const QString&)));
return instance.exec();
}

View File

@ -0,0 +1,5 @@
TEMPLATE = app
include(../../src/qtsingleapplication.pri)
SOURCES += main.cpp

View File

@ -0,0 +1,39 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
/*! \page qtsingleapplication-example-trivial.html
\title A Trivial Example
The application in this example has a log-view that displays
messages sent by further instances of the same application.
The example demonstrates the use of the QtSingleApplication
class to detect and communicate with a running instance of
the application using the sendMessage() API. The messageReceived()
signal is used to display received messages in a QTextEdit log.
\quotefromfile trivial/main.cpp
\printuntil instance
The example has only the \c main entry point function.
A QtSingleApplication object is created immediately.
\printuntil return
If another instance of this application is already running,
sendMessage() will succeed, and this instance just exits
immediately.
\printuntil show()
Otherwise the instance continues as normal and creates the
user interface.
\printuntil return instance.exec();
The \c logview object is also set as the application's activation
window. Every time a message is received, the window will be raised
and activated automatically.
The messageReceived() signal is also connected to the QTextEdit's
append() slot. Every message received from further instances of
this application will be displayed in the log.
Finally the event loop is entered.
*/

View File

@ -1,77 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QTLOCALPEER_H
#define QTLOCALPEER_H
#include <QLocalServer>
#include <QLocalSocket>
#include <QDir>
#include "qtlockedfile.h"
class QtLocalPeer : public QObject
{
Q_OBJECT
public:
QtLocalPeer(QObject *parent = 0, const QString &appId = QString());
bool isClient();
bool sendMessage(const QString &message, int timeout);
QString applicationId() const
{ return id; }
Q_SIGNALS:
void messageReceived(const QString &message);
protected Q_SLOTS:
void receiveConnection();
protected:
QString id;
QString socketName;
QLocalServer* server;
QtLP_Private::QtLockedFile lockFile;
private:
static const char* ack;
};
#endif // QTLOCALPEER_H

View File

@ -1,97 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QTLOCKEDFILE_H
#define QTLOCKEDFILE_H
#include <QFile>
#ifdef Q_OS_WIN
#include <QVector>
#endif
#if defined(Q_OS_WIN)
# if !defined(QT_QTLOCKEDFILE_EXPORT) && !defined(QT_QTLOCKEDFILE_IMPORT)
# define QT_QTLOCKEDFILE_EXPORT
# elif defined(QT_QTLOCKEDFILE_IMPORT)
# if defined(QT_QTLOCKEDFILE_EXPORT)
# undef QT_QTLOCKEDFILE_EXPORT
# endif
# define QT_QTLOCKEDFILE_EXPORT __declspec(dllimport)
# elif defined(QT_QTLOCKEDFILE_EXPORT)
# undef QT_QTLOCKEDFILE_EXPORT
# define QT_QTLOCKEDFILE_EXPORT __declspec(dllexport)
# endif
#else
# define QT_QTLOCKEDFILE_EXPORT
#endif
namespace QtLP_Private {
class QT_QTLOCKEDFILE_EXPORT QtLockedFile : public QFile
{
public:
enum LockMode { NoLock = 0, ReadLock, WriteLock };
QtLockedFile();
QtLockedFile(const QString &name);
~QtLockedFile();
bool open(OpenMode mode);
bool lock(LockMode mode, bool block = true);
bool unlock();
bool isLocked() const;
LockMode lockMode() const;
private:
#ifdef Q_OS_WIN
Qt::HANDLE wmutex;
Qt::HANDLE rmutex;
QVector<Qt::HANDLE> rmutexes;
QString mutexname;
Qt::HANDLE getMutexHandle(int idx, bool doCreate);
bool waitMutex(Qt::HANDLE mutex, bool doBlock);
#endif
LockMode m_lock_mode;
};
}
#endif

View File

@ -1,115 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include "qtlockedfile.h"
bool QtLockedFile::lock(LockMode mode, bool block)
{
if (!isOpen()) {
qWarning("QtLockedFile::lock(): file is not opened");
return false;
}
if (mode == NoLock)
return unlock();
if (mode == m_lock_mode)
return true;
if (m_lock_mode != NoLock)
unlock();
struct flock fl;
fl.l_whence = SEEK_SET;
fl.l_start = 0;
fl.l_len = 0;
fl.l_type = (mode == ReadLock) ? F_RDLCK : F_WRLCK;
int cmd = block ? F_SETLKW : F_SETLK;
int ret = fcntl(handle(), cmd, &fl);
if (ret == -1) {
if (errno != EINTR && errno != EAGAIN)
qWarning("QtLockedFile::lock(): fcntl: %s", strerror(errno));
return false;
}
m_lock_mode = mode;
return true;
}
bool QtLockedFile::unlock()
{
if (!isOpen()) {
qWarning("QtLockedFile::unlock(): file is not opened");
return false;
}
if (!isLocked())
return true;
struct flock fl;
fl.l_whence = SEEK_SET;
fl.l_start = 0;
fl.l_len = 0;
fl.l_type = F_UNLCK;
int ret = fcntl(handle(), F_SETLKW, &fl);
if (ret == -1) {
qWarning("QtLockedFile::lock(): fcntl: %s", strerror(errno));
return false;
}
m_lock_mode = NoLock;
return true;
}
QtLockedFile::~QtLockedFile()
{
if (isOpen())
unlock();
}

View File

@ -0,0 +1,5 @@
TEMPLATE=subdirs
CONFIG += ordered
include(common.pri)
qtsingleapplication-uselib:SUBDIRS=buildlib
SUBDIRS+=examples

View File

@ -1,71 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QTSINGLECOREAPPLICATION_H
#define QTSINGLECOREAPPLICATION_H
#include <QCoreApplication>
class QtLocalPeer;
class QtSingleCoreApplication : public QCoreApplication
{
Q_OBJECT
public:
QtSingleCoreApplication(int &argc, char **argv);
QtSingleCoreApplication(const QString &id, int &argc, char **argv);
bool isRunning();
QString id() const;
public Q_SLOTS:
bool sendMessage(const QString &message, int timeout = 5000);
Q_SIGNALS:
void messageReceived(const QString &message);
private:
QtLocalPeer* peer;
};
#endif // QTSINGLECOREAPPLICATION_H

View File

@ -1,47 +1,11 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include "qtlocalpeer.h"
#include <QCoreApplication>
#include <QDataStream>
#include <QRegularExpression>
#include <QTime>
#if defined(Q_OS_WIN)
@ -78,7 +42,7 @@ QtLocalPeer::QtLocalPeer(QObject* parent, const QString &appId)
#endif
prefix = id.section(QLatin1Char('/'), -1);
}
prefix.remove(QRegExp("[^a-zA-Z]"));
prefix.remove(QRegularExpression("[^a-zA-Z]"));
prefix.truncate(6);
QByteArray idc = id.toUtf8();
@ -180,7 +144,6 @@ void QtLocalPeer::receiveConnection()
if (socket->state() == QLocalSocket::UnconnectedState) {
qWarning("QtLocalPeer: Peer disconnected");
delete socket;
socket = nullptr;
return;
}
if (socket->bytesAvailable() >= qint64(sizeof(quint32)))
@ -203,7 +166,6 @@ void QtLocalPeer::receiveConnection()
if (got < 0) {
qWarning("QtLocalPeer: Message reception failed %s", socket->errorString().toLatin1().constData());
delete socket;
socket = nullptr;
return;
}
QString message(QString::fromUtf8(uMsg));
@ -211,6 +173,5 @@ void QtLocalPeer::receiveConnection()
socket->waitForBytesWritten(1000);
socket->waitForDisconnected(1000); // make sure client reads ack
delete socket;
socket = nullptr;
Q_EMIT messageReceived(message); //### (might take a long time to return)
emit messageReceived(message); //### (might take a long time to return)
}

View File

@ -0,0 +1,40 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#ifndef QTLOCALPEER_H
#define QTLOCALPEER_H
#include <QLocalServer>
#include <QLocalSocket>
#include <QDir>
#include "qtlockedfile.h"
class QtLocalPeer : public QObject
{
Q_OBJECT
public:
QtLocalPeer(QObject *parent = 0, const QString &appId = QString());
bool isClient();
bool sendMessage(const QString &message, int timeout);
QString applicationId() const
{ return id; }
Q_SIGNALS:
void messageReceived(const QString &message);
protected Q_SLOTS:
void receiveConnection();
protected:
QString id;
QString socketName;
QLocalServer* server;
QtLP_Private::QtLockedFile lockFile;
private:
static const char* ack;
};
#endif // QTLOCALPEER_H

View File

@ -1,42 +1,5 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include "qtlockedfile.h"

View File

@ -0,0 +1,60 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#ifndef QTLOCKEDFILE_H
#define QTLOCKEDFILE_H
#include <QFile>
#ifdef Q_OS_WIN
#include <QVector>
#endif
#if defined(Q_OS_WIN)
# if !defined(QT_QTLOCKEDFILE_EXPORT) && !defined(QT_QTLOCKEDFILE_IMPORT)
# define QT_QTLOCKEDFILE_EXPORT
# elif defined(QT_QTLOCKEDFILE_IMPORT)
# if defined(QT_QTLOCKEDFILE_EXPORT)
# undef QT_QTLOCKEDFILE_EXPORT
# endif
# define QT_QTLOCKEDFILE_EXPORT __declspec(dllimport)
# elif defined(QT_QTLOCKEDFILE_EXPORT)
# undef QT_QTLOCKEDFILE_EXPORT
# define QT_QTLOCKEDFILE_EXPORT __declspec(dllexport)
# endif
#else
# define QT_QTLOCKEDFILE_EXPORT
#endif
namespace QtLP_Private {
class QT_QTLOCKEDFILE_EXPORT QtLockedFile : public QFile
{
public:
enum LockMode { NoLock = 0, ReadLock, WriteLock };
QtLockedFile();
QtLockedFile(const QString &name);
~QtLockedFile();
bool open(OpenMode mode);
bool lock(LockMode mode, bool block = true);
bool unlock();
bool isLocked() const;
LockMode lockMode() const;
private:
#ifdef Q_OS_WIN
Qt::HANDLE wmutex;
Qt::HANDLE rmutex;
QVector<Qt::HANDLE> rmutexes;
QString mutexname;
Qt::HANDLE getMutexHandle(int idx, bool doCreate);
bool waitMutex(Qt::HANDLE mutex, bool doBlock);
#endif
LockMode m_lock_mode;
};
}
#endif

View File

@ -0,0 +1,78 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include "qtlockedfile.h"
bool QtLockedFile::lock(LockMode mode, bool block)
{
if (!isOpen()) {
qWarning("QtLockedFile::lock(): file is not opened");
return false;
}
if (mode == NoLock)
return unlock();
if (mode == m_lock_mode)
return true;
if (m_lock_mode != NoLock)
unlock();
struct flock fl;
fl.l_whence = SEEK_SET;
fl.l_start = 0;
fl.l_len = 0;
fl.l_type = (mode == ReadLock) ? F_RDLCK : F_WRLCK;
int cmd = block ? F_SETLKW : F_SETLK;
int ret = fcntl(handle(), cmd, &fl);
if (ret == -1) {
if (errno != EINTR && errno != EAGAIN)
qWarning("QtLockedFile::lock(): fcntl: %s", strerror(errno));
return false;
}
m_lock_mode = mode;
return true;
}
bool QtLockedFile::unlock()
{
if (!isOpen()) {
qWarning("QtLockedFile::unlock(): file is not opened");
return false;
}
if (!isLocked())
return true;
struct flock fl;
fl.l_whence = SEEK_SET;
fl.l_start = 0;
fl.l_len = 0;
fl.l_type = F_UNLCK;
int ret = fcntl(handle(), F_SETLKW, &fl);
if (ret == -1) {
qWarning("QtLockedFile::lock(): fcntl: %s", strerror(errno));
return false;
}
m_lock_mode = NoLock;
return true;
}
QtLockedFile::~QtLockedFile()
{
if (isOpen())
unlock();
}

View File

@ -1,42 +1,5 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include "qtlockedfile.h"
#include <qt_windows.h>

View File

@ -1,42 +1,5 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include "qtsingleapplication.h"
@ -323,7 +286,7 @@ QWidget* QtSingleApplication::activationWindow() const
void QtSingleApplication::activateWindow()
{
if (actWin) {
//actWin->setWindowState(actWin->windowState() & ~Qt::WindowMinimized);
actWin->setWindowState(actWin->windowState() & ~Qt::WindowMinimized);
actWin->raise();
actWin->activateWindow();
}

View File

@ -1,42 +1,5 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#ifndef QTSINGLEAPPLICATION_H
#define QTSINGLEAPPLICATION_H

View File

@ -1,3 +1,4 @@
include(../common.pri)
INCLUDEPATH += $$PWD
DEPENDPATH += $$PWD
QT *= network

View File

@ -1,42 +1,5 @@
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
** of its contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#include "qtsinglecoreapplication.h"

View File

@ -0,0 +1,34 @@
// Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
// SPDX-License-Identifier: BSD-3-Clause
#ifndef QTSINGLECOREAPPLICATION_H
#define QTSINGLECOREAPPLICATION_H
#include <QCoreApplication>
class QtLocalPeer;
class QtSingleCoreApplication : public QCoreApplication
{
Q_OBJECT
public:
QtSingleCoreApplication(int &argc, char **argv);
QtSingleCoreApplication(const QString &id, int &argc, char **argv);
bool isRunning();
QString id() const;
public Q_SLOTS:
bool sendMessage(const QString &message, int timeout = 5000);
Q_SIGNALS:
void messageReceived(const QString &message);
private:
QtLocalPeer* peer;
};
#endif // QTSINGLECOREAPPLICATION_H

19
CMakeLists.txt Normal file
View File

@ -0,0 +1,19 @@
cmake_minimum_required(VERSION 3.14)
project(ukui-search LANGUAGES C CXX)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
include(GNUInstallDirs)
add_subdirectory(libchinese-segmentation)
add_subdirectory(libsearch)
add_subdirectory(frontend)
add_subdirectory(ukuisearch-systemdbus)
add_subdirectory(search-ukcc-plugin)
add_subdirectory(ukui-search-service)
add_subdirectory(ukui-search-app-data-service)
add_subdirectory(ukui-search-service-dir-manager)
if (BUILD_TEST)
add_subdirectory(tests)
endif ()

102
README.md
View File

@ -3,23 +3,26 @@
[dWIP] UKUI Search is a user-wide desktop search feature of UKUI desktop environment.
## 简介
狭义上的ukui-search指ukui桌面环境中的全局搜索应用目前最新版本为3.22.x.x。全局搜索应用提供了本地文件、文本内容、应用、设置项、便签等聚合搜索功能基于其文件索引功能可以为用户提供快速准确的搜索体验。
狭义上的ukui-search指ukui桌面环境中的全局搜索应用目前最新版本为4.0.x.x。全局搜索应用提供了本地文件、文本内容、应用、设置项、便签等聚合搜索功能基于其文件索引功能可以为用户提供快速准确的搜索体验。
广义的ukui-search除了包括全局搜索应用还包括在ukui桌面环境中的本地搜索服务以及其开发接口。基于文建索引服务应用搜索数据服务等基础数据源服务可以提供基于C++接口的搜索功能应用开发者可以通过引用动态库的形式直接使用其搜索功能。除此之外ukui桌面环境搜索服务还提供了一组基于Qt插件框架的插件接口用户可以通过继承接口以实现搜索功能的扩展。
以下提到的ukui-search如无说明均指后者。
ukui-search 目前被打包成6个包openkylin
ukui-search 目前被打包成9个包openkylin
+ ukui-search_xxxxxx.deb
+ ukui-search-service_xxxx.deb
+ libukui-search-dev_xxxxx.deb
+ libukui-search2_xxxxx.deb
+ libukui-search-common_xxxxx.deb
+ libchinese-segmentation1_xxxx.deb
+ libchinese-segmentation-dev_xxxx.deb
+ libchinese-segmentation-common_xxxx.deb
+ ukui-search-systemdbus_xxxxx.deb
xxx代表版本号。其中ukui-search 为全局搜索应用本体libukui-search包提供了搜索服务基本功能以及扩展接口libukui-search-dev为其开发包。libchinese-segmentation包为搜索服务提供了NLP能力如中文分词等。ukui-search-systemdbus包提供了一些systemdbus提权操作。
xxx代表版本号。其中ukui-search 为全局搜索应用本体,ukui-search-service为搜索数据服务相关进程libukui-search包提供了搜索服务基本功能以及扩展接口libukui-search-dev为其开发包。libchinese-segmentation包为搜索服务提供了NLP能力如中文分词等。ukui-search-systemdbus包提供了一些systemdbus提权操作。
## 运行
搜索服务相关的进程共有5个包括ukui-search(全局搜索GUI界面)ukui-search-service(文件搜索服务)ukui-search-service-dir-manager(文件搜索目录管理), ukui-search-app-data-service(应用数据服务),ukuisearch-systemdbus(systembus)。
搜索服务相关的进程共有5个包括ukui-search(全局搜索GUI界面)ukui-search-service(文件搜索服务)ukui-search-service-dir-manager(文件搜索目录管理模块), ukui-search-app-data-service(应用数据服务),ukuisearch-systemdbus(systembus)。
所有进程默认开机自启。
@ -70,9 +73,16 @@ interface: com.ukui.search.service
搜索的功能有一部分依赖于其他桌面环境组件:
设置项搜索依赖ukui-control-center提供的配置文件,安装路径为
设置项搜索依赖ukui-control-center提供的dbus接口
> /usr/share/ukui-control-center/shell/res/search.xml
```
service:org.ukui.ukcc.session
path:/
interface:org.ukui.ukcc.session.interface
method:getSearchItems () ↦ (Dict of {String, Variant} arg_0)
signal:searchItemsAdd(Dict of{String, Variant})
searchItemsDelete(Dict of{String, Variant})
```
跳转到搜索结果对应的控制面板页面使用了ukui-control-center的命令行
@ -91,7 +101,7 @@ Options:
service: com.kylin.softwarecenter.getsearchresults
path: /com/kylin/softwarecenter/getsearchresults
interface: com.kylin.getsearchresults
get_search_result (String keyword) ↦ (Boolean arg_1)
method:get_search_result (String keyword) ↦ (Boolean arg_1)
```
跳转到软件商店安装页面的使用了以下dbus接口
@ -129,7 +139,7 @@ interface: org.freedesktop.FileManager1
## 原理与功能特点
全局搜索支持控制面板设置项搜索,应用搜索,文件搜索,便签本搜索。支持名称,拼音,或拼音首字母搜索(文本内容搜索和便签本搜索不支持拼音搜索)。其中,设置项搜索通过读取控制面板提供的配置文件实现,打开对应的控制面板页面也依赖与控制面板提供的命令行;应用搜索分为本地已安装应用(包括安卓兼容应用)和软件商店已上架的在线应用,在线应用的搜索和跳转安装通过软件商店提供的接口实现。所以,当怀疑搜索的设置搜索或应用搜索有问题时,可以直接测试控制面板或软件商店对应的接口。
全局搜索支持控制面板设置项搜索,应用搜索,文件搜索,便签本搜索。支持名称,拼音,或拼音首字母搜索(文本内容搜索和便签本搜索不支持拼音搜索)。其中,设置项搜索通过控制面板提供dbus接口获取数据,打开对应的控制面板页面也依赖与控制面板提供的命令行;应用搜索分为本地已安装应用(包括安卓兼容应用)和软件商店已上架的在线应用,在线应用的搜索和跳转安装通过软件商店提供的接口实现。所以,当怀疑搜索的设置搜索或应用搜索有问题时,可以直接测试控制面板或软件商店对应的接口。
文件搜索分为文件名(文件夹名)搜索和文本内容搜索。文件搜索有两种模式:`直接搜索`和`建立索引搜索`。
@ -138,6 +148,7 @@ interface: org.freedesktop.FileManager1
+ 索引搜索:搜索通过遍历文件系统建立数据库(需要消耗一定的时间和资源),搜索时直接对数据库进行搜索,可以实现毫秒级的搜索响应,建立索引的过程中,搜索结果可能不全或者搜不出结果。
首次打开索引时ukui-search-service进程会新建两个数据库分别存储基础索引信息用于文件名搜索和文本内容索引信息用于文本内容搜索完成首次索引后索引服务会依赖inotify机制进行实时监听更新。索引关闭再打开或重启服务时索引服务会对遍历文件并对数据库进行校验以增量更新。
索引数据库会基于文件系统监听进行实时更新。但是由于解析文本需要时间,所以大文件的索引新可能会有短暂的延迟。由于各种意外原因,比如索引更新过程中掉电关机,可能会导致索引损坏,此时搜索在下次开机时会重新建立索引来保证正常的文件搜索功能。基于机器配置和本地文件的数量,大小以及种类,索引重建的时间可以从几秒到数分钟不等。
搜索目录可以在控制面板中手动配置,目前索引已经支持外接设备。
索引搜索支持文本内容搜索,基本原理可以参考 [倒排索引与优麒麟的文件搜索](https://docs.qq.com/doc/DU0p0S1lRelp2aW1y) 。建立索引时,搜索会对常用的文本文件进行解析,提取关键词存入数据库。搜索时,用户输入的文本也会被提取关键词,和数据库中的关键词进行匹配, 所以文本索引并不能保证你搜索一个文本文件里的任意内容都能搜出这个文件这也不是普遍的应用场景。搜索输入的文本中必须要包含【关键词】才可以。比如你搜索一个由于并不是任何文件的关键词所以并不会有搜索到任何文件。事实上我们有一个停用词词库专门用来排除于是等等基本上在每个文档都会出现的一些无用词。目前搜索支持解析的文件格式有docxpptx, xlsx, txt(大部分编码格式), doc, dot, wps, ppt, pps, dps, et, xls, pdfuofuotuosuopofd以上格式均不支持加密文件的解析此外文件索引支持图片ocr提取文字所以你也可以通过图片中的文字搜索到图片就像文档一样支持的图片格式pngbmpgiftiftiffwebpjpejpgjpeg。
> 注意:应用的.desktop文件并不是应用本身或者“快捷方式”对于搜索来说它只是一个文件所以搜索desktop文件的名字并不能搜出这个应用除非它恰好和应用重名。另外在文件搜索中显示的dekstop文件并不会以应用的形式显示而是显示它本来的样子——一个文件。
@ -150,11 +161,13 @@ ukui-search应用和ukui-search-service、ukui-search-app-data-service的配置
文件说明:
+ ukui-search.conf ------------------------------------全局搜索GUI配置文件。
+ ukui-search-block-dirs.conf ---------------------文件搜索黑名单,在控制面板中设置
+ ukui-search-index-status.conf ------------------文件索引服务状态记录
+ index_data ---------------------------------------------文件索引数据库
+ content_index_data ---------------------------------文本内容数据库
+ ukui-search.conf -------------------------------------全局搜索GUI配置文件。
+ ukui-search-plugin-order.conf -------------------搜索插件显示顺序
+ ukui-search-block-dirs.conf ----------------------文件搜索黑名单,在控制面板中设置
+ ukui-search-index-status.conf -------------------文件索引服务状态记录
+ ukui-search-current-indexable-dir.conf -------搜索目录配置文件
+ index_data --------------------------------------------文件索引数据库
+ content_index_data --------------------------------文本内容数据库
## 编译
@ -181,11 +194,11 @@ mkdir build;cd build;qmake ..;make
## 调试
ukui-search目前并未采用ukui-log4qt模块的日志功能。如需调试可在以下目录新建`ukui-search.log`、`ukui-search-service.log`以及`ukui-search-app-data-service.log`文件分别对应全局搜索GUI应用全局搜索文件索引服务和应用数据服务。新建日志文件后日志会自动打印到对应文件中,但目前日志没有自动备份或删除机制。
ukui-search目前并未采用ukui-log4qt模块的日志功能。如需调试可在~/.config/org.ukui/目录新建`ukui-search.log`、`ukui-search-service.log`以及`ukui-search-app-data-service.log`文件分别对应全局搜索GUI应用全局搜索文件索引服务和应用数据服务。新建日志文件后日志会自动打印到对应文件中但目前日志没有自动备份或删除机制。
## 开发接口
### 搜索服务接口(此接口目前处于快速更新,请以代码为准)
### 搜索服务接口(此接口目前快速更新,请以代码为准)
#### Use with CMake:
@ -210,20 +223,33 @@ PKGCONFIG += ukui-search
......
//初始化一个搜索实例
UkuiSearch::UkuiSearchTask ukst;
//初始化需要用到的搜索插件
ukst.initSearchPlugin(UkuiSearch::SearchProperty::SearchType::File);
//初始化队列
UkuiSearch::DataQueue<UkuiSearch::ResultItem> *queue = ukst.init();
//加载想要使用的搜索插件
ukst.initSearchPlugin(UkuiSearch::SearchType::File);
//设置最大结果数量默认为100
ukst.setMaxResultNum(999999);
//添加搜索文件夹
QString path = "/home/usr/下载";
ukst.addSearchDir("path");
//设置需要的信息,将被储存在 UkuiSearch::ResultItem中
ukst.setResultProperties(UkuiSearch::SearchProperty::SearchType::File,
UkuiSearch::SearchResultProperties{UkuiSearch::SearchProperty::FilePath,
UkuiSearch::SearchProperty::FileIconName});
//添加关键词,支持添加多个关键词,用 ‘与’的关系搜索,注意当需要重新添加关键词时需要调用clearKeyWords清空关键词
ukst.addKeyword(searchText);
//添加搜索条件
ukst.setOnlySearchFile(true);
ukst.addKeyword(m_keyword);
//启动搜索(异步)
ukst.startSearch(UkuiSearch::SearchType::File);
//执行搜索,参数表示执行搜索的搜索插件,注意每次搜索之前可以调用‘’
ukst.startSearch(UkuiSearch::SearchProperty::SearchType::File);
//接收结果(示例)
while(true) {
if(!queue->isEmpty()) {
qDebug() << queue->dequeue().getItemKey();
}
while(!queue->isEmpty()) {
auto result = queue->dequeue();
//通过属性取值
qDebug() << result.getValue(UkuiSearch::SearchProperty::FilePath);
//直接获取所有值
UkuiSearch::SearchResultPropertyMap map = result.getAllValue();
qDebug() << map;
}
```
@ -267,24 +293,30 @@ Q_DECLARE_INTERFACE(UkuiSearch::SearchTaskPluginIface, SearchTaskPluginIface_iid
表示加载用户插件
```c++
ukst.initSearchPlugin(UkuiSearch::SearchType::Custom);
ukst.initSearchPlugin(UkuiSearch::SearchType::Custom, "<用户自定义的名称>");
```
启动搜索
```c++
ukst.startSearch(UkuiSearch::SearchType::<用户自定义的名称>);
ukst.startSearch(UkuiSearch::SearchType::Custom, "<用户自定义的名称>";
```
### 搜索应用插件接口
搜索应用本身也提供了一个插件接口,可以通过加载用户实现的插件以实现额外搜索功能:
搜索应用本身也提供了一个插件接口,可以通过加载用户实现的插件以实现额外搜索以及详情页定制功能:
```c++
namespace UkuiSearch {
class SearchPluginIface : public PluginInterface
{
public:
enum InvokableAction
{
None = 1u << 0,
HideUI = 1u << 1
};
Q_DECLARE_FLAGS(InvokableActions, InvokableAction)
struct DescriptionInfo
{
QString key;
@ -305,6 +337,15 @@ public:
QVector<DescriptionInfo> description;
QString actionKey;
int type;
ResultInfo(const QIcon &iconToSet = QIcon(), const QString &nameToSet = QString(),
const QVector<DescriptionInfo> &descriptionToSet = QVector<DescriptionInfo>(),
const QString &actionKeyToSet = QString(), const int &typeToSet = 0) {
icon = iconToSet;
name = nameToSet;
description = descriptionToSet;
actionKey = actionKeyToSet;
type = typeToSet;
}
};
virtual ~SearchPluginIface() {}
@ -313,9 +354,12 @@ public:
virtual void stopSearch() = 0;
virtual QList<Actioninfo> getActioninfo(int type) = 0;
virtual void openAction(int actionkey, QString key, int type) = 0;
// virtual bool isPreviewEnable(QString key, int type) = 0;
// virtual QWidget *previewPage(QString key, int type, QWidget *parent = nullptr) = 0;
virtual QWidget *detailPage(const ResultInfo &ri) = 0;
void invokeActions(InvokableActions actions);
};
}
```
> 接口使用注意事项:

View File

@ -1,10 +1,20 @@
<schemalist gettext-domain="ukui-search">
<schema id="org.ukui.search.settings" path="/org/ukui/ukui-search/settings/">
<key name="version" type="s">
<default>"0.0"</default>
<summary>version of this config</summary>
<description>Version of the config of ukui-search.</description>
</key>
<key name="file-index-enable" type="b">
<default>false</default>
<summary>file index switch</summary>
<description>Enable or disable file index service.</description>
</key>
<key name="content-index-enable" type="b">
<default>false</default>
<summary>file content index switch</summary>
<description>Enable or disable file content index service.</description>
</key>
<key name="web-engine" type="s">
<default>"baidu"</default>
<summary>web engine</summary>

View File

@ -2,12 +2,15 @@
Name=Search
Name[zh_CN]=搜索
Name[bo_CN]=བཤེར་འཚོལ།
Name[mn]=ᠪᠦᠬᠦ ᠲᠠᠯ᠎ᠠ ᠪᠠᠷ ᠬᠠᠢᠬᠤ
GenericName=UKUI Global Search
GenericName[zh_CN]=全局搜索
GenericName[bo_CN]=བཤེར་འཚོལ།
GenericName[mn]=ᠪᠦᠬᠦ ᠲᠠᠯ᠎ᠠ ᠪᠠᠷ ᠡᠷᠢᠨ᠎ᠡ
Comment=ukui-search
Comment[zh_CN]=全局搜索
Comment[bo_CN]=ཁྱོན་ཡོངས་བཤེར་འཚོལ།
Comment[mn]=ᠪᠦᠬᠦ ᠲᠠᠯ᠎ᠠ ᠪᠠᠷ ᠬᠠᠢᠬᠤ
Exec=/usr/bin/ukui-search -s
Type=Application
Icon=kylin-search

6
debian/changelog vendored
View File

@ -1,5 +1,5 @@
ukui-search (3.22.4.2) unstable; urgency=medium
ukui-search (4.0.6.1-1) unstable; urgency=medium
* Initial
* Initial release. (Closes: #1234567)
-- MouseZhang <sendbypython@foxmail.com> Fri, 10 Feb 2023 11:26:15 +0800
-- xibowen <xibowen@kylinos.cn> Sun, 23 Jul 2023 22:52:54 -0400

126
debian/control vendored
View File

@ -1,96 +1,108 @@
Source: ukui-search
Section: utils
Priority: optional
Maintainer: Kylin Team <team+kylin@tracker.debian.org>
Uploaders: MouseZhang <sendbypython@foxmail.com>
Build-Depends: debhelper-compat (=13),
pkgconf,
libgsettings-qt-dev,
qtbase5-dev,
qt5-qmake,
qtchooser,
qtscript5-dev,
qttools5-dev-tools,
libxapian-dev,
libquazip5-dev(>=0.7.6-6build1),
Maintainer: zhangpengfei <zhangpengfei@kylinos.cn>
Uploaders: xibowen <xibowen@kylinos.cn>, Mouse Zhang <sendbypython@foxmail.com>
Build-Depends: cmake,
debhelper-compat (=13),
libglib2.0-dev,
libgsettings-qt-dev,
libkf5windowsystem-dev,
libqt5x11extras5-dev,
libuchardet-dev,
libkysdk-applications-dev,
libleptonica-dev,
libpoppler-qt5-dev,
libukui-log4qt-dev,
libqt5x11extras5-dev,
libqt5xdg-dev,
libukcc-dev,
libopencv-dev,
libquazip5-dev(>=0.7.6-6build1),
libtesseract-dev,
libkysdk-waylandhelper-dev,
libkysdk-qtwidgets-dev,
libuchardet-dev,
libukcc-dev,
libukui-appwidget-manager-dev,
libukui-appwidget-provider-dev,
libukui-appwidget-qmlplugin0,
qml-module-org-ukui-stylehelper,
qtdeclarative5-dev
libukui-log4qt-dev,
libxapian-dev,
pkgconf,
qt5-qmake,
qtbase5-dev,
qtchooser,
qtdeclarative5-dev,
qtscript5-dev,
qttools5-dev
Standards-Version: 4.6.1.0
Rules-Requires-Root: no
Homepage: https://www.ukui.org/
Homepage: https://gitee.com/openkylin/ukui-search
Vcs-Git: https://gitee.com/openkylin/ukui-search.git
Vcs-Browser: https://gitee.com/openkylin/ukui-search
Package: ukui-search
Architecture: any
Depends: ${misc:Depends},
${shlibs:Depends},
libukui-search2 (= ${binary:Version}),
Description: User-wide desktop search feature of UKUI desktop environment
Gui application that provides file search,
application search,settings search functions,
and so on.
Depends: libukui-search2 (= ${binary:Version}),
ukui-search-service (= ${binary:Version}),
${misc:Depends},
${shlibs:Depends}
Description: User-wide desktop search of ukui
feature of UKUI desktop environment.
Package: ukui-search-service
Architecture: any
Depends: ${misc:Depends}, ${shlibs:Depends}
Description: Data service for search function in UKUI desktop environment.
Package: libchinese-segmentation1
Section: libs
Architecture: any
Depends: ${misc:Depends},
Depends: libchinese-segmentation-common (= ${source:Version}),
${misc:Depends},
${shlibs:Depends}
Description: Libraries for chinese-segmentation
This package contains a few runtime libraries needed by
libsearch.
.
This package contains a runtime library needed by
ukui-search's file index function.
Package: libchinese-segmentation-common
Architecture: all
Depends: ${misc:Depends}
Description: Extra files for chinese-segmentation
.
This package contains dicts used by chinese-segmentation.
Package: libchinese-segmentation-dev
Section: libdevel
Architecture: any
Depends: ${misc:Depends},
${shlibs:Depends},
libchinese-segmentation1 (= ${binary:Version}),
Description: Libraries for chinese-segmentation(development files)
This package contains NLP functions used by ukui-search.
Depends: libchinese-segmentation1 (= ${binary:Version}), ${misc:Depends}
Description: Libraries for chinese-segmentation(development files).
Package: libukui-search2
Section: libs
Architecture: any
Depends: ${misc:Depends},
${shlibs:Depends},
libchinese-segmentation1 (= ${binary:Version}),
ukui-search-systemdbus (= ${binary:Version})
Provides: libukui-search,
Description: Libraries for ukui-search
This package provides libraries for ukui-search,
and contains some binarys for search function implement,
Which are ukui-search-service,ukui-search-app-data-service
and ukui-search-service-dir-manager.
Depends: libchinese-segmentation1 (= ${binary:Version}),
libukui-search-common (= ${source:Version}),
ukui-search-systemdbus (= ${binary:Version}),
${misc:Depends},
${shlibs:Depends}
Provides: libukui-search
Description: Libraries for ukui-search.
.
This package contains a runtime library needed by
ukui-search and it's extensions.
Package: libukui-search-common
Architecture: all
Depends: ${misc:Depends}
Description: Extra files for libukui-search
.
This package contains some extra files for libukui-search,
for now, translation files only.
Package: libukui-search-dev
Section: libdevel
Architecture: any
Depends: ${misc:Depends},
${shlibs:Depends},
libukui-search2 (= ${binary:Version}),
Description: Libraries for ukui-search(development files)
This package can be used to implement a gui application.
Depends: libukui-search2 (= ${binary:Version}), ${misc:Depends}
Description: Libraries for ukui-search(development files).
Package: ukui-search-systemdbus
Architecture: any
Depends: ${shlibs:Depends},
${misc:Depends},
Description: Systembus interface to modify max_user_watches nums permanent
This package contains functions used when ukui-search want to
modify some system settings.
Depends: ${misc:Depends}, ${shlibs:Depends}
Description: Systembus interface to modify max_user_watches nums
permanent.

233
debian/copyright vendored
View File

@ -1,237 +1,42 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: ukui-search
Upstream-Contact: zhangpengfei <zhangpengfei@kylinos.cn>
Source: <https://gitee.com/openkylin/ukui-search>
Files: *
Copyright: 2020, KylinSoft Co., Ltd.
Copyright: 2020-2023, KylinSoft Co., Ltd.
License: GPL-3+
Files: 3rd-parties/*
Copyright: 2020, KylinSoft Co., Ltd.
2015-2018, Itay Grudev
License: Expat
Files: 3rd-parties/SingleApplication/CHANGELOG.md
3rd-parties/SingleApplication/Windows.md
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: 3rd-parties/SingleApplication/README.md
Copyright: 2020, KylinSoft Co., Ltd.
License: Expat
Files: 3rd-parties/SingleApplication/singleapplication.cpp
3rd-parties/SingleApplication/singleapplication.h
3rd-parties/SingleApplication/singleapplication_p.cpp
3rd-parties/SingleApplication/singleapplication_p.h
Copyright: 2015-2018, Itay Grudev
License: Expat
Files: 3rd-parties/qtsingleapplication/*
Copyright: 2013, Digia Plc and/or its subsidiary(-ies).
License: BSD-3-clause
Files: 3rd-parties/qtsingleapplication/QtLockedFile
3rd-parties/qtsingleapplication/QtSingleApplication
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: frontend/*
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
License: UNKNOWN
Please fill license UNKNOWN from header of 3rd-parties/*
Files: frontend/control/flow-layout/*
Copyright: 2019, Tianjin KYLIN Information Technology Co., Ltd.
License: GPL-2+
Files: frontend/model/best-list-model.h
frontend/model/web-search-model.h
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: frontend/ukui-search-dbus-service.cpp
frontend/ukui-search-dbus-service.h
frontend/ukui-search-gui.cpp
frontend/ukui-search-gui.h
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: frontend/view/*
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: frontend/view/result-view-delegate.h
frontend/view/web-search-view.cpp
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/*
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/chinese-segmentation-private.h
libchinese-segmentation/common-struct.h
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/cppjieba/*
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/cppjieba/idf-trie/*
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/cppjieba/limonp/Md5.hpp
Files: libchinese-segmentation/cppjieba/limonp/*
Copyright: 1991, 1992, RSA Data Security, Inc. Created 1991
License: NTP
Files: libchinese-segmentation/cppjieba/segment-trie/*
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/development-files/*
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/dict/*
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Please fill license NTP from header of libchinese-segmentation/cppjieba/limonp/*
Files: libchinese-segmentation/storage-base/cedar/*
Copyright: 2009-2015, Naoki Yoshinaga <ynaga@tkl.iis.u-tokyo.ac.jp>
License: GPL-3+
Files: libchinese-segmentation/storage-base/darts-clone/*
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: libchinese-segmentation/test/*
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: libsearch/appsearch/app-match.cpp
libsearch/appsearch/app-match.h
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libsearch/file-utils.cpp
libsearch/file-utils.h
libsearch/global-settings.cpp
libsearch/global-settings.h
libsearch/gobject-template.cpp
libsearch/gobject-template.h
libsearch/libsearch.cpp
libsearch/libsearch.h
libsearch/libsearch_global.h
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libsearch/filesystemwatcher/*
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libsearch/index/*
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: libsearch/index/compatible-define.h
libsearch/index/data-queue.cpp
libsearch/index/data-queue.h
libsearch/index/database.cpp
libsearch/index/database.h
libsearch/index/ocrobject.cpp
libsearch/index/ocrobject.h
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: libsearch/plugininterface/action-label.cpp
libsearch/plugininterface/action-label.h
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
License: UNKNOWN
Please fill license UNKNOWN from header of libchinese-segmentation/storage-base/cedar/*
Files: ukui-search-app-data-service/convert-winid-to-desktop.cpp
ukui-search-app-data-service/convert-winid-to-desktop.h
Copyright: 2019, Tianjin KYLIN Information Technology Co., Ltd.
License: GPL-3+
Files: ukui-search-service-dir-manager/dirwatcher/dir-watcher-adaptor.cpp
ukui-search-service-dir-manager/dirwatcher/dir-watcher-adaptor.h
Copyright: 2020, The Qt Company Ltd.
License: GPL-3+
Files: ukui-search-service-dir-manager/main.cpp
Copyright: 2019, Tianjin KYLIN Information Technology Co., Ltd.
License: GPL-2+
Files: ukui-search-service/*
Copyright: 2020-2022, KylinSoft Co., Ltd.
License: GPL-3+
Files: ukui-search-service/ukui-search-service.h
Copyright: 2020, KylinSoft Co., Ltd.
License: GPL-3+
Files: ukuisearch-systemdbus/*
Copyright: 2019, Tianjin KYLIN Information Technology Co., Ltd.
License: GPL-2+
License: BSD-3-clause
This software is Copyright (c) 2021 by foo.
This is free software, licensed under:
The (three-clause) BSD License
The BSD License
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of foo nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License: Expat
The MIT License
.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to
whom the Software is furnished to do so, subject to the
following conditions:
.
The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the
Software.
.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
License: GPL-2+
This software is Copyright (c) 2021 by foo.
This software is Copyright (c) 2024 by foo.
This is free software, licensed under:
The GNU General Public License, Version 2, June 1991
This program is free software; you can redistribute it and/or modify
@ -242,7 +47,7 @@ License: GPL-2+
Public License can be found in '/usr/share/common-licenses/GPL-2'.
License: GPL-3+
This software is Copyright (c) 2021 by foo.
This software is Copyright (c) 2024 by foo.
This is free software, licensed under:
The GNU General Public License, Version 3, June 2007
This program is free software; you can redistribute it and/or modify
@ -251,17 +56,3 @@ License: GPL-3+
your option) any later version.
On Debian systems, the complete text of version 3 of the GNU General
Public License can be found in '/usr/share/common-licenses/GPL-3'.
License: NTP
Copyright (c) (CopyrightHoldersName) (From 4-digit-year)-(To 4-digit-year)
Permission to use, copy, modify, and distribute this software and
its documentation for any purpose with or without fee is hereby
granted, provided that the above copyright notice appears in all
copies and that both the copyright notice and this permission
notice appear in supporting documentation, and that the name
(TrademarkedName) not be used in advertising or publicity
pertaining to distribution of the software without specific,
written prior permission. (TrademarkedName) makes no
representations about the suitability this software for any
purpose. It is provided “as is” without express or implied
warranty.

View File

@ -0,0 +1,2 @@
/usr/share/chinese-segmentation/res/dict/*.txt
/usr/share/chinese-segmentation/res/dict/*.utf8

View File

@ -1,3 +1,4 @@
usr/include/chinese-seg/*
usr/lib/*/pkgconfig/chinese-segmentation.pc
/usr/share/cmake/chinese-segmentation/*.cmake
usr/include/chinese-segmentation/*
usr/lib/*/libchinese-segmentation.so
usr/lib/*/pkgconfig/chinese-segmentation.pc

View File

@ -1,3 +1 @@
usr/lib/*/libchinese-segmentation.so.*
/usr/share/ukui-search/res/dict/*.utf8
/usr/share/ukui-search/res/dict/*.txt

1
debian/libukui-search-common.install vendored Normal file
View File

@ -0,0 +1 @@
usr/share/ukui-search/translations/libukui-search

View File

@ -1,3 +1,4 @@
usr/include/ukui-search/*
usr/lib/*/pkgconfig/ukui-search.pc
usr/lib/*/libukui-search.so
usr/lib/*/pkgconfig/ukui-search.pc
usr/share/cmake/ukui-search/*.cmake

View File

@ -1,11 +1 @@
usr/lib/*/libukui-search.so.*
usr/bin/ukui-search-service
usr/bin/ukui-search-app-data-service
usr/bin/ukui-search-service-dir-manager
etc/xdg/autostart/ukui-search-service-dir-manager.desktop
etc/xdg/autostart/ukui-search-app-data-service.desktop
etc/xdg/autostart/ukui-search-service.desktop
usr/share/dbus-1/services/com.ukui.search.appdb.service
usr/share/dbus-1/services/com.ukui.search.fileindex.service
usr/share/glib-2.0/schemas/org.ukui.search.data.gschema.xml
libsearch/.qm/*.qm usr/share/ukui-search/translations

1
debian/rules vendored
View File

@ -1,4 +1,5 @@
#!/usr/bin/make -f
export QT_SELECT=5
export DEB_BUILD_MAINT_OPTIONS = hardening=+all
%:

View File

@ -1 +1 @@
3.0 (native)
3.0 (quilt)

9
debian/ukui-search-service.install vendored Normal file
View File

@ -0,0 +1,9 @@
etc/xdg/autostart/ukui-search-app-data-service.desktop
etc/xdg/autostart/ukui-search-service-dir-manager.desktop
etc/xdg/autostart/ukui-search-service.desktop
usr/bin/ukui-search-app-data-service
usr/bin/ukui-search-service
usr/bin/ukui-search-service-dir-manager
usr/share/dbus-1/services/com.ukui.search.appdb.service
usr/share/dbus-1/services/com.ukui.search.fileindex.service
usr/share/glib-2.0/schemas/org.ukui.search.data.gschema.xml

View File

@ -1,3 +1,3 @@
/usr/bin/ukui-search-systemdbus
/usr/share/dbus-1/system-services/com.ukui.search.qt.systemdbus.service
/usr/share/dbus-1/system.d/com.ukui.search.qt.systemdbus.conf
/usr/bin/ukui-search-systemdbus

View File

@ -1,12 +1,10 @@
usr/bin/ukui-search
etc/xdg/autostart/ukui-search.desktop
usr/share/applications/ukui-search-menu.desktop
frontend/.qm/*.qm usr/share/ukui-search/translations
usr/share/glib-2.0/schemas/org.ukui.log4qt.ukui-search.gschema.xml
usr/bin/ukui-search
usr/lib/*/ukui-control-center/*
usr/share/ukui-search/search-ukcc-plugin/translations/*
search-ukcc-plugin/.qm/*.qm usr/share/ukui-search/search-ukcc-plugin/translations
usr/share/ukui-search/search-ukcc-plugin/image/*
usr/share/applications/ukui-search-menu.desktop
usr/share/appwidget/*
usr/share/dbus-1/services/org.ukui.appwidget.provider.search.service
/usr/share/appwidget/*
usr/share/glib-2.0/schemas/org.ukui.log4qt.ukui-search.gschema.xml
usr/share/ukui-search/search-ukcc-plugin/image/*
usr/share/ukui-search/search-ukcc-plugin/translations/*
usr/share/ukui-search/translations/ukui-search

132
frontend/CMakeLists.txt Normal file
View File

@ -0,0 +1,132 @@
cmake_minimum_required(VERSION 3.14)
project(ukui-search VERSION 1.0 LANGUAGES C CXX)
set(VERSION_MAJOR 2)
set(VERSION_MINOR 2)
set(VERSION_MICRO 3)
set(UKUI_SEARCH_VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_MICRO})
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
find_package(QT NAMES Qt6 Qt5 COMPONENTS Core DBus Widgets Xml Concurrent Sql LinguistTools X11Extras REQUIRED)
find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Core DBus Widgets Xml Concurrent Sql LinguistTools X11Extras REQUIRED)
find_package(PkgConfig REQUIRED)
find_package(KF5WindowSystem)
set(UKUI_SEARCH_EXTERNAL_LIBS "")
set(UKUI_SEARCH_PC_PKGS gio-2.0 glib-2.0 gio-unix-2.0 kysdk-waylandhelper xapian-core gsettings-qt)
foreach(PC_LIB IN ITEMS ${UKUI_SEARCH_PC_PKGS})
pkg_check_modules(${PC_LIB} REQUIRED IMPORTED_TARGET ${PC_LIB})
if(${${PC_LIB}_FOUND})
include_directories(${${PC_LIB}_INCLUDE_DIRS})
link_directories(${${PC_LIB}_LIBRARY_DIRS})
list(APPEND UKUI_NOTIFICATION_EXTERNAL_LIBS PkgConfig::${PC_LIB})
endif()
endforeach()
add_subdirectory(../3rd-parties/qtsingleapplication ${CMAKE_CURRENT_SOURCE_DIR})
set(UKUI_SEARCH_SRC
control/create-index-ask-dialog.cpp control/create-index-ask-dialog.h
control/list-labels/show-more-label.cpp control/list-labels/show-more-label.h
control/list-labels/title-label.cpp control/list-labels/title-label.h
control/search-line-edit.cpp control/search-line-edit.h
control/stack-pages/search-page-section.cpp control/stack-pages/search-page-section.h
control/stack-pages/search-result-page.cpp control/stack-pages/search-result-page.h
main.cpp
mainwindow.cpp mainwindow.h
model/best-list-model.cpp model/best-list-model.h
model/search-result-manager.cpp model/search-result-manager.h
model/search-result-model.cpp model/search-result-model.h
search-app-widget-plugin/search.cpp search-app-widget-plugin/search.h
ukui-search-dbus-service.cpp ukui-search-dbus-service.h
ukui-search-gui.cpp ukui-search-gui.h
view/best-list-view.cpp view/best-list-view.h
view/result-view.cpp view/result-view.h
view/result-view-delegate.cpp view/result-view-delegate.h
)
if(COMMAND qt_add_dbus_adaptor)
qt_add_dbus_adaptor(UKUI_SEARCH_SRC org.ukui.search.service.xml ukui-search-dbus-service.h UkuiSearch::UkuiSearchDbusServices)
qt_add_dbus_interface(UKUI_SEARCH_SRC org.ukui.search.service.xml service_interface)
else()
qt5_add_dbus_adaptor(UKUI_SEARCH_SRC org.ukui.search.service.xml ukui-search-dbus-service.h UkuiSearch::UkuiSearchDbusServices)
qt5_add_dbus_interface(UKUI_SEARCH_SRC org.ukui.search.service.xml service_interface)
endif()
set(QRC_FILES resource.qrc)
file(GLOB UKUI_SEARCH_TS_FILES ${CMAKE_CURRENT_SOURCE_DIR}/../translations/ukui-search/*.ts)
set_source_files_properties(${UKUI_SEARCH_TS_FILES} PROPERTIES OUTPUT_LOCATION ${CMAKE_BINARY_DIR}/frontend/.qm)
qt5_create_translation(UKUI_SEARCH_QM_FILES ${CMAKE_CURRENT_SOURCE_DIR} ${UKUI_SEARCH_TS_FILES})
file(GLOB UKUI_SEARCH_APP_WIDGET_TS_FILES ${CMAKE_CURRENT_SOURCE_DIR}/../translations/ukui-search/appwidget/*.ts)
set_source_files_properties(${UKUI_SEARCH_APP_WIDGET_TS_FILES} PROPERTIES OUTPUT_LOCATION ${CMAKE_BINARY_DIR}/frontend/.qm)
qt5_create_translation(UKUI_SEARCH_APP_WIDGET_QM_FILES ${PROJECT_SOURCE_DIR} ${UKUI_SEARCH_APP_WIDGET_TS_FILES})
add_executable(ukui-search
${UKUI_SEARCH_SRC}
${QRC_FILES}
${UKUI_SEARCH_QM_FILES}
${UKUI_SEARCH_APP_WIDGET_QM_FILES})
set(UKUI_SEARCH_QM_INSTALL_PATH /usr/share/ukui-search/translations/ukui-search)
target_compile_definitions(ukui-search PRIVATE
VERSION="${UKUI_SEARCH_VERSION}"
UKUI_SEARCH_QM_INSTALL_PATH="${UKUI_SEARCH_QM_INSTALL_PATH}"
)
target_link_libraries(ukui-search PRIVATE
KF5::WindowSystem
Qt${QT_VERSION_MAJOR}::Core
Qt${QT_VERSION_MAJOR}::DBus
Qt${QT_VERSION_MAJOR}::Gui
Qt${QT_VERSION_MAJOR}::Widgets
Qt${QT_VERSION_MAJOR}::X11Extras
gsettings-qt
ukui-appwidget-manager
ukui-appwidget-provider
libukui-search
chinese-segmentation
kysdk-waylandhelper
qtsingleapplication
)
target_include_directories(ukui-search PRIVATE
../3rd-parties/qtsingleapplication/src
../libchinese-segmentation
../libsearch
../libsearch/pluginmanage
../libsearch/plugininterface
../libsearch/searchinterface
control
control/list-labels
control/stack-pages
model
search-app-widget-plugin
view
xatom
)
set(APP_WIDGET_FILES_PRE
search-app-widget-plugin/provider
)
#
install(FILES ${APP_WIDGET_FILES_PRE}/data/search.conf DESTINATION /usr/share/appwidget/config/)
install(FILES ${APP_WIDGET_FILES_PRE}/org.ukui.appwidget.provider.search.service DESTINATION /usr/share/dbus-1/services/)
install(FILES
${APP_WIDGET_FILES_PRE}/data/search.png
${APP_WIDGET_FILES_PRE}/data/ukui-search.svg
DESTINATION /usr/share/appwidget/search/)
install(FILES ${APP_WIDGET_FILES_PRE}/data/search.qml DESTINATION /usr/share/appwidget/qml/)
install(FILES ${UKUI_SEARCH_APP_WIDGET_QM_FILES} DESTINATION /usr/share/appwidget/translations/)
#
install(TARGETS ukui-search RUNTIME DESTINATION /usr/bin)
#
install(FILES ${UKUI_SEARCH_QM_FILES} DESTINATION ${UKUI_SEARCH_QM_INSTALL_PATH})
#desktop
install(FILES ../data/ukui-search-menu.desktop DESTINATION /usr/share/applications)
install(FILES ../data/ukui-search.desktop DESTINATION /etc/xdg/autostart)
#gsettings
install(FILES ../data/org.ukui.log4qt.ukui-search.gschema.xml DESTINATION /usr/share/glib-2.0/schemas/)

View File

@ -1,14 +0,0 @@
include(stack-pages/stack-pages.pri)
include(list-labels/list-labels.pri)
INCLUDEPATH += $$PWD
HEADERS += \
$$PWD/search-line-edit.h \
# $$PWD/settings-widget.h \
$$PWD/create-index-ask-dialog.h \
SOURCES += \
$$PWD/search-line-edit.cpp \
# $$PWD/settings-widget.cpp \
$$PWD/create-index-ask-dialog.cpp \

View File

@ -22,6 +22,7 @@
#include "create-index-ask-dialog.h"
#include <QPainterPath>
#include <KWindowSystem>
#include "icon-loader.h"
#define MAIN_SIZE QSize(380, 202)
#define MAIN_SPACING 0
@ -61,19 +62,20 @@ void CreateIndexAskDialog::initUi() {
m_titleFrame->setLayout(m_titleLyt);
m_iconLabel = new QLabel(m_titleFrame);
m_iconLabel->setFixedSize(ICON_SIZE);
m_iconLabel->setPixmap(QIcon::fromTheme("kylin-search").pixmap(QSize(24, 24)));
m_iconLabel->setPixmap(IconLoader::loadIconQt("kylin-search").pixmap(QSize(24, 24)));
//主题改变时,更新自定义标题栏的图标
connect(qApp, &QApplication::paletteChanged, this, [ = ]() {
m_iconLabel->setPixmap(QIcon::fromTheme("kylin-search").pixmap(QSize(24, 24)));
m_iconLabel->setPixmap(IconLoader::loadIconQt("kylin-search").pixmap(QSize(24, 24)));
});
m_titleLabel = new QLabel(m_titleFrame);
m_titleLabel->setText(tr("Search"));
m_closeBtn = new QPushButton(m_titleFrame);
m_closeBtn->setFixedSize(CLOSE_BTN_SIZE);
m_closeBtn->setIcon(QIcon::fromTheme("window-close-symbolic"));
m_closeBtn->setIcon(IconLoader::loadIconQt("window-close-symbolic"));
m_closeBtn->setProperty("isWindowButton", 0x02);
m_closeBtn->setProperty("useIconHighlightEffect", 0x08);
m_closeBtn->setFlat(true);
m_closeBtn->setToolTip(tr("close"));
connect(m_closeBtn, &QPushButton::clicked, this, [ = ]() {
this->hide();
});
@ -91,7 +93,7 @@ void CreateIndexAskDialog::initUi() {
m_contentLyt->setContentsMargins(CONTENT_MARGINS);
m_tipLabel = new QLabel(m_contentFrame);
m_tipLabel->setText(tr("Creating index can help you getting results quickly, whether to create or not?"));
m_tipLabel->setText(tr("Creating index can help you get results more quickly. Would you like to create one?"));
m_tipLabel->setWordWrap(true);
m_tipLabel->setAlignment(Qt::AlignVCenter);
m_tipLabel->setMinimumHeight(TIP_LABEL_HEIGHT);

View File

@ -1,5 +0,0 @@
SOURCES += \
$$PWD/flow-layout.cpp \
HEADERS += \
$$PWD/flow-layout.h \

View File

@ -1,9 +0,0 @@
INCLUDEPATH += $$PWD
HEADERS += \
$$PWD/show-more-label.h \
$$PWD/title-label.h
SOURCES += \
$$PWD/show-more-label.cpp \
$$PWD/title-label.cpp

View File

@ -19,6 +19,7 @@
*
*/
#include "show-more-label.h"
#include "icon-loader.h"
#include <QEvent>
#include <QDebug>
#include <QIcon>
@ -30,13 +31,13 @@ ShowMoreLabel::ShowMoreLabel(QWidget *parent) : QWidget(parent) {
void ShowMoreLabel::resetLabel() {
m_isOpen = false;
m_iconLabel->setPixmap(QIcon::fromTheme("ukui-down-symbolic", QIcon(":/res/icons/ukui-down-symbolic.svg")).pixmap(QSize(16, 16)));
m_iconLabel->setPixmap(IconLoader::loadIconQt("ukui-down-symbolic", QIcon(":/res/icons/ukui-down-symbolic.svg")).pixmap(QSize(16, 16)));
}
void ShowMoreLabel::setLabel()
{
m_isOpen = true;
m_iconLabel->setPixmap(QIcon::fromTheme("ukui-up-symbolic", QIcon(":/res/icons/ukui-up-symbolic.svg")).pixmap(QSize(16, 16)));
m_iconLabel->setPixmap(IconLoader::loadIconQt("ukui-up-symbolic", QIcon(":/res/icons/ukui-up-symbolic.svg")).pixmap(QSize(16, 16)));
}
/**
@ -53,7 +54,7 @@ void ShowMoreLabel::initUi() {
m_layout = new QHBoxLayout(this);
m_layout->setContentsMargins(0, 0, 0, 6);
m_iconLabel = new QLabel(this);
m_iconLabel->setPixmap(QIcon::fromTheme("ukui-down-symbolic", QIcon(":/res/icons/ukui-down-symbolic.svg")).pixmap(QSize(16, 16)));
m_iconLabel->setPixmap(IconLoader::loadIconQt("ukui-down-symbolic", QIcon(":/res/icons/ukui-down-symbolic.svg")).pixmap(QSize(16, 16)));
m_iconLabel->setCursor(QCursor(Qt::PointingHandCursor));
m_iconLabel->installEventFilter(this);
// m_loadingIconLabel = new QLabel(this); //使用图片显示加载状态时取消此label的注释
@ -63,7 +64,7 @@ void ShowMoreLabel::initUi() {
m_layout->addWidget(m_iconLabel);
m_iconLabel->setPalette(pal);
m_iconLabel->setCursor(QCursor(Qt::PointingHandCursor));
m_iconLabel->setProperty("useIconHighlightEffect", 0x08);
m_iconLabel->setProperty("useIconHighlightEffect", 0x02);
m_iconLabel->setProperty("iconHighlightEffectMode", 1);
// m_layout->addWidget(m_loadingIconLabel);
}
@ -73,11 +74,11 @@ bool ShowMoreLabel::eventFilter(QObject *watched, QEvent *event) {
if(event->type() == QEvent::MouseButtonPress) {
if(! m_timer->isActive()) {
if(!m_isOpen) {
m_iconLabel->setPixmap(QIcon::fromTheme("ukui-up-symbolic", QIcon(":/res/icons/ukui-up-symbolic.svg")).pixmap(QSize(16, 16)));
m_iconLabel->setPixmap(IconLoader::loadIconQt("ukui-up-symbolic", QIcon(":/res/icons/ukui-up-symbolic.svg")).pixmap(QSize(16, 16)));
m_isOpen = true;
Q_EMIT this->showMoreClicked();
} else {
m_iconLabel->setPixmap(QIcon::fromTheme("ukui-down-symbolic", QIcon(":/res/icons/ukui-down-symbolic.svg")).pixmap(QSize(16, 16)));
m_iconLabel->setPixmap(IconLoader::loadIconQt("ukui-down-symbolic", QIcon(":/res/icons/ukui-down-symbolic.svg")).pixmap(QSize(16, 16)));
m_isOpen = false;
Q_EMIT this->retractClicked();
}

View File

@ -19,7 +19,9 @@
*
*/
#include "search-line-edit.h"
#include "icon-loader.h"
#include <KWindowEffects>
#include <QApplication>
#include <QPainterPath>
QT_BEGIN_NAMESPACE
@ -38,13 +40,8 @@ SearchLineEdit::SearchLineEdit(QWidget *parent) : QLineEdit(parent) {
this->setDragEnabled(true);
m_queryIcon = new QLabel;
QPixmap pixmap;
if (!QIcon::fromTheme("system-search-symbolic").isNull()) {
pixmap = QPixmap(QIcon::fromTheme("system-search-symbolic").pixmap(QSize(18, 18)));
} else {
pixmap = QPixmap(QIcon(":/res/icons/system-search.symbolic.png").pixmap(QSize(18, 18)));
}
m_queryIcon->setProperty("useIconHighlightEffect", 0x10);
QPixmap pixmap = QPixmap(IconLoader::loadIconQt("system-search-symbolic", QIcon(":/res/icons/system-search.symbolic.png")).pixmap(QSize(18, 18)));
m_queryIcon->setProperty("useIconHighlightEffect", 0x02);
m_queryIcon->setFixedSize(pixmap.size() / pixmap.devicePixelRatio());
m_queryIcon->setPixmap(pixmap);
@ -91,7 +88,7 @@ void SearchLineEdit::paintEvent(QPaintEvent *e)
QPainter p(this);
p.setRenderHint(QPainter::Antialiasing); // 反锯齿;
p.setBrush(palette().base());
p.setOpacity(GlobalSettings::getInstance()->getValue(TRANSPARENCY_KEY).toDouble());
p.setOpacity(GlobalSettings::getInstance().getValue(TRANSPARENCY_KEY).toDouble());
p.setPen(Qt::NoPen);
p.drawRoundedRect(this->rect(), 12, 12);
return QLineEdit::paintEvent(e);
@ -99,6 +96,7 @@ void SearchLineEdit::paintEvent(QPaintEvent *e)
void SearchLineEdit::focusOutEvent(QFocusEvent *e)
{
Q_UNUSED(e)
this->setFocus();
}

View File

@ -1,594 +0,0 @@
/*
*
* Copyright (C) 2020, KylinSoft Co., Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* Authors: zhangjiaping <zhangjiaping@kylinos.cn>
*
*/
#include "settings-widget.h"
#include <QPainter>
#include <QPainterPath>
#include <QFileDialog>
#include <QDir>
#include <QDebug>
#include <QMessageBox>
#include "global-settings.h"
#include "file-utils.h"
using namespace UkuiSearch;
extern void qt_blurImage(QImage &blurImage, qreal radius, bool quality, int transposed);
SettingsWidget::SettingsWidget(QWidget *parent) : QWidget(parent) {
// this->setWindowIcon(QIcon::fromTheme("kylin-search"));
this->setWindowTitle(tr("ukui-search-settings"));
// this->setWindowFlags(Qt::CustomizeWindowHint | Qt::FramelessWindowHint);
// this->setAttribute(Qt::WA_TranslucentBackground);
#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0))
m_hints.flags = MWM_HINTS_FUNCTIONS | MWM_HINTS_DECORATIONS;
m_hints.functions = MWM_FUNC_ALL;
m_hints.decorations = MWM_DECOR_BORDER;
XAtomHelper::getInstance()->setWindowMotifHint(winId(), m_hints);
#endif
initUi();
refreshIndexState();
setupBlackList(GlobalSettings::getInstance()->getBlockDirs());
resetWebEngine();
}
SettingsWidget::~SettingsWidget() {
}
/**
* @brief SettingsWidget::initUi UI
*/
void SettingsWidget::initUi() {
QPalette pal = palette();
pal.setColor(QPalette::Window, QColor(0, 0, 0, 0));
// this->setFixedWidth(528);
// this->setMinimumHeight(460);
// this->setMaximumHeight(680);
m_mainLyt = new QVBoxLayout(this);
m_mainLyt->setContentsMargins(16, 8, 16, 24);
this->setLayout(m_mainLyt);
//标题栏
m_titleFrame = new QFrame(this);
m_titleFrame->setFixedHeight(40);
m_titleLyt = new QHBoxLayout(m_titleFrame);
m_titleLyt->setContentsMargins(0, 0, 0, 0);
m_titleFrame->setLayout(m_titleLyt);
m_titleIcon = new QLabel(m_titleFrame);
m_titleIcon->setPixmap(QIcon::fromTheme("kylin-search").pixmap(QSize(24, 24)));
//主题改变时,更新自定义标题栏的图标
connect(qApp, &QApplication::paletteChanged, this, [ = ]() {
m_titleIcon->setPixmap(QIcon::fromTheme("kylin-search").pixmap(QSize(24, 24)));
});
m_titleLabel = new QLabel(m_titleFrame);
m_titleLabel->setText(tr("Search"));
m_closeBtn = new QPushButton(m_titleFrame);
m_closeBtn->setFixedSize(24, 24);
// m_closeBtn->setIcon(QIcon(":/res/icons/close.svg"));
m_closeBtn->setIcon(QIcon::fromTheme("window-close-symbolic"));
m_closeBtn->setProperty("isWindowButton", 0x02);
m_closeBtn->setProperty("useIconHighlightEffect", 0x08);
m_closeBtn->setFlat(true);
connect(m_closeBtn, &QPushButton::clicked, this, [ = ]() {
Q_EMIT this->settingWidgetClosed();
m_timer->stop();
this->close();
});
m_titleLyt->addWidget(m_titleIcon);
m_titleLyt->addWidget(m_titleLabel);
m_titleLyt->addStretch();
m_titleLyt->addWidget(m_closeBtn);
m_mainLyt->addWidget(m_titleFrame);
m_contentFrame = new QFrame(this);
m_contentLyt = new QVBoxLayout(m_contentFrame);
m_contentFrame->setLayout(m_contentLyt);
m_contentLyt->setContentsMargins(8, 0, 8, 0);
m_mainLyt->addWidget(m_contentFrame);
//设置
m_settingLabel = new QLabel(m_contentFrame);
m_settingLabel->setText(tr("<h2>Settings</h2>"));
m_contentLyt->addWidget(m_settingLabel);
//文件索引
m_indexTitleLabel = new QLabel(m_contentFrame);
m_indexTitleLabel->setText(tr("<h3>Index State</h3>"));
m_indexStateLabel = new QLabel(m_contentFrame);
m_indexStateLabel->setText(tr("..."));
m_indexNumLabel = new QLabel(m_contentFrame);
m_indexNumLabel->setText(tr("..."));
m_contentLyt->addWidget(m_indexTitleLabel);
m_contentLyt->addWidget(m_indexStateLabel);
// m_mainLyt->addWidget(m_indexNumLabel);
m_indexNumLabel->hide();
//文件索引设置(黑名单)
m_indexSettingLabel = new QLabel(m_contentFrame);
m_indexSettingLabel->setText(tr("<h3>File Index Settings</h3>"));
m_indexDescLabel = new QLabel(m_contentFrame);
m_indexDescLabel->setText(tr("Following folders will not be searched. You can set it by adding and removing folders."));
m_indexDescLabel->setWordWrap(true);
m_indexBtnFrame = new QFrame(m_contentFrame);
m_indexBtnLyt = new QHBoxLayout(m_indexBtnFrame);
m_indexBtnLyt->setContentsMargins(0, 0, 0, 0);
m_indexBtnFrame->setLayout(m_indexBtnLyt);
m_addDirBtn = new QPushButton(m_indexBtnFrame);
m_addDirBtn->setFixedHeight(32);
m_addDirBtn->setMinimumWidth(164);
m_addDirBtn->setText(tr("Add ignored folders"));
connect(m_addDirBtn, &QPushButton::clicked, this, &SettingsWidget::onBtnAddClicked);
m_indexBtnLyt->addWidget(m_addDirBtn);
m_indexBtnLyt->addStretch();
m_dirListArea = new QScrollArea(m_contentFrame);
m_dirListArea->setPalette(pal);
m_dirListArea->setFrameShape(QFrame::Shape::NoFrame);
m_dirListWidget = new QWidget(m_contentFrame);
m_dirListLyt = new QVBoxLayout(m_dirListWidget);
m_dirListLyt->setContentsMargins(0, 0, 0, 0);
m_dirListLyt->setSpacing(0);
m_dirListWidget->setLayout(m_dirListLyt);
m_dirListArea->setWidget(m_dirListWidget);
m_dirListArea->setWidgetResizable(m_contentFrame);
m_contentLyt->addWidget(m_indexSettingLabel);
m_contentLyt->addWidget(m_indexDescLabel);
m_contentLyt->addWidget(m_indexBtnFrame);
m_contentLyt->addWidget(m_dirListArea);
//搜索引擎设置
m_searchEngineLabel = new QLabel(m_contentFrame);
m_searchEngineLabel->setText(tr("<h3>Search Engine Settings</h3>"));
m_engineDescLabel = new QLabel(m_contentFrame);
m_engineDescLabel->setText(tr("Please select search engine you preferred."));
m_engineDescLabel->setWordWrap(true);
m_engineBtnGroup = new QButtonGroup(m_contentFrame);
m_baiduBtn = new QRadioButton(m_contentFrame);
m_sougouBtn = new QRadioButton(m_contentFrame);
m_360Btn = new QRadioButton(m_contentFrame);
m_baiduBtn->setFixedSize(16, 16);
m_sougouBtn->setFixedSize(16, 16);
m_360Btn->setFixedSize(16, 16);
m_radioBtnFrame = new QFrame(m_contentFrame);
m_radioBtnLyt = new QHBoxLayout(m_radioBtnFrame);
m_radioBtnFrame->setLayout(m_radioBtnLyt);
m_baiduLabel = new QLabel();
m_baiduLabel->setText(tr("baidu"));
m_sougouLabel = new QLabel();
m_sougouLabel->setText(tr("sougou"));
m_360Label = new QLabel();
m_360Label->setText(tr("360"));
m_radioBtnLyt->setContentsMargins(0, 0, 0, 0);
m_radioBtnLyt->addWidget(m_baiduBtn);
m_radioBtnLyt->addWidget(m_baiduLabel);
m_radioBtnLyt->addWidget(m_sougouBtn);
m_radioBtnLyt->addWidget(m_sougouLabel);
m_radioBtnLyt->addWidget(m_360Btn);
m_radioBtnLyt->addWidget(m_360Label);
m_radioBtnLyt->addStretch();
m_engineBtnGroup->setExclusive(true);
m_engineBtnGroup->addButton(m_baiduBtn);
m_engineBtnGroup->addButton(m_sougouBtn);
m_engineBtnGroup->addButton(m_360Btn);
// m_engineBtnGroup->setId(m_baiduBtn, WebEngine::Baidu);
// m_engineBtnGroup->setId(m_sougouBtn, WebEngine::Sougou);
// m_engineBtnGroup->setId(m_360Btn, WebEngine::_360);
// connect(m_engineBtnGroup, QOverload<int>::of(&QButtonGroup::buttonClicked), [ = ] (int id) {
// setWebEngine(id);
// });
connect(m_baiduBtn, &QRadioButton::clicked, [ = ](bool checked) {
if(checked) setWebEngine("baidu");
});
connect(m_sougouBtn, &QRadioButton::clicked, [ = ](bool checked) {
if(checked) setWebEngine("sougou");
});
connect(m_360Btn, &QRadioButton::clicked, [ = ](bool checked) {
if(checked) setWebEngine("360");
});
m_contentLyt->addWidget(m_searchEngineLabel);
m_contentLyt->addWidget(m_engineDescLabel);
m_contentLyt->addWidget(m_radioBtnFrame);
//取消与确认按钮 (隐藏)
// m_bottomBtnFrame = new QFrame(this);
// m_bottomBtnLyt = new QHBoxLayout(m_bottomBtnFrame);
// m_bottomBtnFrame->setLayout(m_bottomBtnLyt);
// m_bottomBtnLyt->setSpacing(20);
// m_cancelBtn = new QPushButton(m_bottomBtnFrame);
// m_cancelBtn->setText(tr("Cancel"));
// m_cancelBtn->setFixedSize(80, 32);
// connect(m_cancelBtn, &QPushButton::clicked, this, &SettingsWidget::onBtnCancelClicked);
// m_confirmBtn = new QPushButton(m_bottomBtnFrame);
// m_confirmBtn->setText(tr("Confirm"));
// m_confirmBtn->setFixedSize(80, 32);
// connect(m_confirmBtn, &QPushButton::clicked, this, &SettingsWidget::onBtnConfirmClicked);
// m_bottomBtnLyt->addStretch();
// m_bottomBtnLyt->addWidget(m_cancelBtn);
// m_bottomBtnLyt->addWidget(m_confirmBtn);
// m_mainLyt->addWidget(m_bottomBtnFrame);
m_contentLyt->addStretch();
#if (QT_VERSION < QT_VERSION_CHECK(5, 12, 0))
this->m_titleFrame->hide();
setAttribute(Qt::WA_DeleteOnClose);
#endif
}
/**
* @brief SettingsWidget::setupBlackList
* @param list
*/
void SettingsWidget::setupBlackList(const QStringList& list) {
clearLayout(m_dirListLyt);
m_blockdirs = 0;
Q_FOREACH(QString path, list) {
FolderListItem * item = new FolderListItem(m_dirListWidget, path);
m_dirListLyt->addWidget(item);
item->setMaximumWidth(this->width() - 52);
connect(item, &FolderListItem::onDelBtnClicked, this, &SettingsWidget::onBtnDelClicked);
m_blockdirs ++;
}
this->resize();
m_dirListWidget->setFixedWidth(this->width() - 68);
// m_dirListLyt->addStretch();
}
/**
* @brief SettingsWidget::clearLayout
* @param layout
*/
void SettingsWidget::clearLayout(QLayout * layout) {
if(! layout) return;
QLayoutItem * child;
while((child = layout->takeAt(0)) != 0) {
if(child->widget()) {
child->widget()->setParent(NULL);
}
delete child;
}
child = NULL;
}
/**
* @brief SettingsWidget::refreshIndexState
*/
void SettingsWidget::refreshIndexState() {
// qDebug()<<"FileUtils::indexStatus: "<<FileUtils::indexStatus;
if(FileUtils::indexStatus != 0) {
this->setIndexState(true);
} else {
this->setIndexState(false);
}
m_indexNumLabel->setText(QString("%1/%2").arg(QString::number(SearchManager::getCurrentIndexCount())).arg(QString::number(FileUtils::maxIndexCount)));
m_timer = new QTimer;
connect(m_timer, &QTimer::timeout, this, [ = ]() {
qDebug() << "FileUtils::indexStatus: " << FileUtils::indexStatus;
if(FileUtils::indexStatus != 0) {
this->setIndexState(true);
} else {
this->setIndexState(false);
}
m_indexNumLabel->setText(QString("%1/%2").arg(QString::number(SearchManager::getCurrentIndexCount())).arg(QString::number(FileUtils::maxIndexCount)));
});
m_timer->start(0.5 * 1000);
}
/**
* @brief SettingsWidget::onBtnDelClicked
* @param path
*/
void SettingsWidget::onBtnDelClicked(const QString& path) {
QMessageBox message(QMessageBox::Question, tr("Search"), tr("Whether to delete this directory?"));
QPushButton * buttonYes = message.addButton(tr("Yes"), QMessageBox::YesRole);
message.addButton(tr("No"), QMessageBox::NoRole);
message.exec();
if(message.clickedButton() != buttonYes) {
return;
}
int returnCode = 0;
if(GlobalSettings::getInstance()->setBlockDirs(path, returnCode, true)) {
qDebug() << "Remove block dir in onBtnDelClicked() successed.";
Q_FOREACH(FolderListItem * item, m_dirListWidget->findChildren<FolderListItem*>()) {
if(item->getPath() == path) {
item->deleteLater();
item = NULL;
m_blockdirs --;
this->resize();
return;
}
}
} else {
showWarningDialog(returnCode);
}
}
/**
* @brief SettingsWidget::resetWebEngine UI控件上
*/
void SettingsWidget::resetWebEngine() {
QString engine = GlobalSettings::getInstance()->getValue(WEB_ENGINE).toString();
m_engineBtnGroup->blockSignals(true);
if(!engine.isEmpty()) {
if(engine == "360") {
m_360Btn->setChecked(true);
} else if(engine == "sougou") {
m_sougouBtn->setChecked(true);
} else {
m_baiduBtn->setChecked(true);
}
} else {
m_baiduBtn->setChecked(true);
}
m_engineBtnGroup->blockSignals(false);
}
/**
* @brief SettingsWidget::setWebEngine
* @param engine
*/
void SettingsWidget::setWebEngine(const QString& engine) {
// GlobalSettings::getInstance()->setValue(WEB_ENGINE, engine);
Q_EMIT this->webEngineChanged(engine);
}
/**
* @brief setIndexState
* @param isCreatingIndex
*/
void SettingsWidget::setIndexState(bool isCreatingIndex) {
if(isCreatingIndex) {
m_indexStateLabel->setText(tr("Creating ..."));
return;
}
m_indexStateLabel->setText(tr("Done"));
}
/**
* @brief SettingsWidget::setIndexNum
* @param num
*/
void SettingsWidget::setIndexNum(int num) {
m_indexNumLabel->setText(QString(tr("Index Entry: %1")).arg(QString::number(num)));
}
/**
* @brief SettingsWidget::showWidget
*/
void SettingsWidget::showWidget() {
Qt::WindowFlags flags = this->windowFlags();
flags |= Qt::WindowStaysOnTopHint;
this->setWindowFlags(flags);
flags &= ~Qt::WindowStaysOnTopHint;
this->setWindowFlags(flags);
m_timer->start();
#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0))
XAtomHelper::getInstance()->setWindowMotifHint(winId(), m_hints);
#endif
this->show();
}
///**
// * @brief SettingsWidget::onBtnConfirmClicked 点击确认按钮的槽函数
// */
//void SettingsWidget::onBtnConfirmClicked() {
// Q_EMIT this->settingWidgetClosed();
// m_timer->stop();
// this->close();
//}
///**
// * @brief SettingsWidget::onBtnCancelClicked 点击取消按钮的槽函数
// */
//void SettingsWidget::onBtnCancelClicked() {
// Q_EMIT this->settingWidgetClosed();
// m_timer->stop();
// this->close();
//}
/**
* @brief SettingsWidget::onBtnAddClicked
*/
void SettingsWidget::onBtnAddClicked() {
QFileDialog * fileDialog = new QFileDialog(this);
// fileDialog->setFileMode(QFileDialog::Directory); //允许查看文件和文件夹,但只允许选择文件夹
fileDialog->setFileMode(QFileDialog::DirectoryOnly); //只允许查看文件夹
// fileDialog->setViewMode(QFileDialog::Detail);
fileDialog->setDirectory(QDir::homePath());
fileDialog->setNameFilter(tr("Directories"));
fileDialog->setWindowTitle(tr("select blocked folder"));
fileDialog->setLabelText(QFileDialog::Accept, tr("Select"));
fileDialog->setLabelText(QFileDialog::LookIn, tr("Position: "));
fileDialog->setLabelText(QFileDialog::FileName, tr("FileName: "));
fileDialog->setLabelText(QFileDialog::FileType, tr("FileType: "));
fileDialog->setLabelText(QFileDialog::Reject, tr("Cancel"));
if(fileDialog->exec() != QDialog::Accepted) {
fileDialog->deleteLater();
return;
}
QString selectedDir = 0;
int returnCode;
selectedDir = fileDialog->selectedFiles().first();
qDebug() << "Selected a folder in onBtnAddClicked(): " << selectedDir << ". ->settings-widget.cpp #238";
if(GlobalSettings::getInstance()->setBlockDirs(selectedDir, returnCode)) {
setupBlackList(GlobalSettings::getInstance()->getBlockDirs());
qDebug() << "Add block dir in onBtnAddClicked() successed. ->settings-widget.cpp #238";
} else {
showWarningDialog(returnCode);
}
}
/**
* @brief SettingsWidget::paintEvent
* @param event
*/
void SettingsWidget::paintEvent(QPaintEvent *event) {
Q_UNUSED(event)
QPainter p(this);
p.setRenderHint(QPainter::Antialiasing);
QPainterPath rectPath;
rectPath.addRect(this->rect());
// 绘制一个背景
p.save();
p.fillPath(rectPath, palette().color(QPalette::Base));
p.restore();
}
/**
* @brief SettingsWidget::resize
*/
void SettingsWidget::resize() {
// if (m_blockdirs <= 1) {
// this->setFixedSize(528, 455);
// } else if (m_blockdirs <= 3) {
// this->setFixedSize(528, 425 + 30 * m_blockdirs);
// } else {
// this->setFixedSize(528, 515);
// }
if(m_blockdirs <= 4) {
m_dirListArea->setFixedHeight(32 * m_blockdirs + 4);
m_dirListWidget->setFixedHeight(32 * m_blockdirs);
} else {
m_dirListWidget->setFixedHeight(32 * m_blockdirs);
m_dirListArea->setFixedHeight(32 * 4 + 4);
}
this->setFixedSize(528, 410 + m_dirListArea->height());
}
/**
* @brief SettingsWidget::showWarningDialog
* @param errorCode
*/
void SettingsWidget::showWarningDialog(const int & errorCode) {
qWarning() << "Add block dir in onBtnAddClicked() failed. Code: " << errorCode << " ->settings-widget.cpp #238";
QString errorMessage;
switch(errorCode) {
case 1: {
errorMessage = tr("Choosen path is Empty!");
break;
}
case 2: {
errorMessage = tr("Choosen path is not in \"home\"!");
break;
}
case 3: {
errorMessage = tr("Its' parent folder has been blocked!");
break;
}
default: {
errorMessage = tr("Set blocked folder failed!");
break;
}
}
QMessageBox message(QMessageBox::Warning, tr("Search"), errorMessage);
message.addButton(tr("OK"), QMessageBox::AcceptRole);
message.exec();
}
FolderListItem::FolderListItem(QWidget *parent, const QString &path) : QWidget(parent) {
m_path = path;
initUi();
}
FolderListItem::~FolderListItem() {
}
/**
* @brief FolderListItem::initUi ui
*/
void FolderListItem::initUi() {
m_layout = new QVBoxLayout(this);
m_layout->setSpacing(0);
m_layout->setContentsMargins(0, 0, 0, 0);
m_widget = new QWidget(this);
m_widget->setObjectName("mWidget");
this->setFixedHeight(32);
m_layout->addWidget(m_widget);
m_widgetlayout = new QHBoxLayout(m_widget);
m_widgetlayout->setContentsMargins(8, 4, 8, 4);
m_widget->setLayout(m_widgetlayout);
m_iconLabel = new QLabel(m_widget);
m_pathLabel = new QLabel(m_widget);
m_delLabel = new QLabel(m_widget);
m_iconLabel->setPixmap(QIcon::fromTheme("inode-directory").pixmap(QSize(16, 16)));
m_pathLabel->setText(m_path);
m_delLabel->setText(tr("Delete the folder out of blacklist"));
QPalette pal = palette();
pal.setColor(QPalette::WindowText, QColor(55, 144, 250, 255));
m_delLabel->setPalette(pal);
m_delLabel->setCursor(QCursor(Qt::PointingHandCursor));
m_delLabel->installEventFilter(this);
m_delLabel->hide();
m_widgetlayout->addWidget(m_iconLabel);
m_widgetlayout->addWidget(m_pathLabel);
m_widgetlayout->addStretch();
m_widgetlayout->addWidget(m_delLabel);
}
/**
* @brief FolderListItem::getPath
* @return
*/
QString FolderListItem::getPath() {
return m_path;
}
/**
* @brief FolderListItem::enterEvent
* @param event
*/
void FolderListItem::enterEvent(QEvent *event) {
m_delLabel->show();
m_widget->setStyleSheet("QWidget#mWidget{background: rgba(0,0,0,0.1);}");
QWidget::enterEvent(event);
}
/**
* @brief FolderListItem::leaveEvent
* @param event
*/
void FolderListItem::leaveEvent(QEvent *event) {
m_delLabel->hide();
m_widget->setStyleSheet("QWidget#mWidget{background: transparent;}");
QWidget::leaveEvent(event);
}
/**
* @brief FolderListItem::eventFilter
* @param watched
* @param event
* @return
*/
bool FolderListItem::eventFilter(QObject *watched, QEvent *event) {
if(watched == m_delLabel) {
if(event->type() == QEvent::MouseButtonPress) {
// qDebug()<<"pressed!";
Q_EMIT this->onDelBtnClicked(m_path);
}
}
return QObject::eventFilter(watched, event);
}

View File

@ -1,154 +0,0 @@
/*
*
* Copyright (C) 2020, KylinSoft Co., Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* Authors: zhangjiaping <zhangjiaping@kylinos.cn>
*
*/
#ifndef SETTINGSWIDGET_H
#define SETTINGSWIDGET_H
#include <QWidget>
#include <QDialog>
#include <QFrame>
#include <QHBoxLayout>
#include <QVBoxLayout>
#include <QLabel>
#include <QRadioButton>
#include <QButtonGroup>
#include <QPushButton>
#include <QScrollArea>
#include <QTimer>
#include "libsearch.h"
#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0))
#include "xatom-helper.h"
#endif
namespace UkuiSearch {
class FolderListItem : public QWidget {
Q_OBJECT
public:
explicit FolderListItem(QWidget *parent = nullptr, const QString &path = 0);
~FolderListItem();
QString getPath();
protected:
virtual void enterEvent(QEvent *);
virtual void leaveEvent(QEvent *);
bool eventFilter(QObject *, QEvent *);
private:
void initUi();
QString m_path;
QVBoxLayout * m_layout = nullptr;
QWidget * m_widget = nullptr;
QHBoxLayout * m_widgetlayout = nullptr;
QLabel * m_iconLabel = nullptr;
QLabel * m_pathLabel = nullptr;
QLabel * m_delLabel = nullptr;
Q_SIGNALS:
void onDelBtnClicked(const QString&);
};
class SettingsWidget : public QWidget {
Q_OBJECT
public:
explicit SettingsWidget(QWidget *parent = nullptr);
~SettingsWidget();
void setIndexState(bool);
void setIndexNum(int);
void showWidget();
void resetWebEngine();
private:
void initUi();
void setupBlackList(const QStringList &);
void clearLayout(QLayout *);
void refreshIndexState();
void paintEvent(QPaintEvent *);
void resize();
void showWarningDialog(const int&);
#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0))
MotifWmHints m_hints;
#endif
//标题栏
QVBoxLayout * m_mainLyt = nullptr;
QFrame * m_contentFrame = nullptr;
QVBoxLayout * m_contentLyt = nullptr;
QFrame * m_titleFrame = nullptr;
QHBoxLayout * m_titleLyt = nullptr;
QLabel * m_titleIcon = nullptr;
QLabel * m_titleLabel = nullptr;
QPushButton * m_closeBtn = nullptr;
//设置
QLabel * m_settingLabel = nullptr;
//文件索引
QLabel * m_indexTitleLabel = nullptr;
QLabel * m_indexStateLabel = nullptr;
QLabel * m_indexNumLabel = nullptr;
//文件索引设置(黑名单)
QLabel * m_indexSettingLabel = nullptr;
QLabel * m_indexDescLabel = nullptr;
QFrame * m_indexBtnFrame = nullptr;
QHBoxLayout * m_indexBtnLyt = nullptr;
QPushButton * m_addDirBtn = nullptr;
QScrollArea * m_dirListArea = nullptr;
QWidget * m_dirListWidget = nullptr;
QVBoxLayout * m_dirListLyt = nullptr;
//搜索引擎设置
QLabel * m_searchEngineLabel = nullptr;
QLabel * m_engineDescLabel = nullptr;
QButtonGroup * m_engineBtnGroup = nullptr;
QFrame * m_radioBtnFrame = nullptr;
QHBoxLayout * m_radioBtnLyt = nullptr;
QRadioButton * m_baiduBtn = nullptr;
QLabel * m_baiduLabel = nullptr;
QRadioButton * m_sougouBtn = nullptr;
QLabel * m_sougouLabel = nullptr;
QRadioButton * m_360Btn = nullptr;
QLabel * m_360Label = nullptr;
//取消与确认按钮
QFrame * m_bottomBtnFrame = nullptr;
QHBoxLayout * m_bottomBtnLyt = nullptr;
QPushButton * m_cancelBtn = nullptr;
QPushButton * m_confirmBtn = nullptr;
QTimer * m_timer;
int m_blockdirs = 0; //黑名单文件夹数量
Q_SIGNALS:
void settingWidgetClosed();
void webEngineChanged(const QString&);
private Q_SLOTS:
// void onBtnConfirmClicked();
// void onBtnCancelClicked();
void onBtnAddClicked();
void onBtnDelClicked(const QString&);
void setWebEngine(const QString&);
};
}
#endif // SETTINGSWIDGET_H

View File

@ -630,49 +630,6 @@ QString escapeHtml(const QString & str) {
return temp;
}
void DetailWidget::setWidgetInfo(const QString &plugin_name, const SearchPluginIface::ResultInfo &info)
{
// clearLayout(m_descFrameLyt);
// clearLayout(m_previewFrameLyt);
// if(SearchPluginManager::getInstance()->getPlugin(plugin_name)->isPreviewEnable(info.actionKey,info.type)) {
// m_iconLabel->hide();
// m_previewFrameLyt->addWidget(SearchPluginManager::getInstance()->getPlugin(plugin_name)->previewPage(info.actionKey,info.type, m_previewFrame), 0 , Qt::AlignHCenter);
// m_previewFrameLyt->setContentsMargins(0,0,0,0);
// m_previewFrame->show();
// } else {
// m_previewFrame->hide();
// m_iconLabel->setPixmap(info.icon.pixmap(info.icon.actualSize(ICON_SIZE)));
// m_iconLabel->show();
// }
// QFontMetrics fontMetrics = m_nameLabel->fontMetrics();
// QString name = fontMetrics.elidedText(info.name, Qt::ElideRight, NAME_LABEL_WIDTH - 8);
// m_nameLabel->setText(QString("<h3 style=\"font-weight:normal;\">%1</h3>").arg(escapeHtml(name)));
// m_nameLabel->setToolTip(info.name);
// m_pluginLabel->setText(plugin_name);
// m_nameFrame->show();
// m_line_1->show();
// if (info.description.length() > 0) {
// //NEW_TODO 样式待优化
// clearLayout(m_descFrameLyt);
// Q_FOREACH (SearchPluginIface::DescriptionInfo desc, info.description) {
// QLabel * descLabel = new QLabel(m_descFrame);
// descLabel->setTextFormat(Qt::PlainText);
// descLabel->setWordWrap(true);
// QString show_desc = desc.key + " " + desc.value;
// descLabel->setText(show_desc);
// m_descFrameLyt->addWidget(descLabel);
// }
// m_descFrame->show();
// m_line_2->show();
// }
// clearLayout(m_actionFrameLyt);
// Q_FOREACH (SearchPluginIface::Actioninfo actioninfo, SearchPluginManager::getInstance()->getPlugin(plugin_name)->getActioninfo(info.type)) {
// ActionLabel * actionLabel = new ActionLabel(actioninfo.displayName, info.actionKey, actioninfo.actionkey, plugin_name, info.type, m_actionFrame);
// m_actionFrameLyt->addWidget(actionLabel);
// }
// m_actionFrame->show();
}
void DetailWidget::updateDetailPage(const QString &plugin_name, const SearchPluginIface::ResultInfo &info)
{
@ -697,71 +654,6 @@ void DetailWidget::updateDetailPage(const QString &plugin_name, const SearchPlug
m_currentPluginId = plugin_name;
}
void DetailWidget::clear()
{
// m_iconLabel->hide();
// m_nameFrame->hide();
// m_line_1->hide();
// m_descFrame->hide();
// m_line_2->hide();
// m_actionFrame->hide();
}
void DetailWidget::initUi()
{
// this->setFixedSize(368, 516);
// m_mainLyt = new QVBoxLayout(this);
// this->setLayout(m_mainLyt);
// m_mainLyt->setContentsMargins(DETAIL_WIDGET_MARGINS);
// m_mainLyt->setAlignment(Qt::AlignHCenter);
// m_iconLabel = new QLabel(this);
// m_iconLabel->setFixedHeight(DETAIL_ICON_HEIGHT);
// m_iconLabel->setAlignment(Qt::AlignCenter);
// m_previewFrame = new QFrame(this);
// m_previewFrameLyt = new QHBoxLayout(m_previewFrame);
// m_nameFrame = new QFrame(this);
// m_nameFrameLyt = new QHBoxLayout(m_nameFrame);
// m_nameFrame->setLayout(m_nameFrameLyt);
// m_nameFrameLyt->setContentsMargins(DETAIL_FRAME_MARGINS);
// m_nameLabel = new QLabel(m_nameFrame);
// m_nameLabel->setMaximumWidth(NAME_LABEL_WIDTH);
// m_pluginLabel = new QLabel(m_nameFrame);
// m_pluginLabel->setEnabled(false);
// m_nameFrameLyt->addWidget(m_nameLabel);
// m_nameFrameLyt->addStretch();
// m_nameFrameLyt->addWidget(m_pluginLabel);
// m_line_1 = new QFrame(this);
// m_line_1->setFixedHeight(1);
// m_line_1->setLineWidth(0);
// m_line_1->setStyleSheet(LINE_STYLE);
// m_line_2 = new QFrame(this);
// m_line_2->setFixedHeight(1);
// m_line_2->setLineWidth(0);
// m_line_2->setStyleSheet(LINE_STYLE);
// m_descFrame = new QFrame(this);
// m_descFrameLyt = new QVBoxLayout(m_descFrame);
// m_descFrame->setLayout(m_descFrameLyt);
// m_descFrameLyt->setContentsMargins(DETAIL_FRAME_MARGINS);
// m_actionFrame = new QFrame(this);
// m_actionFrameLyt = new QVBoxLayout(m_actionFrame);
// m_actionFrame->setLayout(m_actionFrameLyt);
// m_actionFrameLyt->setContentsMargins(DETAIL_FRAME_MARGINS);
// m_mainLyt->addWidget(m_iconLabel);
// m_mainLyt->addWidget(m_previewFrame, 0, Qt::AlignHCenter);
// m_mainLyt->addWidget(m_nameFrame);
// m_mainLyt->addWidget(m_line_1);
// m_mainLyt->addWidget(m_descFrame);
// m_mainLyt->addWidget(m_line_2);
// m_mainLyt->addWidget(m_actionFrame);
// m_mainLyt->addStretch();
}
void DetailWidget::paintEvent(QPaintEvent *event)
{
QStyleOption opt;
@ -791,53 +683,6 @@ void DetailWidget::clearLayout(QLayout *layout)
child = NULL;
}
//ActionLabel::ActionLabel(const QString &action, const QString &key, const int &ActionKey, const QString &pluginId, const int type, QWidget *parent) : QLabel(parent)
//{
// m_action = action;
// m_key = key;
// m_actionKey = ActionKey;
// m_type = type;
// m_pluginId = pluginId;
// this->initUi();
// this->installEventFilter(this);
//}
//void ActionLabel::initUi()
//{
// this->setText(m_action);
// QPalette pal = palette();
// pal.setColor(QPalette::WindowText, ACTION_NORMAL_COLOR);
// pal.setColor(QPalette::Light, ACTION_HOVER_COLOR);
// pal.setColor(QPalette::Dark, ACTION_PRESS_COLOR);
// this->setPalette(pal);
// this->setForegroundRole(QPalette::WindowText);
// this->setCursor(QCursor(Qt::PointingHandCursor));
//}
//bool ActionLabel::eventFilter(QObject *watched, QEvent *event)
//{
// if (watched == this) {
// if(event->type() == QEvent::MouseButtonPress) {
// this->setForegroundRole(QPalette::Dark);
// return true;
// } else if(event->type() == QEvent::MouseButtonRelease) {
// SearchPluginIface *plugin = SearchPluginManager::getInstance()->getPlugin(m_pluginId);
// if (plugin)
// plugin->openAction(m_actionKey, m_key, m_type);
// else
// qWarning()<<"Get plugin failed!";
// this->setForegroundRole(QPalette::Light);
// return true;
// } else if(event->type() == QEvent::Enter) {
// this->setForegroundRole(QPalette::Light);
// return true;
// } else if(event->type() == QEvent::Leave) {
// this->setForegroundRole(QPalette::WindowText);
// return true;
// }
// }
//}
ResultScrollBar::ResultScrollBar(QWidget *parent) : QScrollBar(parent)
{

View File

@ -28,7 +28,6 @@
#include "result-view.h"
#include "search-plugin-iface.h"
#include "best-list-view.h"
#include "web-search-view.h"
namespace UkuiSearch {
class ResultScrollBar : public QScrollBar
@ -115,32 +114,16 @@ class DetailWidget : public QWidget
public:
DetailWidget(QWidget *parent = nullptr);
~DetailWidget() = default;
void clear();
public Q_SLOTS:
void setWidgetInfo(const QString &plugin_name, const SearchPluginIface::ResultInfo &info);
void updateDetailPage(const QString &plugin_name, const SearchPluginIface::ResultInfo &info);
protected:
void paintEvent(QPaintEvent *event);
private:
void initUi();
void clearLayout(QLayout *);
QVBoxLayout * m_mainLyt = nullptr;
QString m_currentPluginId;
QWidget *m_detailPage = nullptr;
// QLabel * m_iconLabel = nullptr;
// QFrame *m_previewFrame = nullptr;
// QHBoxLayout *m_previewFrameLyt = nullptr;
// QFrame * m_nameFrame = nullptr;
// QHBoxLayout * m_nameFrameLyt = nullptr;
// QLabel * m_nameLabel = nullptr;
// QLabel * m_pluginLabel = nullptr;
// QFrame * m_line_1 = nullptr;
// QFrame * m_descFrame = nullptr;
// QVBoxLayout * m_descFrameLyt = nullptr;
// QFrame * m_line_2 = nullptr;
// QFrame * m_actionFrame = nullptr;
// QVBoxLayout * m_actionFrameLyt = nullptr;
};
class DetailArea : public QScrollArea
@ -156,24 +139,6 @@ private:
Q_SIGNALS:
void setWidgetInfo(const QString&, const SearchPluginIface::ResultInfo&);
};
//class ActionLabel : public QLabel
//{
// Q_OBJECT
//public:
// ActionLabel(const QString &action, const QString &key, const int &ActionKey, const QString &pluginId, const int type = 0, QWidget *parent = nullptr);
// ~ActionLabel() = default;
//private:
// void initUi();
// QString m_action;
// QString m_key;
// int m_actionKey;
// int m_type = 0;
// QString m_pluginId;
//protected:
// bool eventFilter(QObject *, QEvent *);
//};
}
#endif // SEARCHPAGESECTION_H

View File

@ -19,6 +19,7 @@
*
*/
#include "search-result-page.h"
#include "global-settings.h"
#include <QPainterPath>
QT_BEGIN_NAMESPACE
extern void qt_blurImage(QImage &blurImage, qreal radius, bool quality, int transposed);
@ -35,11 +36,6 @@ SearchResultPage::SearchResultPage(QWidget *parent) : QWidget(parent)
setInternalPlugins();
}
void SearchResultPage::setSize(const int&width, const int&height)
{
// m_splitter->setFixedSize(width, height);
}
void SearchResultPage::setInternalPlugins()
{
QList<PluginInfo> infoList = SearchPluginManager::getInstance()->getPluginIds();
@ -129,10 +125,11 @@ void SearchResultPage::setWidth(int width)
void SearchResultPage::paintEvent(QPaintEvent *event)
{
Q_UNUSED(event)
QPainter p(this);
p.setRenderHint(QPainter::Antialiasing);
p.setBrush(palette().base());
p.setOpacity(GlobalSettings::getInstance()->getValue(TRANSPARENCY_KEY).toDouble());
p.setOpacity(GlobalSettings::getInstance().getValue(TRANSPARENCY_KEY).toDouble());
p.setPen(Qt::NoPen);
p.drawRoundedRect(this->rect().adjusted(10,10,-10,-10), 12, 12);
@ -210,10 +207,18 @@ void SearchResultPage::initConnections()
setWidth(672);
});
connect(m_resultArea, &ResultArea::scrollBarAppeared, this, [ & ]{
if (m_detailArea->isHidden()) {
setWidth(672);
} else {
setWidth(296);
}
});
connect(m_resultArea, &ResultArea::scrollBarIsHideen, this, [ & ]{
if (m_detailArea->isHidden()) {
setWidth(672);
} else {
setWidth(296);
}
});
connect(m_resultArea, &ResultArea::keyPressChanged, m_detailArea, &DetailArea::setWidgetInfo);
connect(m_resultArea, &ResultArea::keyPressChanged, this, [=] () {

View File

@ -31,7 +31,6 @@ class SearchResultPage : public QWidget
public:
explicit SearchResultPage(QWidget *parent = nullptr);
~SearchResultPage() = default;
void setSize(const int&, const int&);
void setInternalPlugins();
void appendPlugin(const QString &plugin_id);
void movePlugin(const QString &plugin_id, int index);

View File

@ -1,9 +0,0 @@
INCLUDEPATH += $$PWD
HEADERS += \
$$PWD/search-page-section.h \
$$PWD/search-result-page.h
SOURCES += \
$$PWD/search-page-section.cpp \
$$PWD/search-result-page.cpp

View File

@ -1,79 +0,0 @@
QT += core gui dbus KWindowSystem xml x11extras sql
greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
VERSION = 2.2.3
DEFINES += VERSION='\\"$${VERSION}\\"'
TARGET = ukui-search
TEMPLATE = app
PKGCONFIG += gio-2.0 glib-2.0 gio-unix-2.0 kysdk-waylandhelper
CONFIG += c++11 link_pkgconfig no_keywords lrelease
LIBS += -lxapian -lgsettings-qt -lquazip5 -lX11
#LIBS += -lukui-log4qt
# The following define makes your compiler emit warnings if you use
# any Qt feature that has been marked deprecated (the exact warnings
# depend on your compiler). Please consult the documentation of the
# deprecated API in order to know how to port your code away from it.
DEFINES += QT_DEPRECATED_WARNINGS
# You can also make your code fail to compile if it uses deprecated APIs.
# In order to do so, uncomment the following line.
# You can also select to disable deprecated APIs only up to a certain version of Qt.
#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0
include(../libsearch/libukui-search-headers.pri)
include(control/control.pri)
include(model/model.pri)
include(xatom/xatom.pri)
include(../3rd-parties/qtsingleapplication/qtsingleapplication.pri)
include(view/view.pri)
SOURCES += \
main.cpp \
mainwindow.cpp \
ukui-search-dbus-service.cpp \
ukui-search-gui.cpp
HEADERS += \
mainwindow.h \
ukui-search-dbus-service.h \
ukui-search-gui.h
# Default rules for deployment.
target.path = /usr/bin
!isEmpty(target.path): INSTALLS += target
data-menu.path = /usr/share/applications
data-menu.files += ../data/ukui-search-menu.desktop
data.path = /etc/xdg/autostart
data.files += ../data/ukui-search.desktop
INSTALLS += data data-menu
RESOURCES += \
resource.qrc
TRANSLATIONS += \
../translations/ukui-search/zh_CN.ts \
../translations/ukui-search/tr.ts \
../translations/ukui-search/bo_CN.ts
qm_files.path = /usr/share/ukui-search/translations/
qm_files.files = $$OUT_PWD/.qm/*.qm
schemes.path = /usr/share/glib-2.0/schemas/
schemes.files += ../data/org.ukui.log4qt.ukui-search.gschema.xml
INSTALLS += qm_files schemes
LIBS += -L$$OUT_PWD/../libchinese-segmentation -lchinese-segmentation \
-L$$OUT_PWD/../libsearch -lukui-search
INCLUDEPATH += $$PWD/../libchinese-segmentation
DEPENDPATH += $$PWD/../libchinese-segmentation
DISTFILES += \
../data/org.ukui.log4qt.ukui-search.gschema.xml \

View File

@ -21,76 +21,17 @@
*
*/
#include <QDesktopWidget>
#include <QFile>
#include <QDir>
#include <unistd.h>
#include <syslog.h>
#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0))
#include <ukui-log4qt.h>
#endif
#include <QObject>
#include <QApplication>
#include <QX11Info>
#include <KWindowSystem>
#include "ukui-search-gui.h"
#include "log-utils.h"
using namespace UkuiSearch;
void messageOutput(QtMsgType type, const QMessageLogContext &context, const QString &msg)
{
QByteArray localMsg = msg.toLocal8Bit();
QByteArray currentTime = QTime::currentTime().toString().toLocal8Bit();
bool showDebug = true;
// QString logFilePath = QStandardPaths::writableLocation(QStandardPaths::TempLocation) + "/ukui-search.log";
// QString logFilePath = QStandardPaths::writableLocation(QStandardPaths::HomeLocation) + "/.config/org.ukui/ukui-search/ukui-search.log";
QString logFilePath = QStandardPaths::writableLocation(QStandardPaths::HomeLocation) + "/.config/org.ukui/ukui-search.log";
if (!QFile::exists(logFilePath)) {
showDebug = false;
}
FILE *log_file = nullptr;
if (showDebug) {
log_file = fopen(logFilePath.toLocal8Bit().constData(), "a+");
}
const char *file = context.file ? context.file : "";
const char *function = context.function ? context.function : "";
switch (type) {
case QtDebugMsg:
if (!log_file) {
break;
}
fprintf(log_file, "Debug: %s: %s (%s:%u, %s)\n", currentTime.constData(), localMsg.constData(), file, context.line, function);
break;
case QtInfoMsg:
fprintf(log_file? log_file: stdout, "Info: %s: %s (%s:%u, %s)\n", currentTime.constData(), localMsg.constData(), file, context.line, function);
break;
case QtWarningMsg:
fprintf(log_file? log_file: stderr, "Warning: %s: %s (%s:%u, %s)\n", currentTime.constData(), localMsg.constData(), file, context.line, function);
break;
case QtCriticalMsg:
fprintf(log_file? log_file: stderr, "Critical: %s: %s (%s:%u, %s)\n", currentTime.constData(), localMsg.constData(), file, context.line, function);
break;
case QtFatalMsg:
fprintf(log_file? log_file: stderr, "Fatal: %s: %s (%s:%u, %s)\n", currentTime.constData(), localMsg.constData(), file, context.line, function);
break;
}
if (log_file)
fclose(log_file);
}
int main(int argc, char *argv[]) {
//v101日志模块
//#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0))
// //Init log module
// initUkuiLog4qt("ukui-search");
//#endif
// Determine whether the home directory has been created, and if not, keep waiting.
char *p_home = NULL;
unsigned int i = 0;
while(p_home == NULL) {
::sleep(1);
@ -111,14 +52,8 @@ int main(int argc, char *argv[]) {
}
// Output log to file
qInstallMessageHandler(messageOutput);
//若使用v101日志模块可以解放如下判断条件
//#if (QT_VERSION < QT_VERSION_CHECK(5, 12, 0))
// // Output log to file
// qInstallMessageHandler(messageOutput);
//#endif
// Register meta type
LogUtils::initLogFile("ukui-search");
qInstallMessageHandler(LogUtils::messageOutput);
qDebug() << "ukui-search main start";
// If qt version bigger than 5.12, enable high dpi scaling and use high dpi pixmaps?
#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0))
@ -128,7 +63,18 @@ int main(int argc, char *argv[]) {
#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0))
QApplication::setHighDpiScaleFactorRoundingPolicy(Qt::HighDpiScaleFactorRoundingPolicy::PassThrough);
#endif
UkuiSearchGui app(argc, argv, QString("ukui-search-gui-%1").arg(QX11Info::appScreen()));
QString display;
QString sessionType;
if(QString(getenv("XDG_SESSION_TYPE")) == "wayland") {
sessionType = "wayland";
display = getenv("WAYLAND_DISPLAY");
} else {
sessionType = "x11";
display = getenv("DISPLAY");
}
qDebug() << "Current DISPLAY: " << display;
UkuiSearchGui app(argc, argv, display, sessionType);
if (app.isRunning())
return 0;

Some files were not shown because too many files have changed in this diff Show More