nestopia/doc/details/api/Nes..Api..User.html
2012-09-02 13:13:55 -04:00

340 lines
11 KiB
HTML

<HTML>
<HEAD>
<!-- Generated by CppDoc v2.4.1 on June 07, 2008 at 22:48-->
<META NAME="GENERATOR" Content="CppDoc">
<TITLE>Nestopia Core API: Nes::Api::User</TITLE>
</HEAD>
<BODY>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#eeeeff">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
<TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Nestopia Core API</B></EM>
</TD>
</TR>
<TR>
<TD><FONT SIZE="-2">
<a href="../../index.html" target="_top"><B>FRAMES</B></a> &nbsp;
&nbsp;<a href="../api/Nes..Api..User.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
api</FONT>
<BR>
Class Nes::Api::User</H2>
<PRE>
<code>Base</code>
|
+--<B>Nes::Api::User</B>
</PRE>
<HR>
<DL>
<DT>class <B><a href="../api/Nes..Api.html">Nes::Api</a>::User</B></DT><dt> extends Base
</DL>
<p>User IO interfaces.
<p>
<HR>
<!-- =========== INNER CLASSES, TYPEDEFS, ENUMS =========== -->
<A NAME="inner_defs_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Inner Classes, Typedefs, and Enums</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>enum</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..Answer.html">Nes::Api::User::Answer</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User answer.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>enum</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..Event.html">Nes::Api::User::Event</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User events.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>typedef</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..EventCallback.html">Nes::Api::User::EventCallback</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logfile callback prototype.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>struct</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..File.html">Nes::Api::User::File</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;File IO interface.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>typedef</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..FileIoCallback.html">Nes::Api::User::FileIoCallback</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;File IO callback prototype.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>typedef</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..LogCallback.html">Nes::Api::User::LogCallback</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logfile callback prototype.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>enum</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..Question.html">Nes::Api::User::Question</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User questions.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>typedef</CODE></FONT></TD>
<TD><B><CODE><a href="../api/Nes..Api..User..QuestionCallback.html">Nes::Api::User::QuestionCallback</a></CODE></B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User question callback prototype.</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;static <a href="../api/Nes..Api..User..EventCaller.html">Nes::Api::User::EventCaller</a></CODE></FONT></TD>
<TD><CODE><B><a href="#eventCallback">eventCallback</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User event callback manager.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;static <a href="../api/Nes..Api..User..FileIoCaller.html">Nes::Api::User::FileIoCaller</a></CODE></FONT></TD>
<TD><CODE><B><a href="#fileIoCallback">fileIoCallback</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;File IO callback manager.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;static <a href="../api/Nes..Api..User..LogCaller.html">Nes::Api::User::LogCaller</a></CODE></FONT></TD>
<TD><CODE><B><a href="#logCallback">logCallback</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logfile callback manager.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;static <a href="../api/Nes..Api..User..QuestionCaller.html">Nes::Api::User::QuestionCaller</a></CODE></FONT></TD>
<TD><CODE><B><a href="#questionCallback">questionCallback</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User question callback manager.</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== CONSTRUCTOR SUMMARY =========== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#User(T&)">User</a></B>( T& instance )</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interface constructor.</TD>
</TR>
</TABLE>
&nbsp;
<BR>
<BR>
<!-- ============ Field Detail ========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="eventCallback"><!-- --></A>
<A NAME="eventCallback"><!-- --></A>
<H3>eventCallback</H3>
<PRE>
public static <a href="../api/Nes..Api..User..EventCaller.html">Nes::Api::User::EventCaller</a> <B>eventCallback</B>;
</PRE>
<DL>
<DD>User event callback manager.
Static object used for adding the user defined callback.
</DD>
</DL>
<HR>
<A NAME="fileIoCallback"><!-- --></A>
<A NAME="fileIoCallback"><!-- --></A>
<H3>fileIoCallback</H3>
<PRE>
public static <a href="../api/Nes..Api..User..FileIoCaller.html">Nes::Api::User::FileIoCaller</a> <B>fileIoCallback</B>;
</PRE>
<DL>
<DD>File IO callback manager.
Static object used for adding the user defined callback.
</DD>
</DL>
<HR>
<A NAME="logCallback"><!-- --></A>
<A NAME="logCallback"><!-- --></A>
<H3>logCallback</H3>
<PRE>
public static <a href="../api/Nes..Api..User..LogCaller.html">Nes::Api::User::LogCaller</a> <B>logCallback</B>;
</PRE>
<DL>
<DD>Logfile callback manager.
Static object used for adding the user defined callback.
</DD>
</DL>
<HR>
<A NAME="questionCallback"><!-- --></A>
<A NAME="questionCallback"><!-- --></A>
<H3>questionCallback</H3>
<PRE>
public static <a href="../api/Nes..Api..User..QuestionCaller.html">Nes::Api::User::QuestionCaller</a> <B>questionCallback</B>;
</PRE>
<DL>
<DD>User question callback manager.
Static object used for adding the user defined callback.
</DD>
</DL>
<HR>
<BR>
<!-- ============ Constructor Detail ========== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="User(T&)"><!-- --></A>
<A NAME="User"><!-- --></A>
<H3>User</H3>
<PRE>
public <B>User</B>( T& instance );
</PRE>
<DL>
<DD>Interface constructor.
</DD>
<DL>
<DT><B>Parameters: </B><DD><code>instance</code> - emulator instance</DD>
</DL>
</DL>
<HR>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#eeeeff">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
<TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Nestopia Core API</B></EM>
</TD>
</TR>
<TR>
<TD><FONT SIZE="-2">
<a href="../../index.html" target="_top"><B>FRAMES</B></a> &nbsp;
&nbsp;<a href="../api/Nes..Api..User.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>