summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/SWDisplay.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/SWDisplay.3')
-rw-r--r--doc/api-documentation/man/man3/SWDisplay.349
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWDisplay.3 b/doc/api-documentation/man/man3/SWDisplay.3
new file mode 100644
index 0000000..eba516a
--- /dev/null
+++ b/doc/api-documentation/man/man3/SWDisplay.3
@@ -0,0 +1,49 @@
+.TH "SWDisplay" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+SWDisplay \- swdisp is the basis for all types of displays (e.g.
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <swdisp.h>\fP
+.PP
+Inherited by TBDisp.
+.PP
+.SS "Public Methods"
+
+.in +1c
+.ti -1c
+.RI "\fBSWDisplay\fP ()"
+.br
+.ti -1c
+.RI "virtual char \fBDisplay\fP (\fBSWModule\fP &imodule)"
+.br
+.RI "\fIcasts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary).\fP"
+.in -1c
+.SH "DETAILED DESCRIPTION"
+.PP
+swdisp is the basis for all types of displays (e.g.
+.PP
+raw textout, curses, xwindow, etc.)
+.PP
+Definition at line 33 of file swdisp.h.
+.SH "MEMBER FUNCTION DOCUMENTATION"
+.PP
+.SS "virtual char SWDisplay::Display (\fBSWModule\fP & imodule)\fC [virtual]\fP"
+.PP
+casts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary).
+.PP
+Parameters:
+.in +1c
+.TP
+\fB\fIimodule\fP\fP
+module to display
+.PP
+\fBReturns: \fP
+.in +1c
+error status
+
+.SH "AUTHOR"
+.PP
+Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file