<!--{{{-->
<link rel='alternate' type='application/rss+xml' title='RSS' href='index.xml' />
<!--}}}-->
Background: #fff
Foreground: #000
PrimaryPale: #8cf
PrimaryLight: #18f
PrimaryMid: #04b
PrimaryDark: #014
SecondaryPale: #ffc
SecondaryLight: #fe8
SecondaryMid: #db4
SecondaryDark: #841
TertiaryPale: #eee
TertiaryLight: #ccc
TertiaryMid: #999
TertiaryDark: #666
Error: #f88
/*{{{*/
body {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];}

a {color:[[ColorPalette::PrimaryMid]];}
a:hover {background-color:[[ColorPalette::PrimaryMid]]; color:[[ColorPalette::Background]];}
a img {border:0;}

h1,h2,h3,h4,h5,h6 {color:[[ColorPalette::SecondaryDark]]; background:transparent;}
h1 {border-bottom:2px solid [[ColorPalette::TertiaryLight]];}
h2,h3 {border-bottom:1px solid [[ColorPalette::TertiaryLight]];}

.button {color:[[ColorPalette::PrimaryDark]]; border:1px solid [[ColorPalette::Background]];}
.button:hover {color:[[ColorPalette::PrimaryDark]]; background:[[ColorPalette::SecondaryLight]]; border-color:[[ColorPalette::SecondaryMid]];}
.button:active {color:[[ColorPalette::Background]]; background:[[ColorPalette::SecondaryMid]]; border:1px solid [[ColorPalette::SecondaryDark]];}

.header {background:[[ColorPalette::PrimaryMid]];}
.headerShadow {color:[[ColorPalette::Foreground]];}
.headerShadow a {font-weight:normal; color:[[ColorPalette::Foreground]];}
.headerForeground {color:[[ColorPalette::Background]];}
.headerForeground a {font-weight:normal; color:[[ColorPalette::PrimaryPale]];}

.tabSelected{color:[[ColorPalette::PrimaryDark]];
	background:[[ColorPalette::TertiaryPale]];
	border-left:1px solid [[ColorPalette::TertiaryLight]];
	border-top:1px solid [[ColorPalette::TertiaryLight]];
	border-right:1px solid [[ColorPalette::TertiaryLight]];
}
.tabUnselected {color:[[ColorPalette::Background]]; background:[[ColorPalette::TertiaryMid]];}
.tabContents {color:[[ColorPalette::PrimaryDark]]; background:[[ColorPalette::TertiaryPale]]; border:1px solid [[ColorPalette::TertiaryLight]];}
.tabContents .button {border:0;}

#sidebar {}
#sidebarOptions input {border:1px solid [[ColorPalette::PrimaryMid]];}
#sidebarOptions .sliderPanel {background:[[ColorPalette::PrimaryPale]];}
#sidebarOptions .sliderPanel a {border:none;color:[[ColorPalette::PrimaryMid]];}
#sidebarOptions .sliderPanel a:hover {color:[[ColorPalette::Background]]; background:[[ColorPalette::PrimaryMid]];}
#sidebarOptions .sliderPanel a:active {color:[[ColorPalette::PrimaryMid]]; background:[[ColorPalette::Background]];}

.wizard {background:[[ColorPalette::PrimaryPale]]; border:1px solid [[ColorPalette::PrimaryMid]];}
.wizard h1 {color:[[ColorPalette::PrimaryDark]]; border:none;}
.wizard h2 {color:[[ColorPalette::Foreground]]; border:none;}
.wizardStep {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];
	border:1px solid [[ColorPalette::PrimaryMid]];}
.wizardStep.wizardStepDone {background:[[ColorPalette::TertiaryLight]];}
.wizardFooter {background:[[ColorPalette::PrimaryPale]];}
.wizardFooter .status {background:[[ColorPalette::PrimaryDark]]; color:[[ColorPalette::Background]];}
.wizard .button {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::SecondaryLight]]; border: 1px solid;
	border-color:[[ColorPalette::SecondaryPale]] [[ColorPalette::SecondaryDark]] [[ColorPalette::SecondaryDark]] [[ColorPalette::SecondaryPale]];}
.wizard .button:hover {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::Background]];}
.wizard .button:active {color:[[ColorPalette::Background]]; background:[[ColorPalette::Foreground]]; border: 1px solid;
	border-color:[[ColorPalette::PrimaryDark]] [[ColorPalette::PrimaryPale]] [[ColorPalette::PrimaryPale]] [[ColorPalette::PrimaryDark]];}

.wizard .notChanged {background:transparent;}
.wizard .changedLocally {background:#80ff80;}
.wizard .changedServer {background:#8080ff;}
.wizard .changedBoth {background:#ff8080;}
.wizard .notFound {background:#ffff80;}
.wizard .putToServer {background:#ff80ff;}
.wizard .gotFromServer {background:#80ffff;}

#messageArea {border:1px solid [[ColorPalette::SecondaryMid]]; background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]];}
#messageArea .button {color:[[ColorPalette::PrimaryMid]]; background:[[ColorPalette::SecondaryPale]]; border:none;}

.popupTiddler {background:[[ColorPalette::TertiaryPale]]; border:2px solid [[ColorPalette::TertiaryMid]];}

.popup {background:[[ColorPalette::TertiaryPale]]; color:[[ColorPalette::TertiaryDark]]; border-left:1px solid [[ColorPalette::TertiaryMid]]; border-top:1px solid [[ColorPalette::TertiaryMid]]; border-right:2px solid [[ColorPalette::TertiaryDark]]; border-bottom:2px solid [[ColorPalette::TertiaryDark]];}
.popup hr {color:[[ColorPalette::PrimaryDark]]; background:[[ColorPalette::PrimaryDark]]; border-bottom:1px;}
.popup li.disabled {color:[[ColorPalette::TertiaryMid]];}
.popup li a, .popup li a:visited {color:[[ColorPalette::Foreground]]; border: none;}
.popup li a:hover {background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]]; border: none;}
.popup li a:active {background:[[ColorPalette::SecondaryPale]]; color:[[ColorPalette::Foreground]]; border: none;}
.popupHighlight {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];}
.listBreak div {border-bottom:1px solid [[ColorPalette::TertiaryDark]];}

.tiddler .defaultCommand {font-weight:bold;}

.shadow .title {color:[[ColorPalette::TertiaryDark]];}

.title {color:[[ColorPalette::SecondaryDark]];}
.subtitle {color:[[ColorPalette::TertiaryDark]];}

.toolbar {color:[[ColorPalette::PrimaryMid]];}
.toolbar a {color:[[ColorPalette::TertiaryLight]];}
.selected .toolbar a {color:[[ColorPalette::TertiaryMid]];}
.selected .toolbar a:hover {color:[[ColorPalette::Foreground]];}

.tagging, .tagged {border:1px solid [[ColorPalette::TertiaryPale]]; background-color:[[ColorPalette::TertiaryPale]];}
.selected .tagging, .selected .tagged {background-color:[[ColorPalette::TertiaryLight]]; border:1px solid [[ColorPalette::TertiaryMid]];}
.tagging .listTitle, .tagged .listTitle {color:[[ColorPalette::PrimaryDark]];}
.tagging .button, .tagged .button {border:none;}

.footer {color:[[ColorPalette::TertiaryLight]];}
.selected .footer {color:[[ColorPalette::TertiaryMid]];}

.sparkline {background:[[ColorPalette::PrimaryPale]]; border:0;}
.sparktick {background:[[ColorPalette::PrimaryDark]];}

.error, .errorButton {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::Error]];}
.warning {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::SecondaryPale]];}
.lowlight {background:[[ColorPalette::TertiaryLight]];}

.zoomer {background:none; color:[[ColorPalette::TertiaryMid]]; border:3px solid [[ColorPalette::TertiaryMid]];}

.imageLink, #displayArea .imageLink {background:transparent;}

.annotation {background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]]; border:2px solid [[ColorPalette::SecondaryMid]];}

.viewer .listTitle {list-style-type:none; margin-left:-2em;}
.viewer .button {border:1px solid [[ColorPalette::SecondaryMid]];}
.viewer blockquote {border-left:3px solid [[ColorPalette::TertiaryDark]];}

.viewer table, table.twtable {border:2px solid [[ColorPalette::TertiaryDark]];}
.viewer th, .viewer thead td, .twtable th, .twtable thead td {background:[[ColorPalette::SecondaryMid]]; border:1px solid [[ColorPalette::TertiaryDark]]; color:[[ColorPalette::Background]];}
.viewer td, .viewer tr, .twtable td, .twtable tr {border:1px solid [[ColorPalette::TertiaryDark]];}

.viewer pre {border:1px solid [[ColorPalette::SecondaryLight]]; background:[[ColorPalette::SecondaryPale]];}
.viewer code {color:[[ColorPalette::SecondaryDark]];}
.viewer hr {border:0; border-top:dashed 1px [[ColorPalette::TertiaryDark]]; color:[[ColorPalette::TertiaryDark]];}

.highlight, .marked {background:[[ColorPalette::SecondaryLight]];}

.editor input {border:1px solid [[ColorPalette::PrimaryMid]];}
.editor textarea {border:1px solid [[ColorPalette::PrimaryMid]]; width:100%;}
.editorFooter {color:[[ColorPalette::TertiaryMid]];}
.readOnly {background:[[ColorPalette::TertiaryPale]];}

#backstageArea {background:[[ColorPalette::Foreground]]; color:[[ColorPalette::TertiaryMid]];}
#backstageArea a {background:[[ColorPalette::Foreground]]; color:[[ColorPalette::Background]]; border:none;}
#backstageArea a:hover {background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]]; }
#backstageArea a.backstageSelTab {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];}
#backstageButton a {background:none; color:[[ColorPalette::Background]]; border:none;}
#backstageButton a:hover {background:[[ColorPalette::Foreground]]; color:[[ColorPalette::Background]]; border:none;}
#backstagePanel {background:[[ColorPalette::Background]]; border-color: [[ColorPalette::Background]] [[ColorPalette::TertiaryDark]] [[ColorPalette::TertiaryDark]] [[ColorPalette::TertiaryDark]];}
.backstagePanelFooter .button {border:none; color:[[ColorPalette::Background]];}
.backstagePanelFooter .button:hover {color:[[ColorPalette::Foreground]];}
#backstageCloak {background:[[ColorPalette::Foreground]]; opacity:0.6; filter:'alpha(opacity=60)';}
/*}}}*/
/*{{{*/
* html .tiddler {height:1%;}

body {font-size:.75em; font-family:arial,helvetica; margin:0; padding:0;}

h1,h2,h3,h4,h5,h6 {font-weight:bold; text-decoration:none;}
h1,h2,h3 {padding-bottom:1px; margin-top:1.2em;margin-bottom:0.3em;}
h4,h5,h6 {margin-top:1em;}
h1 {font-size:1.35em;}
h2 {font-size:1.25em;}
h3 {font-size:1.1em;}
h4 {font-size:1em;}
h5 {font-size:.9em;}

hr {height:1px;}

a {text-decoration:none;}

dt {font-weight:bold;}

ol {list-style-type:decimal;}
ol ol {list-style-type:lower-alpha;}
ol ol ol {list-style-type:lower-roman;}
ol ol ol ol {list-style-type:decimal;}
ol ol ol ol ol {list-style-type:lower-alpha;}
ol ol ol ol ol ol {list-style-type:lower-roman;}
ol ol ol ol ol ol ol {list-style-type:decimal;}

.txtOptionInput {width:11em;}

#contentWrapper .chkOptionInput {border:0;}

.externalLink {text-decoration:underline;}

.indent {margin-left:3em;}
.outdent {margin-left:3em; text-indent:-3em;}
code.escaped {white-space:nowrap;}

.tiddlyLinkExisting {font-weight:bold;}
.tiddlyLinkNonExisting {font-style:italic;}

/* the 'a' is required for IE, otherwise it renders the whole tiddler in bold */
a.tiddlyLinkNonExisting.shadow {font-weight:bold;}

#mainMenu .tiddlyLinkExisting,
	#mainMenu .tiddlyLinkNonExisting,
	#sidebarTabs .tiddlyLinkNonExisting {font-weight:normal; font-style:normal;}
#sidebarTabs .tiddlyLinkExisting {font-weight:bold; font-style:normal;}

.header {position:relative;}
.header a:hover {background:transparent;}
.headerShadow {position:relative; padding:4.5em 0 1em 1em; left:-1px; top:-1px;}
.headerForeground {position:absolute; padding:4.5em 0 1em 1em; left:0px; top:0px;}

.siteTitle {font-size:3em;}
.siteSubtitle {font-size:1.2em;}

#mainMenu {position:absolute; left:0; width:10em; text-align:right; line-height:1.6em; padding:1.5em 0.5em 0.5em 0.5em; font-size:1.1em;}

#sidebar {position:absolute; right:3px; width:16em; font-size:.9em;}
#sidebarOptions {padding-top:0.3em;}
#sidebarOptions a {margin:0 0.2em; padding:0.2em 0.3em; display:block;}
#sidebarOptions input {margin:0.4em 0.5em;}
#sidebarOptions .sliderPanel {margin-left:1em; padding:0.5em; font-size:.85em;}
#sidebarOptions .sliderPanel a {font-weight:bold; display:inline; padding:0;}
#sidebarOptions .sliderPanel input {margin:0 0 0.3em 0;}
#sidebarTabs .tabContents {width:15em; overflow:hidden;}

.wizard {padding:0.1em 1em 0 2em;}
.wizard h1 {font-size:2em; font-weight:bold; background:none; padding:0; margin:0.4em 0 0.2em;}
.wizard h2 {font-size:1.2em; font-weight:bold; background:none; padding:0; margin:0.4em 0 0.2em;}
.wizardStep {padding:1em 1em 1em 1em;}
.wizard .button {margin:0.5em 0 0; font-size:1.2em;}
.wizardFooter {padding:0.8em 0.4em 0.8em 0;}
.wizardFooter .status {padding:0 0.4em; margin-left:1em;}
.wizard .button {padding:0.1em 0.2em;}

#messageArea {position:fixed; top:2em; right:0; margin:0.5em; padding:0.5em; z-index:2000; _position:absolute;}
.messageToolbar {display:block; text-align:right; padding:0.2em;}
#messageArea a {text-decoration:underline;}

.tiddlerPopupButton {padding:0.2em;}
.popupTiddler {position: absolute; z-index:300; padding:1em; margin:0;}

.popup {position:absolute; z-index:300; font-size:.9em; padding:0; list-style:none; margin:0;}
.popup .popupMessage {padding:0.4em;}
.popup hr {display:block; height:1px; width:auto; padding:0; margin:0.2em 0;}
.popup li.disabled {padding:0.4em;}
.popup li a {display:block; padding:0.4em; font-weight:normal; cursor:pointer;}
.listBreak {font-size:1px; line-height:1px;}
.listBreak div {margin:2px 0;}

.tabset {padding:1em 0 0 0.5em;}
.tab {margin:0 0 0 0.25em; padding:2px;}
.tabContents {padding:0.5em;}
.tabContents ul, .tabContents ol {margin:0; padding:0;}
.txtMainTab .tabContents li {list-style:none;}
.tabContents li.listLink { margin-left:.75em;}

#contentWrapper {display:block;}
#splashScreen {display:none;}

#displayArea {margin:1em 17em 0 14em;}

.toolbar {text-align:right; font-size:.9em;}

.tiddler {padding:1em 1em 0;}

.missing .viewer,.missing .title {font-style:italic;}

.title {font-size:1.6em; font-weight:bold;}

.missing .subtitle {display:none;}
.subtitle {font-size:1.1em;}

.tiddler .button {padding:0.2em 0.4em;}

.tagging {margin:0.5em 0.5em 0.5em 0; float:left; display:none;}
.isTag .tagging {display:block;}
.tagged {margin:0.5em; float:right;}
.tagging, .tagged {font-size:0.9em; padding:0.25em;}
.tagging ul, .tagged ul {list-style:none; margin:0.25em; padding:0;}
.tagClear {clear:both;}

.footer {font-size:.9em;}
.footer li {display:inline;}

.annotation {padding:0.5em; margin:0.5em;}

* html .viewer pre {width:99%; padding:0 0 1em 0;}
.viewer {line-height:1.4em; padding-top:0.5em;}
.viewer .button {margin:0 0.25em; padding:0 0.25em;}
.viewer blockquote {line-height:1.5em; padding-left:0.8em;margin-left:2.5em;}
.viewer ul, .viewer ol {margin-left:0.5em; padding-left:1.5em;}

.viewer table, table.twtable {border-collapse:collapse; margin:0.8em 1.0em;}
.viewer th, .viewer td, .viewer tr,.viewer caption,.twtable th, .twtable td, .twtable tr,.twtable caption {padding:3px;}
table.listView {font-size:0.85em; margin:0.8em 1.0em;}
table.listView th, table.listView td, table.listView tr {padding:0px 3px 0px 3px;}

.viewer pre {padding:0.5em; margin-left:0.5em; font-size:1.2em; line-height:1.4em; overflow:auto;}
.viewer code {font-size:1.2em; line-height:1.4em;}

.editor {font-size:1.1em;}
.editor input, .editor textarea {display:block; width:100%; font:inherit;}
.editorFooter {padding:0.25em 0; font-size:.9em;}
.editorFooter .button {padding-top:0px; padding-bottom:0px;}

.fieldsetFix {border:0; padding:0; margin:1px 0px;}

.sparkline {line-height:1em;}
.sparktick {outline:0;}

.zoomer {font-size:1.1em; position:absolute; overflow:hidden;}
.zoomer div {padding:1em;}

* html #backstage {width:99%;}
* html #backstageArea {width:99%;}
#backstageArea {display:none; position:relative; overflow: hidden; z-index:150; padding:0.3em 0.5em;}
#backstageToolbar {position:relative;}
#backstageArea a {font-weight:bold; margin-left:0.5em; padding:0.3em 0.5em;}
#backstageButton {display:none; position:absolute; z-index:175; top:0; right:0;}
#backstageButton a {padding:0.1em 0.4em; margin:0.1em;}
#backstage {position:relative; width:100%; z-index:50;}
#backstagePanel {display:none; z-index:100; position:absolute; width:90%; margin-left:3em; padding:1em;}
.backstagePanelFooter {padding-top:0.2em; float:right;}
.backstagePanelFooter a {padding:0.2em 0.4em;}
#backstageCloak {display:none; z-index:20; position:absolute; width:100%; height:100px;}

.whenBackstage {display:none;}
.backstageVisible .whenBackstage {display:block;}
/*}}}*/
/***
StyleSheet for use when a translation requires any css style changes.
This StyleSheet can be used directly by languages such as Chinese, Japanese and Korean which need larger font sizes.
***/
/*{{{*/
body {font-size:0.8em;}
#sidebarOptions {font-size:1.05em;}
#sidebarOptions a {font-style:normal;}
#sidebarOptions .sliderPanel {font-size:0.95em;}
.subtitle {font-size:0.8em;}
.viewer table.listView {font-size:0.95em;}
/*}}}*/
/*{{{*/
@media print {
#mainMenu, #sidebar, #messageArea, .toolbar, #backstageButton, #backstageArea {display: none !important;}
#displayArea {margin: 1em 1em 0em;}
noscript {display:none;} /* Fixes a feature in Firefox 1.5.0.2 where print preview displays the noscript content */
}
/*}}}*/
<!--{{{-->
<div class='header' macro='gradient vert [[ColorPalette::PrimaryLight]] [[ColorPalette::PrimaryMid]]'>
<div class='headerShadow'>
<span class='siteTitle' refresh='content' tiddler='SiteTitle'></span>&nbsp;
<span class='siteSubtitle' refresh='content' tiddler='SiteSubtitle'></span>
</div>
<div class='headerForeground'>
<span class='siteTitle' refresh='content' tiddler='SiteTitle'></span>&nbsp;
<span class='siteSubtitle' refresh='content' tiddler='SiteSubtitle'></span>
</div>
</div>
<div id='mainMenu' refresh='content' tiddler='MainMenu'></div>
<div id='sidebar'>
<div id='sidebarOptions' refresh='content' tiddler='SideBarOptions'></div>
<div id='sidebarTabs' refresh='content' force='true' tiddler='SideBarTabs'></div>
</div>
<div id='displayArea'>
<div id='messageArea'></div>
<div id='tiddlerDisplay'></div>
</div>
<!--}}}-->
<!--{{{-->
<div class='toolbar' macro='toolbar [[ToolbarCommands::ViewToolbar]]'></div>
<div class='title' macro='view title'></div>
<div class='subtitle'><span macro='view modifier link'></span>, <span macro='view modified date'></span> (<span macro='message views.wikified.createdPrompt'></span> <span macro='view created date'></span>)</div>
<div class='tagging' macro='tagging'></div>
<div class='tagged' macro='tags'></div>
<div class='viewer' macro='view text wikified'></div>
<div class='tagClear'></div>
<!--}}}-->
<!--{{{-->
<div class='toolbar' macro='toolbar [[ToolbarCommands::EditToolbar]]'></div>
<div class='title' macro='view title'></div>
<div class='editor' macro='edit title'></div>
<div macro='annotations'></div>
<div class='editor' macro='edit text'></div>
<div class='editor' macro='edit tags'></div><div class='editorFooter'><span macro='message views.editor.tagPrompt'></span><span macro='tagChooser excludeLists'></span></div>
<!--}}}-->
To get started with this blank [[TiddlyWiki]], you'll need to modify the following tiddlers:
* [[SiteTitle]] & [[SiteSubtitle]]: The title and subtitle of the site, as shown above (after saving, they will also appear in the browser title bar)
* [[MainMenu]]: The menu (usually on the left)
* [[DefaultTiddlers]]: Contains the names of the tiddlers that you want to appear when the TiddlyWiki is opened
You'll also need to enter your username for signing your edits: <<option txtUserName>>
These [[InterfaceOptions]] for customising [[TiddlyWiki]] are saved in your browser

Your username for signing your edits. Write it as a [[WikiWord]] (eg [[JoeBloggs]])

<<option txtUserName>>
<<option chkSaveBackups>> [[SaveBackups]]
<<option chkAutoSave>> [[AutoSave]]
<<option chkRegExpSearch>> [[RegExpSearch]]
<<option chkCaseSensitiveSearch>> [[CaseSensitiveSearch]]
<<option chkAnimate>> [[EnableAnimations]]

----
Also see [[AdvancedOptions]]
<<importTiddlers>>
|!Constant|h
|{{{COLOR_BLACK}}}|
|{{{COLOR_RED}}}|
|{{{COLOR_GREEN}}}|
|{{{COLOR_YELLOW}}}|
|{{{COLOR_BLUE}}}|
|{{{COLOR_MAGENTA}}}|
|{{{COLOR_CYAN}}}|
|{{{COLOR_WHITE}}}|
|{{{A_NORMAL}}}|
|{{{A_STANDOUT}}}|
|{{{A_UNDERLINE}}}|
|{{{A_REVERSE}}}|
|{{{A_BLINK}}}|
|{{{A_DIM}}}|
|{{{A_BOLD}}}|
|{{{A_PROTECT}}}|
|{{{A_INVIS}}}|
|{{{A_ALTCHARSET}}}|
|{{{A_CHARTEXT}}}|
Background: #fff
Foreground: #000
PrimaryPale: #5a0
PrimaryLight: #4a0
PrimaryMid: #020
PrimaryDark: #390
SecondaryPale: #ffc
SecondaryLight: #af0
SecondaryMid: #340
SecondaryDark: #841
TertiaryPale: #eee
TertiaryLight: #ccc
TertiaryMid: #999
TertiaryDark: #666
Error: #f88
David Nichols is the author of the [[Qore programming language|http://qoretechnologies.com/qore]] and of this module.
You can reach me at: mailto:david_nichols@users.sourceforge.net
[[Introduction]]
[[NCurses Namespace]]
Here is a list of all functions provided by the module - please see your ncurses documentation or man pages for more information on arguments and a description of functionality until this documentation can be updated properly.

|!Function|!Description|h
|{{{beep()}}}|to be documented|
|{{{cbreak()}}}|to be documented|
|{{{curs_set()}}}|to be documented|
|{{{def_prog_mode()}}}|to be documented|
|{{{def_shell_mode()}}}|to be documented|
|{{{doupdate()}}}|to be documented|
|{{{echo()}}}|to be documented|
|{{{endwin()}}}|to be documented|
|{{{flash()}}}|to be documented|
|{{{getColumns()}}}|to be documented|
|{{{getLines()}}}|to be documented|
|{{{get_color_pair()}}}|to be documented|
|{{{getch()}}}|to be documented|
|{{{getmouse()}}}|to be documented|
|{{{halfdelay()}}}|to be documented|
|{{{has_colors()}}}|to be documented|
|{{{initscr()}}}|to be documented|
|{{{mousemask()}}}|to be documented|
|{{{nl()}}}|to be documented|
|{{{nocbreak()}}}|to be documented|
|{{{noecho()}}}|to be documented|
|{{{nonl()}}}|to be documented|
|{{{noqiflush()}}}|to be documented|
|{{{noraw()}}}|to be documented|
|{{{num_colors()}}}|to be documented|
|{{{printw()}}}|to be documented|
|{{{qiflush()}}}|to be documented|
|{{{raw()}}}|to be documented|
|{{{refresh()}}}|to be documented|
|{{{reset_prog_mode()}}}|to be documented|
|{{{reset_shell_mode()}}}|to be documented|
|{{{ACS_BLOCK()}}}|to be documented|
|{{{ACS_BOARD()}}}|to be documented|
|{{{ACS_BTEE()}}}|to be documented|
|{{{ACS_BULLET()}}}|to be documented|
|{{{ACS_CKBOARD()}}}|to be documented|
|{{{ACS_DARROW()}}}|to be documented|
|{{{ACS_DEGREE()}}}|to be documented|
|{{{ACS_DIAMOND()}}}|to be documented|
|{{{ACS_HLINE()}}}|to be documented|
|{{{ACS_LANTERN()}}}|to be documented|
|{{{ACS_LARROW()}}}|to be documented|
|{{{ACS_LLCORNER()}}}|to be documented|
|{{{ACS_LRCORNER()}}}|to be documented|
|{{{ACS_LTEE()}}}|to be documented|
|{{{ACS_PLMINUS()}}}|to be documented|
|{{{ACS_PLUS()}}}|to be documented|
|{{{ACS_RARROW()}}}|to be documented|
|{{{ACS_RTEE()}}}|to be documented|
|{{{ACS_S1()}}}|to be documented|
|{{{ACS_S9()}}}|to be documented|
|{{{ACS_TTEE()}}}|to be documented|
|{{{ACS_UARROW()}}}|to be documented|
|{{{ACS_ULCORNER()}}}|to be documented|
|{{{ACS_URCORNER()}}}|to be documented|
|{{{ACS_VLINE()}}}|to be documented|
The Qore {{{ncurses}}} module is based on the [[ncurses library|http://www.gnu.org/software/ncurses]], and therefore also is compatible with real ~SVR4 [[curses|http://en.wikipedia.org/wiki/Curses_(programming_library)]].

This module is released under the [[LGPL 2.1|http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html]] and is tagged as such in the module's header (meaning it can be loaded unconditionally regardless of how the Qore library was initialized).

This documentation is not complete; it is only the very first initial draft of the documentation.  Here you can find all class, function, method, and constant names provided by the module, but currently without any descriptions.  Please refer to your curses or ncurses documentation (man pages, etc) for more information on the functionality implemented in this module, or refer to the example qore programs provided with this module.

Note that this documentation is based on [[TittldyWiki|http://www.tiddlywiki.com/]], a wiki entirely contained in a single web page.

This module is experimental mainly for the reason that Qore is highly threaded and all Qore code and modules must be thread-safe, and threading is not compatible with curses.

However, this module supports multi-threaded curses programs, as crazy as it sounds, by using an appropriate big lock to serialize almost all calls to the curses library.  However, to provide some appearance of multithreading, access to the {{{getch()}}} function is allowed simultaneously with other curses calls; calls to {{{getch()}}} are serialized with a different lock.  This can be the source of instability and/or crashes; in order to safely use the ncurses module, you should not use threading until an alternative, thread-safe implementation of {{{getch()}}} is implemented for this module.

Note that the {{{ACS_*}}} macros are provided as [[functions|Functions]] by this module.

Also, it is not necessary to explicitly call {{{initscr()}}} or {{{endwin()}}}, as the module will take care of this on the first ncurses call (for {{{initscr()}}}) and when the module is unloaded (for {{{endwin()}}}).
|!Constant|h
|{{{KEY_BREAK}}}|
|{{{KEY_DOWN}}}|
|{{{KEY_UP}}}|
|{{{KEY_LEFT}}}|
|{{{KEY_RIGHT}}}|
|{{{KEY_HOME}}}|
|{{{KEY_BACKSPACE}}}|
|{{{KEY_F0}}}|
|{{{KEY_F1}}}|
|{{{KEY_F2}}}|
|{{{KEY_F3}}}|
|{{{KEY_F4}}}|
|{{{KEY_F5}}}|
|{{{KEY_F6}}}|
|{{{KEY_F7}}}|
|{{{KEY_F8}}}|
|{{{KEY_F9}}}|
|{{{KEY_F10}}}|
|{{{KEY_F11}}}|
|{{{KEY_F12}}}|
|{{{KEY_DL}}}|
|{{{KEY_IL}}}|
|{{{KEY_DC}}}|
|{{{KEY_IC}}}|
|{{{KEY_EIC}}}|
|{{{KEY_CLEAR}}}|
|{{{KEY_EOS}}}|
|{{{KEY_EOL}}}|
|{{{KEY_SF}}}|
|{{{KEY_SR}}}|
|{{{KEY_NPAGE}}}|
|{{{KEY_PPAGE}}}|
|{{{KEY_STAB}}}|
|{{{KEY_CTAB}}}|
|{{{KEY_CATAB}}}|
|{{{KEY_ENTER}}}|
|{{{KEY_SRESET}}}|
|{{{KEY_RESET}}}|
|{{{KEY_PRINT}}}|
|{{{KEY_LL}}}|
|{{{KEY_A1}}}|
|{{{KEY_A3}}}|
|{{{KEY_B2}}}|
|{{{KEY_C1}}}|
|{{{KEY_C3}}}|
|{{{KEY_BTAB}}}|
|{{{KEY_BEG}}}|
|{{{KEY_CANCEL}}}|
|{{{KEY_CLOSE}}}|
|{{{KEY_COMMAND}}}|
|{{{KEY_COPY}}}|
|{{{KEY_CREATE}}}|
|{{{KEY_END}}}|
|{{{KEY_EXIT}}}|
|{{{KEY_FIND}}}|
|{{{KEY_HELP}}}|
|{{{KEY_MARK}}}|
|{{{KEY_MESSAGE}}}|
|{{{KEY_MOUSE}}}|
|{{{KEY_MOVE}}}|
|{{{KEY_NEXT}}}|
|{{{KEY_OPEN}}}|
|{{{KEY_OPTIONS}}}|
|{{{KEY_PREVIOUS}}}|
|{{{KEY_REDO}}}|
|{{{KEY_REFERENCE}}}|
|{{{KEY_REFRESH}}}|
|{{{KEY_REPLACE}}}|
|{{{KEY_RESIZE}}}|
|{{{KEY_RESTART}}}|
|{{{KEY_RESUME}}}|
|{{{KEY_SAVE}}}|
|{{{KEY_SBEG}}}|
|{{{KEY_SCANCEL}}}|
|{{{KEY_SCOMMAND}}}|
|{{{KEY_SCOPY}}}|
|{{{KEY_SCREATE}}}|
|{{{KEY_SDC}}}|
|{{{KEY_SDL}}}|
|{{{KEY_SELECT}}}|
|{{{KEY_SEND}}}|
|{{{KEY_SEOL}}}|
|{{{KEY_SEXIT}}}|
|{{{KEY_SFIND}}}|
|{{{KEY_SHELP}}}|
|{{{KEY_SHOME}}}|
|{{{KEY_SIC}}}|
|{{{KEY_SLEFT}}}|
|{{{KEY_SMESSAGE}}}|
|{{{KEY_SMOVE}}}|
|{{{KEY_SNEXT}}}|
|{{{KEY_SOPTIONS}}}|
|{{{KEY_SPREVIOUS}}}|
|{{{KEY_SPRINT}}}|
|{{{KEY_SREDO}}}|
|{{{KEY_SREPLACE}}}|
|{{{KEY_SRIGHT}}}|
|{{{KEY_SRSUME}}}|
|{{{KEY_SSAVE}}}|
|{{{KEY_SSUSPEND}}}|
|{{{KEY_SUNDO}}}|
|{{{KEY_SUSPEND}}}|
|{{{KEY_UNDO}}}|
|{{{BUTTON1_PRESSED}}}|
|{{{BUTTON1_RELEASED}}}|
|{{{BUTTON1_CLICKED}}}|
|{{{BUTTON1_DOUBLE_CLICKED}}}|
|{{{BUTTON1_TRIPLE_CLICKED}}}|
|{{{BUTTON2_PRESSED}}}|
|{{{BUTTON2_RELEASED}}}|
|{{{BUTTON2_CLICKED}}}|
|{{{BUTTON2_DOUBLE_CLICKED}}}|
|{{{BUTTON2_TRIPLE_CLICKED}}}|
|{{{BUTTON3_PRESSED}}}|
|{{{BUTTON3_RELEASED}}}|
|{{{BUTTON3_CLICKED}}}|
|{{{BUTTON3_DOUBLE_CLICKED}}}|
|{{{BUTTON3_TRIPLE_CLICKED}}}|
|{{{BUTTON4_PRESSED}}}|
|{{{BUTTON4_RELEASED}}}|
|{{{BUTTON4_CLICKED}}}|
|{{{BUTTON4_DOUBLE_CLICKED}}}|
|{{{BUTTON4_TRIPLE_CLICKED}}}|
|{{{BUTTON_SHIFT}}}|
|{{{BUTTON_CTRL}}}|
|{{{BUTTON_ALT}}}|
|{{{ALL_MOUSE_EVENTS}}}|
|{{{REPORT_MOUSE_POSITION}}}|
[[Introduction]]
[[NCurses Namespace]]
[[Window]]
[[Panel]]
[[Functions]]
The module implements the {{{NCurses}}} namespace that contains all constants and classes defined by the module.
!Classes
* [[Window]]: provides access to ncurses window functions
* [[Panel]]: provides access to ncurses panel functions
!Constants
* [[Color and Attribute Constants]]
* [[Key and Mouse Constants]]
The {{{Panel}}} class provides access to ncurses panel functionality.

''Methods''
|!Method|!Description|h
|{{{Panel::constructor()}}}|to be documented|
|{{{Panel::copy()}}}|throws an exception; the copy constructor is not supported in this class|
|{{{Panel::destructor()}}}|to be documented|
|{{{Panel::addch()}}}|to be documented|
|{{{Panel::addstr()}}}|to be documented|
|{{{Panel::attroff()}}}|to be documented|
|{{{Panel::attron()}}}|to be documented|
|{{{Panel::attrset()}}}|to be documented|
|{{{Panel::border()}}}|to be documented|
|{{{Panel::bottom()}}}|to be documented|
|{{{Panel::clear()}}}|to be documented|
|{{{Panel::clearok()}}}|to be documented|
|{{{Panel::clrtobot()}}}|to be documented|
|{{{Panel::clrtoeol()}}}|to be documented|
|{{{Panel::erase()}}}|to be documented|
|{{{Panel::getBegX()}}}|to be documented|
|{{{Panel::getBegY()}}}|to be documented|
|{{{Panel::getColumns()}}}|to be documented|
|{{{Panel::getLines()}}}|to be documented|
|{{{Panel::getX()}}}|to be documented|
|{{{Panel::getY()}}}|to be documented|
|{{{Panel::getch()}}}|to be documented|
|{{{Panel::hide()}}}|to be documented|
|{{{Panel::hline()}}}|to be documented|
|{{{Panel::idcok()}}}|to be documented|
|{{{Panel::idlok()}}}|to be documented|
|{{{Panel::immedok()}}}|to be documented|
|{{{Panel::keypad()}}}|to be documented|
|{{{Panel::move()}}}|to be documented|
|{{{Panel::movePanel()}}}|to be documented|
|{{{Panel::mvaddch()}}}|to be documented|
|{{{Panel::mvaddstr()}}}|to be documented|
|{{{Panel::mvhline()}}}|to be documented|
|{{{Panel::mvprintw()}}}|to be documented|
|{{{Panel::mvvline()}}}|to be documented|
|{{{Panel::printw()}}}|to be documented|
|{{{Panel::redraw()}}}|to be documented|
|{{{Panel::refresh()}}}|to be documented|
|{{{Panel::resize()}}}|to be documented|
|{{{Panel::scrl()}}}|to be documented|
|{{{Panel::scroll()}}}|to be documented|
|{{{Panel::scrollok()}}}|to be documented|
|{{{Panel::setBackgroundColor()}}}|to be documented|
|{{{Panel::setColor()}}}|to be documented|
|{{{Panel::setForegroundColor()}}}|to be documented|
|{{{Panel::setscrreg()}}}|to be documented|
|{{{Panel::show()}}}|to be documented|
|{{{Panel::top()}}}|to be documented|
|{{{Panel::update()}}}|to be documented|
|{{{Panel::vline()}}}|to be documented|

Qore ncurses Module Documentation
The {{{Window}}} class provides access to ncurses window functionality.

|{{{Window::constructor()}}}|to be documented|
|{{{Window::copy()}}}|throws an exception; copy constructor not supported in this class|
|{{{Window::destructor()}}}|to be documented|
|{{{Window::addch()}}}|to be documented|
|{{{Window::addstr()}}}|to be documented|
|{{{Window::attroff()}}}|to be documented|
|{{{Window::attron()}}}|to be documented|
|{{{Window::attrset()}}}|to be documented|
|{{{Window::border()}}}|to be documented|
|{{{Window::clear()}}}|to be documented|
|{{{Window::clearok()}}}|to be documented|
|{{{Window::clrtobot()}}}|to be documented|
|{{{Window::clrtoeol()}}}|to be documented|
|{{{Window::erase()}}}|to be documented|
|{{{Window::getBegX()}}}|to be documented|
|{{{Window::getBegY()}}}|to be documented|
|{{{Window::getColumns()}}}|to be documented|
|{{{Window::getLines()}}}|to be documented|
|{{{Window::getX()}}}|to be documented|
|{{{Window::getY()}}}|to be documented|
|{{{Window::getch()}}}|to be documented|
|{{{Window::hline()}}}|to be documented|
|{{{Window::idcok()}}}|to be documented|
|{{{Window::idlok()}}}|to be documented|
|{{{Window::immedok()}}}|to be documented|
|{{{Window::keypad()}}}|to be documented|
|{{{Window::move()}}}|to be documented|
|{{{Window::moveWindow()}}}|to be documented|
|{{{Window::mvaddch()}}}|to be documented|
|{{{Window::mvaddstr()}}}|to be documented|
|{{{Window::mvhline()}}}|to be documented|
|{{{Window::mvprintw()}}}|to be documented|
|{{{Window::mvvline()}}}|to be documented|
|{{{Window::nodelay()}}}|to be documented|
|{{{Window::printw()}}}|to be documented|
|{{{Window::redraw()}}}|to be documented|
|{{{Window::refresh()}}}|to be documented|
|{{{Window::resize()}}}|to be documented|
|{{{Window::scrl()}}}|to be documented|
|{{{Window::scroll()}}}|to be documented|
|{{{Window::scrollok()}}}|to be documented|
|{{{Window::setBackgroundColor()}}}|to be documented|
|{{{Window::setColor()}}}|to be documented|
|{{{Window::setForegroundColor()}}}|to be documented|
|{{{Window::setscrreg()}}}|to be documented|
|{{{Window::vline()}}}|to be documented|