diff options
| author | 2016-03-02 12:15:44 +0000 | |
|---|---|---|
| committer | 2016-03-14 04:57:12 +0000 | |
| commit | f138911b65dfce85c551f9e2e4bbeb595d6c6755 (patch) | |
| tree | 701d5eec803c30160be47f8762b5838e57bc44dd /src/modules/objects/KvsObject_trayIcon.cpp | |
| parent | cleanup: add or remove empty lines between documentation blocks & code (diff) | |
| download | KVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.tar.gz KVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.tar.bz2 KVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.zip | |
documentation: formatting/indentation + minor syntax fixes
+ Dont use double quotes to emphasise words in normal circumstances.
+ improve indenting + consistency (good for readability when editing source)
+ also replace single quotes
Diffstat (limited to 'src/modules/objects/KvsObject_trayIcon.cpp')
| -rw-r--r-- | src/modules/objects/KvsObject_trayIcon.cpp | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/src/modules/objects/KvsObject_trayIcon.cpp b/src/modules/objects/KvsObject_trayIcon.cpp index b1aeb90b6..e5dc4a2e1 100644 --- a/src/modules/objects/KvsObject_trayIcon.cpp +++ b/src/modules/objects/KvsObject_trayIcon.cpp @@ -62,12 +62,14 @@ Returns '1' if the tray icon is currently visible. !fn: showMessage(<title:string>,<message:string>,<message_icon:string>,<timeout:integer>) Shows a balloon message for the entry with the given title, message and message_icon for the time specified in millisecondsTimeoutHint. title and message must be plain text strings. - Message can be clicked by the user; the messageClickedEvent() will be triggered when this occurs. + Message can be clicked by the user; the messageClickedEvent() will be triggered when this occurs.[br] Valid values for message_icon are: - [br]- NoIcon : No icon is shown. - [br]- Information : An information icon is shown. - [br]- Warning : A standard warning icon is shown. - [br]- Critical : A critical warning icon is shown. + [pre] + - NoIcon : No icon is shown.[br] + - Information : An information icon is shown.[br] + - Warning : A standard warning icon is shown.[br] + - Critical : A critical warning icon is shown.[br] + [/pre] !fn: setContextMenu(<popupmenu:hobject>). Associates the given <popupmenu> with the tray icon. !fn: activatedEvent(<reason:string>) @@ -75,11 +77,11 @@ If you reimplement this function the reason parameter will be passed as $0. Values for reason are:[br] [pre] - [br]- Unknown : Unknown reason. - [br]- Context : The context menu for the tray icon was requested. - [br]- DoubleClick : The tray icon was double clicked. - [br]- Trigger : The tray icon was clicked. - [br]- MiddleClick : The tray icon was clicked with the middle mouse button. + - Unknown : Unknown reason.[br] + - Context : The context menu for the tray icon was requested.[br] + - DoubleClick : The tray icon was double clicked.[br] + - Trigger : The tray icon was clicked.[br] + - MiddleClick : The tray icon was clicked with the middle mouse button.[br] [/pre] The default implementation emits the [classfnc]$activated[/classfnc]() signal. !fn: messageClickedEvent() |
