diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 4 insertions, 3 deletions
@@ -5,10 +5,11 @@ This is a replacement of the QSingleApplication for Qt5. Usage ----- +The ```SingleApplication``` class inherits from ```QApplication```. Use it as if you are using the ```QApplication``` class. -The library uses your ```Organization Name``` and ```Application Name``` to set up a Local Server on which the first instance of your application would listen on and each subsequent instance would connect and then exit. +The library uses your ```Organization Name``` and ```Application Name``` to set up a Local Socket. The first instance of your Application would start a ```QLocalServer``` and then listen for connections on the socket. Every subsequent instance of your application would attempt to connect to that socket. If successful it will be terminated, while in the Primary Instance, ```SingleApplication``` would emmit the ```showUp()``` signal. -I also used ```stdlib``` to terminate the program with it's ```exit()``` function. +The library uses ```stdlib``` to terminate the program with the ```exit()``` function. Here is an example usage of the library: ```cpp @@ -27,7 +28,7 @@ int main(int argc, char *argv[]) The ```Show Up``` signal ------------------------ -The SingleApplication class implements a ```showUp()``` signal. You can bind to that signal to raise your application's window, for example. This way when someone tries to run your application twice he would end up with the primary instance's Main Window and the new instance would be terminated. +The SingleApplication class implements a ```showUp()``` signal. You can bind to that signal to raise your application's window when a new instance had been started. License ------- |