diff options
| author | 2017-08-31 00:38:57 +0200 | |
|---|---|---|
| committer | 2017-08-31 00:38:57 +0200 | |
| commit | 9defac5f54e1cd06d7c026b695fed381c931d856 (patch) | |
| tree | ce7f6aedf58118e8ba800e4c6af37ab250583a9c | |
| parent | Allow the user to bypass the default stylesheet. (diff) | |
| download | KVIrc-9defac5f54e1cd06d7c026b695fed381c931d856.tar.gz KVIrc-9defac5f54e1cd06d7c026b695fed381c931d856.tar.bz2 KVIrc-9defac5f54e1cd06d7c026b695fed381c931d856.zip | |
Fix wrapping of <pre> in the docs.
Fixes #2288
| -rw-r--r-- | admin/doc.css | 3 | ||||
| -rwxr-xr-x | admin/gendoc.pl | 4 | ||||
| -rw-r--r-- | src/kvilib/irc/KviIrcMask.cpp | 12 | ||||
| -rw-r--r-- | src/kvirc/sparser/KviIrcServerParser_ctcp.cpp | 16 | ||||
| -rw-r--r-- | src/modules/file/libkvifile.cpp | 28 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_file.cpp | 12 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_label.cpp | 32 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_layout.cpp | 8 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_lineEdit.cpp | 6 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_painter.cpp | 46 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_slider.cpp | 10 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_socket.cpp | 8 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_trayIcon.cpp | 18 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_vBox.cpp | 16 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_widget.cpp | 90 |
15 files changed, 156 insertions, 153 deletions
diff --git a/admin/doc.css b/admin/doc.css index 5fcc6b698..489ae3a6d 100644 --- a/admin/doc.css +++ b/admin/doc.css @@ -26,6 +26,9 @@ a:hover { text-decoration: underline; color: #186CC4; } +pre { + white-space: normal; +} a:active { text-decoration: underline; color: #186CC4; diff --git a/admin/gendoc.pl b/admin/gendoc.pl index 7fb4d7abc..a29ad72e8 100755 --- a/admin/gendoc.pl +++ b/admin/gendoc.pl @@ -790,7 +790,7 @@ sub process_file # Process example code blocks if($iExampleState eq 0) { - if(($_ =~ /\[example\]*/) && (!($_ =~ /\[\/example\]*/))) + if(($_ =~ /\[(example|pre)\]*/) && (!($_ =~ /\[\/(example|pre)\]*/))) { $iExampleState = 1; $szExampleTabBlock = ""; @@ -802,7 +802,7 @@ sub process_file $_ =~ s/^$szExampleTabBlock//g; } - if(($_ =~ /\[\/example\]*/)) + if(($_ =~ /\[\/(example|pre)\]*/)) { $iExampleState = 0; } else { diff --git a/src/kvilib/irc/KviIrcMask.cpp b/src/kvilib/irc/KviIrcMask.cpp index ddc79c720..b81abd717 100644 --- a/src/kvilib/irc/KviIrcMask.cpp +++ b/src/kvilib/irc/KviIrcMask.cpp @@ -55,12 +55,12 @@ this is rather server specific protocol, but the prefixes are somewhat standardized and the common meanings of them are:[br] [pre] - noprefix: I line with Ident[br] - ^: I line with OTHER type Ident[br] - ~: I line, no Ident[br] - +: i line with Ident[br] - =: i line with OTHER type Ident[br] - -: i line, no Ident[br] + noprefix: I line with Ident + ^: I line with OTHER type Ident + ~: I line, no Ident + +: i line with Ident + =: i line with OTHER type Ident + -: i line, no Ident [/pre] So finally you can find <username> strings like [i]~pragma[/i] or [i]^pragma[/i], where [i]pragma[/i] is the system username of the irc-user and ~ and ^ are prefixes.[br] diff --git a/src/kvirc/sparser/KviIrcServerParser_ctcp.cpp b/src/kvirc/sparser/KviIrcServerParser_ctcp.cpp index 180182752..c38db5b28 100644 --- a/src/kvirc/sparser/KviIrcServerParser_ctcp.cpp +++ b/src/kvirc/sparser/KviIrcServerParser_ctcp.cpp @@ -363,14 +363,14 @@ extern KVIRC_API KviCtcpPageDialog * g_pCtcpPageDialog; The DCC tag is used to initiate a Direct Client Connection. The known DCC types are:[br] [pre] - CHAT[br] - SEND[br] - SSEND[br] - TSEND[br] - GET[br] - TGET[br] - ACCEPT[br] - RESUME[br] + CHAT + SEND + SSEND + TSEND + GET + TGET + ACCEPT + RESUME [/pre] */ diff --git a/src/modules/file/libkvifile.cpp b/src/modules/file/libkvifile.cpp index 84d7d5d37..5dac7ba0f 100644 --- a/src/modules/file/libkvifile.cpp +++ b/src/modules/file/libkvifile.cpp @@ -707,20 +707,20 @@ static bool file_kvs_fnc_ps(KviKvsModuleFunctionCall * c) The <directory> should be given as a UNIX style path and is adjusted according to the system that KVIrc is running on.[br][br] <flags> may be a combination of the following characters:[br] [pre] - [b]d:[/b] list directories[br] - [b]f:[/b] list files[br] - [b]l:[/b] list symbolic links[br] - [b]r:[/b] list readable files[br] - [b]w:[/b] list writable files[br] - [b]x:[/b] list executable files[br] - [b]h:[/b] list hidden files[br] - [b]s:[/b] list system files[br] - [b]n:[/b] sort files by name[br] - [b]t:[/b] sort files by file time[br] - [b]b:[/b] sort files by file size[br] - [b]z:[/b] put the directories first, then the files[br] - [b]k:[/b] invert sort order[br] - [b]i:[/b] case insensitive sort[br] + [b]d:[/b] list directories + [b]f:[/b] list files + [b]l:[/b] list symbolic links + [b]r:[/b] list readable files + [b]w:[/b] list writable files + [b]x:[/b] list executable files + [b]h:[/b] list hidden files + [b]s:[/b] list system files + [b]n:[/b] sort files by name + [b]t:[/b] sort files by file time + [b]b:[/b] sort files by file size + [b]z:[/b] put the directories first, then the files + [b]k:[/b] invert sort order + [b]i:[/b] case insensitive sort [/pre] If <flags> is empty, then a default of [b]dfrwxhs[/b] is set. If none of the [b]r[/b],[b]w[/b],[b]x[/b] flags are set then KVIrc sets all of them by default.[br][br] If <namefilter> is passed then it is interpreted as a wildcard string diff --git a/src/modules/objects/KvsObject_file.cpp b/src/modules/objects/KvsObject_file.cpp index d0f773b85..449e32fbc 100644 --- a/src/modules/objects/KvsObject_file.cpp +++ b/src/modules/objects/KvsObject_file.cpp @@ -93,12 +93,12 @@ const QIODevice::OpenMode mod_cod[] = { Attempts to open the file in specified mode or modes [i]sum[/i]. Valid modes are:[br] [pre] - RAW - RAW, non-buffered access[br] - ReadOnly - opens the file read-only[br] - WriteOnly - opens the file write-only[br] - ReadWrite - opens the file in read-write mode[br] - Append - opens the file in append mode. The file index is set to the end of the file.[br] - Truncate - truncates the file[br] + RAW - RAW, non-buffered access + ReadOnly - opens the file read-only + WriteOnly - opens the file write-only + ReadWrite - opens the file in read-write mode + Append - opens the file in append mode. The file index is set to the end of the file. + Truncate - truncates the file [/pre] If you call this function without any parameters, the file is opened in read-only mode.[br] diff --git a/src/modules/objects/KvsObject_label.cpp b/src/modules/objects/KvsObject_label.cpp index 6d9ebf848..da4744cbd 100644 --- a/src/modules/objects/KvsObject_label.cpp +++ b/src/modules/objects/KvsObject_label.cpp @@ -120,21 +120,21 @@ const int frame_cod[] = { Returns a string containing alignment flags that are set for this label. The flags are separated by commas.[br] An example output could look like this:[br] - [pre]Bottom, Right[/pre][br] + [pre]Bottom, Right[/pre] See [classfnc]$setAlignment[/classfnc]() for explanation of all alignment flags. !fn: $setAlignment(<flag1:string>, <flag2:string>, ...) This function sets alignment flags, given as parameters, for this label. Valid flags are: [pre] - Right - Text is aligned to right border[br] - Left - Text is aligned to left border[br] - Top - Text is aligned to the top border[br] - Bottom - Text is aligned to the bottom border[br] - HCenter - Text is horizontally centered[br] - VCenter - Text is vertically centered[br] - Center - Equals HCenter + VCenter[br] - Justify - Text is spaced apart to cover available room[br] + Right - Text is aligned to right border + Left - Text is aligned to left border + Top - Text is aligned to the top border + Bottom - Text is aligned to the bottom border + HCenter - Text is horizontally centered + VCenter - Text is vertically centered + Center - Equals HCenter + VCenter + Justify - Text is spaced apart to cover available room [/pre] It is obvious that you can not set [i]Right[/i] and [i]Left[/i] simultaneously - this will [b]not[/b] @@ -153,17 +153,17 @@ 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 using this.[br] - 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 [i]Raised[/i] or [i]Sunken[/i][br] - WinPanel - Similar to [i]Panel[/i], but is more in Win95 style[br] + NoFrame - Draw no frame. You shouldn't specify a shadow when using this. + Box - Draws a rectangular box. Its borders can be [i]Raised[/i] or [i]Sunken[/i] + Panel - Draws a rectangular panel which can be [i]Raised[/i] or [i]Sunken[/i] + WinPanel - Similar to [i]Panel[/i], but is more in Win95 style 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 parent widget[br] - Sunken - Makes the label look like it was [i]pushed[/i] inside the parent widget[br] + Plain - No 3D effect (draws using foreground color) + Raised - Makes the label look like it was raised above the parent widget + Sunken - Makes the label look like it was [i]pushed[/i] inside the parent widget [/pre] !fn: $setImage(<image_id>) Sets the image to be displayed on this label. diff --git a/src/modules/objects/KvsObject_layout.cpp b/src/modules/objects/KvsObject_layout.cpp index 2c57a60fd..b48e5b2e7 100644 --- a/src/modules/objects/KvsObject_layout.cpp +++ b/src/modules/objects/KvsObject_layout.cpp @@ -98,10 +98,10 @@ const int align_cod[] = { Sets the resize mode of the parent widget in relation to this layout. <mode> can be one of:[br] [pre] - -Auto: this is the default[br] - -Fixed: the parent widget of this layout is resized to the "sizeHint" value and it cannot be resized by the user.[br] - -Minimum: the minimum size of the parent widget of this layout is set to minimumSize() and it cannot be smaller[br] - -FreeResize: the parent widget of this layout is not constrained at all[br] + -Auto: this is the default + -Fixed: the parent widget of this layout is resized to the "sizeHint" value and it cannot be resized by the user. + -Minimum: the minimum size of the parent widget of this layout is set to minimumSize() and it cannot be smaller + -FreeResize: the parent widget of this layout is not constrained at all [/pre] */ diff --git a/src/modules/objects/KvsObject_lineEdit.cpp b/src/modules/objects/KvsObject_lineEdit.cpp index 8af1498ce..daeea0142 100644 --- a/src/modules/objects/KvsObject_lineEdit.cpp +++ b/src/modules/objects/KvsObject_lineEdit.cpp @@ -72,9 +72,9 @@ static const int mode_cod[] = { !fn: $setEchoMode(<echo_mode:string>) Sets the line edit's echo mode. Possible value are:[br] [pre] - -Normal: display chars as they entered[br] - -Noecho: do not display anything[br] - -Password: display asterisks instead of the characters actually entered[br] + -Normal: display chars as they entered + -Noecho: do not display anything + -Password: display asterisks instead of the characters actually entered [/pre] See also [classfnc]$echoMode[/classfnc](). !fn: <string> $echoMode() diff --git a/src/modules/objects/KvsObject_painter.cpp b/src/modules/objects/KvsObject_painter.cpp index 2c447d368..084cd9123 100644 --- a/src/modules/objects/KvsObject_painter.cpp +++ b/src/modules/objects/KvsObject_painter.cpp @@ -235,10 +235,10 @@ const char * const brushstyles_tbl[] = { All parameters are in integer form. The HSV system, like RGB, has three components:[br] [pre] - * H, for hue, is either 0-359 if the color is chromatic (not gray), or meaningless if it is gray.[br] - It represents degrees on the color wheel familiar to most people. Red is 0 (degrees), green is 120 and blue is 240.[br] - * S, for saturation, is 0-255, and the bigger it is, the stronger the color is. Grayish colors have saturation near 0; very strong colors have saturation near 255.[br] - * V, for value, is 0-255 and represents lightness or brightness of the color. 0 is black; 255 is as far from black as possible.[br] + * H, for hue, is either 0-359 if the color is chromatic (not gray), or meaningless if it is gray. + It represents degrees on the color wheel familiar to most people. Red is 0 (degrees), green is 120 and blue is 240. + * S, for saturation, is 0-255, and the bigger it is, the stronger the color is. Grayish colors have saturation near 0; very strong colors have saturation near 255. + * V, for value, is 0-255 and represents lightness or brightness of the color. 0 is black; 255 is as far from black as possible. [/pre] Examples: [b]Red[/b] is H=0, S=255, V=255.[br] Light red could have H about 0, S about 50-100, and S=255. @@ -284,17 +284,17 @@ const char * const brushstyles_tbl[] = { Draws the given <text> within the rectangle specified by <x>,<y> <width> and <height>.[br] The <flag> parameters may be:[br] [pre] - Left[br] - Top[br] - Right[br] - Bottom[br] - HCenter[br] - VCenter[br] - Center[br] - TextSingleLine[br] - TextExpandTabs[br] - TextShowMnemonic[br] - TextWordWrap[br] + Left + Top + Right + Bottom + HCenter + VCenter + Center + TextSingleLine + TextExpandTabs + TextShowMnemonic + TextWordWrap TextIncludeTrailingSpaces [/pre] !fn: $drawPixmap(<x:integer>,<y:integer>,<pixmap:hobject>,<sx:integer>,<sy:integer>,<ex:integer>,<ey:integer>) @@ -302,12 +302,12 @@ const char * const brushstyles_tbl[] = { !fn: $setFont(<family:string>,<size:integer>[,<style:enum>,<style:enum>,..])[br] Set the font's family, size and style, valid flag for style are:[br] [pre] - italic[br] - bold [br] - underline [br] - overline [br] - strikeout [br] - fixedpitch [br] + italic + bold + underline + overline + strikeout + fixedpitch [/pre] !fn: $setFontSize(<size:unsigned integer>)[br] Set the current painter font's size.[br] @@ -333,7 +333,7 @@ const char * const brushstyles_tbl[] = { Sets the background mode of the painter to <bgMode>: Valid values are:[br] [pre] - - Transparent (that is the default value);[br] + - Transparent (that is the default value); - Opaque. [/pre] !fn: $setOpacity(<opacity_factor:real>) @@ -418,7 +418,7 @@ const char * const brushstyles_tbl[] = { if ($$->%scrollright >= 550) return %P->$scale(0.$$->%Zoomindex,0.$$->%Zoomindex) %P->$translate(400,350) - %P->$drawText($$->%scrollright,10,"Another cool class brought to you by...",-1,Auto) + %P->$drawText($$->%scrollright,10,"Another cool class brought to you by...",-1,Auto) $$->%scrollright += 3; %P->$reset() } diff --git a/src/modules/objects/KvsObject_slider.cpp b/src/modules/objects/KvsObject_slider.cpp index 73b71937e..b36350810 100644 --- a/src/modules/objects/KvsObject_slider.cpp +++ b/src/modules/objects/KvsObject_slider.cpp @@ -67,11 +67,11 @@ Sets the tickmark settings for this slider.[br] Values are:[br] [pre] - NoMarks - do not draw any tickmarks.[br] - Both - draw tickmarks on both sides of the groove.[br] - Above - draw tickmarks above the (horizontal) slider[br] - Below - draw tickmarks below the (horizontal) slider[br] - Left - draw tickmarks to the left of the (vertical) slider[br] + NoMarks - do not draw any tickmarks. + Both - draw tickmarks on both sides of the groove. + Above - draw tickmarks above the (horizontal) slider + Below - draw tickmarks below the (horizontal) slider + Left - draw tickmarks to the left of the (vertical) slider Right - draw tickmarks to the right of the (vertical) slider [/pre] !fn: $setTickInterval(<value>) diff --git a/src/modules/objects/KvsObject_socket.cpp b/src/modules/objects/KvsObject_socket.cpp index 92f2e3db9..d53fda4ff 100644 --- a/src/modules/objects/KvsObject_socket.cpp +++ b/src/modules/objects/KvsObject_socket.cpp @@ -101,10 +101,10 @@ const char * const sockerrors_tbl[] = { [pre] 0 = Unconnected 1 = HostLookUp - 2 = Connecting[br] - 3 = Connected[br] - 4 = Bound[br] - 5 = Closing[br] + 2 = Connecting + 3 = Connected + 4 = Bound + 5 = Closing 6 = Listening [/pre] !fn: $connect(<host>,<port>) diff --git a/src/modules/objects/KvsObject_trayIcon.cpp b/src/modules/objects/KvsObject_trayIcon.cpp index 127be0065..d09523888 100644 --- a/src/modules/objects/KvsObject_trayIcon.cpp +++ b/src/modules/objects/KvsObject_trayIcon.cpp @@ -62,10 +62,10 @@ Message can be clicked by the user; the messageClickedEvent() will be triggered when this occurs.[br] Valid values for message_icon are: [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] + - NoIcon : No icon is shown. + - Information : An information icon is shown. + - Warning : A standard warning icon is shown. + - Critical : A critical warning icon is shown. [/pre] !fn: setContextMenu(<popupmenu:hobject>). Associates the given <popupmenu> with the tray icon. @@ -74,11 +74,11 @@ If you reimplement this function the reason parameter will be passed as $0. Values for reason are:[br] [pre] - - 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] + - Unknown : Unknown reason. + - Context : The context menu for the tray icon was requested. + - DoubleClick : The tray icon was double clicked. + - Trigger : The tray icon was clicked. + - MiddleClick : The tray icon was clicked with the middle mouse button. [/pre] The default implementation emits the [classfnc]$activated[/classfnc]() signal. !fn: messageClickedEvent() diff --git a/src/modules/objects/KvsObject_vBox.cpp b/src/modules/objects/KvsObject_vBox.cpp index 76f750fc1..61464bfe7 100644 --- a/src/modules/objects/KvsObject_vBox.cpp +++ b/src/modules/objects/KvsObject_vBox.cpp @@ -82,15 +82,15 @@ const int align_cod[] = { Adds a stretchable space with zero minimum size and stretch factor stretch to the end of this box layout. !fn: $setAlignment(<flag1:string>, <flag2:string>, ...) Sets the alignment for widget w to flags, given as parameters.[br] - Valid flags are:[br] + Valid flags are: [pre] - Right[br] - Left[br] - Top[br] - Bottom[br] - HCenter[br] - VCenter[br] - Center[br] + Right + Left + Top + Bottom + HCenter + VCenter + Center Justify [/pre] */ diff --git a/src/modules/objects/KvsObject_widget.cpp b/src/modules/objects/KvsObject_widget.cpp index eb3009a2b..a8b1e3ac6 100644 --- a/src/modules/objects/KvsObject_widget.cpp +++ b/src/modules/objects/KvsObject_widget.cpp @@ -422,15 +422,15 @@ const char * const widgettypes_tbl[] = { This function sets widget flags, given as parameters. Valid flags are: [pre] - TopLevel - indicates that this widget is a top-level widget[br] - Dialog - indicates that this widget is a top-level window that should be decorated as a dialog[br] - Desktop - indicates that this widget is the desktop[br] - Popup - indicates that this widget is a popup top-level window[br] - Title - gives the window a title bar[br] - StaysOnTop - window stays on top [br] - SysMenu - add a windows system menu[br] - Minimize - add a minimize button for the sysmenu style[br] - Maximize - add a maximize button for the sysmenu style[br] + TopLevel - indicates that this widget is a top-level widget + Dialog - indicates that this widget is a top-level window that should be decorated as a dialog + Desktop - indicates that this widget is the desktop + Popup - indicates that this widget is a popup top-level window + Title - gives the window a title bar + StaysOnTop - window stays on top + SysMenu - add a windows system menu + Minimize - add a minimize button for the sysmenu style + Maximize - add a maximize button for the sysmenu style [/pre] !fn: $centerToScreen() Centers the window on the screen (useful only for toplevel widgets).[br] @@ -439,48 +439,48 @@ const char * const widgettypes_tbl[] = { Sets the way the widget accepts keyboard focus.[br] Valid parameters are: [pre] - - TabFocus; (widget accepts keyboard focus by tabbing)[br] - - ClickFocus; (widget accepts keyboard focus by clicking)[br] - - StrongFocus; (widget accepts both tabbing/clicking)[br] - - No Focus; (widget does not accept focus at all; this is the default value)[br] + - TabFocus; (widget accepts keyboard focus by tabbing) + - ClickFocus; (widget accepts keyboard focus by clicking) + - StrongFocus; (widget accepts both tabbing/clicking) + - No Focus; (widget does not accept focus at all; this is the default value) [/pre] !fn: $keyPressEvent(<key>) If widget accepts keyboard focus (see [classfnc]$setFocusPolicy[/classfnc] ) this function handles for keys; In its argument the key pressed.[br] Special keys are: [pre] - - Return [br] - - Enter [br] - - Down (cursor arrow down) [br] - - Up (cursor arrow up) [br] - - Left (cursor arrow left) [br] - - Right (cursor arrow right) [br] - - Shift [br] - - Ctrl [br] - - Alt [br] - - CapsLock [br] - - Backspace [br] - - Del [br] - - Esc [br] - - 0 [br] - - 1 [br] - - 2 [br] - - 3 [br] - - 4 [br] - - 5 [br] - - 6 [br] - - 7 [br] - - 8 [br] - - 9 [br] - - + [br] - - - [br] - - * [br] - - / [br] - - ( [br] - - ) [br] - - = [br] - - . [br] - - ^ [br] + - Return + - Enter + - Down (cursor arrow down) + - Up (cursor arrow up) + - Left (cursor arrow left) + - Right (cursor arrow right) + - Shift + - Ctrl + - Alt + - CapsLock + - Backspace + - Del + - Esc + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - + + - - + - * + - / + - ( + - ) + - = + - . + - ^ [/pre] !fn: $mapFromGlobal(<x>,<y>) Translates the global screen coordinate pos to widget coordinates. |
