aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules/objects/KvsObject_label.cpp
diff options
context:
space:
mode:
authorGravatar un1versal2015-12-09 11:58:53 +0000
committerGravatar un1versal2015-12-19 02:40:22 +0000
commit7d4516afc4cd194f9224dcd5e07e0f234c162fdf (patch)
treea1a165c897339fcbd35a27108fe16c999a3041e2 /src/modules/objects/KvsObject_label.cpp
parentMerge pull request #1776 from TheReign/issue_1754_2 (diff)
downloadKVIrc-7d4516afc4cd194f9224dcd5e07e0f234c162fdf.tar.gz
KVIrc-7d4516afc4cd194f9224dcd5e07e0f234c162fdf.tar.bz2
KVIrc-7d4516afc4cd194f9224dcd5e07e0f234c162fdf.zip
src/modules typos: capitalize, formatting, consistency and syntax fixes
Diffstat (limited to 'src/modules/objects/KvsObject_label.cpp')
-rw-r--r--src/modules/objects/KvsObject_label.cpp33
1 files changed, 16 insertions, 17 deletions
diff --git a/src/modules/objects/KvsObject_label.cpp b/src/modules/objects/KvsObject_label.cpp
index 570dfb5ba..57e35b0e2 100644
--- a/src/modules/objects/KvsObject_label.cpp
+++ b/src/modules/objects/KvsObject_label.cpp
@@ -6,8 +6,8 @@
// This file is part of the KVIrc IRC client distribution
// Copyright (C) 2000 Krzysztof Godlewski
// Copyright (C) 2000-2010 Szymon Stefanek (pragma at kvirc dot net)
-// Copyright (C) 2014 OmegaPhil (OmegaPhil@startmail.com)
-//LinkDelegationPolicy
+// Copyright (C) 2014 OmegaPhil (OmegaPhil at startmail dot com)
+//
// 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 2
@@ -103,12 +103,12 @@ const int frame_cod[] = {
[class]object[/class]
[class]widget[/class]
@description:
- This widget can be used to display a text or an image. It can
- have different frame styles and text/image alignment.
+ This widget can be used to display a text or an image.[br]
+ It can have different frame styles and text/image alignment.
@functions:
!fn: $setText(<text:string>)
Sets the text to be displayed by the label.
- The text can contain limited html tags.
+ The text can contain limited HTML tags.
See also [classfnc]$text[/classfnc]().
!fn: <string> $text()
Returns the text currently displayed by the label.
@@ -121,8 +121,8 @@ const int frame_cod[] = {
See also [classfnc]$margin[/classfnc]().
!fn: <string> $alignment()
Returns a string containing alignment flags that are set for
- this label. The flags are separated by commas. An example output
- could look like this:[br]
+ this label. The flags are separated by commas.[br]
+ An example output could look like this:[br]
[pre]Bottom, Right[/pre][br]
See [classfnc]$setAlignment[/classfnc]() for explanation of all
alignment flags.
@@ -140,7 +140,7 @@ const int frame_cod[] = {
Justify - Text is spaced apart to cover available room[br]
[/pre]
It is obvious that you can not set [i]Right[/i]
- and [i]Left[/i] simoultaneously - this will [b]NOT[/b]
+ and [i]Left[/i] simultaneously - this will [b]not[/b]
result in an error message - it will simply not work :)
!fn: $clear()
Clears the label. Equal to calling [classfnc]$setText[/classfnc]("")
@@ -156,22 +156,21 @@ const int frame_cod[] = {
The flags determine the shape or shadow of the
label's frame. Valid shape flags are:[br]
[pre]
- NoFrame - draw no frame. You shouldn't specify a shadow when
+ NoFrame - Draw no frame. You shouldn't specify a shadow when
using this.[br]
- Box - draws a rectangular box. Its borders can be
+ Box - Draws a rectangular box. Its borders can be
[i]Raised[/i] or [i]Sunken[/i][br]
- Panel - draws a rectangular panel which can be
+ Panel - Draws a rectangular panel which can be
[i]Raised[/i] or [i]Sunken[/i][br]
- WinPanel - similar to [i]Panel[/i], but is more in Win95
- style[br]
- Hline - draws a horizontal line that frames nothing (useful as separator)
+ WinPanel - Similar to [i]Panel[/i], but is more in Win95 style[br]
+ Hline - Draws a horizontal line that frames nothing (useful as separator)
[/pre]
Valid shadow flags are:[br]
[pre]
- Plain - no 3D effect (draws using foreground color)[br]
- Raised - makes the label look like it was raised above the
+ Plain - No 3D effect (draws using foreground color)[br]
+ Raised - Makes the label look like it was raised above the
parent widget[br]
- Sunken - makes the label look like it was "pushed" inside
+ Sunken - Makes the label look like it was [i]pushed[/i] inside
the parent widget[br]
[/pre]
!fn: $setImage(<image_id>)