Sophie: pyrite-0.9.3-4mdk i586

pyrite-0.9.3-4mdk.i586.rpm

<HTML
><HEAD
><TITLE
>Class: Record</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.42"><LINK
REL="HOME"
TITLE="Pyrite Programmers Guide"
HREF="book1.html"><LINK
REL="UP"
TITLE="Blocks"
HREF="c47.html"><LINK
REL="PREVIOUS"
TITLE="Blocks"
HREF="c47.html"><LINK
REL="NEXT"
TITLE="Class: AppBlock"
HREF="x263.html"></HEAD
><BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Pyrite Programmers Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="c47.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 1. Blocks</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x263.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="REF-BLOCKS-RECORD"
>Class: Record</A
></H1
><P
>      A <TT
CLASS="CLASSNAME"
>Record</TT
> object represents a single record in a
      database.
    </P
><P
>      <TT
CLASS="CLASSNAME"
>Record</TT
> is a subclass of <TT
CLASS="CLASSNAME"
>Block</TT
>.
    </P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="REF-BLOCKS-RECORD-ATTRIBUTES"
>Attributes</A
></H2
><P
></P
><DL
><DT
><TT
CLASS="STRUCTFIELD"
><I
>deleted</I
></TT
> (<SPAN
CLASS="TYPE"
>boolean</SPAN
>)</DT
><DD
><P
>True if the record was deleted by the handheld
	      user.  (Deleted records may be retained in the handheld
	      until synchronization, to allow archiving.)</P
></DD
><DT
><TT
CLASS="STRUCTFIELD"
><I
>modified</I
></TT
> (<SPAN
CLASS="TYPE"
>boolean</SPAN
>)</DT
><DD
><P
>True if the record has been modified by the handheld
	      user since the last synchronization.</P
></DD
><DT
><TT
CLASS="STRUCTFIELD"
><I
>busy</I
></TT
> (<SPAN
CLASS="TYPE"
>boolean</SPAN
>)</DT
><DD
><P
>True if the record is in use by a handheld
	      application.</P
></DD
><DT
><TT
CLASS="STRUCTFIELD"
><I
>secret</I
></TT
> (<SPAN
CLASS="TYPE"
>boolean</SPAN
>)</DT
><DD
><P
>True if the record has been marked "secret" by the
	      handheld user.</P
></DD
><DT
><TT
CLASS="STRUCTFIELD"
><I
>archived</I
></TT
> (<SPAN
CLASS="TYPE"
>boolean</SPAN
>)</DT
><DD
><P
>True if the record has been archived.  (This
	      attribute is not saved in records on the handheld, or in
	      most other databases.  It is provided so that
	      synchronization software can use it for temporary
	      marking.)</P
></DD
><DT
><TT
CLASS="STRUCTFIELD"
><I
>category</I
></TT
> (<SPAN
CLASS="TYPE"
>integer</SPAN
>)</DT
><DD
><P
>The record's category.  Currently only values from 0
	      to 15 are valid; 0 is "Unfiled".</P
></DD
><DT
><TT
CLASS="STRUCTFIELD"
><I
>id</I
></TT
> (<SPAN
CLASS="TYPE"
>integer</SPAN
>)</DT
><DD
><P
>A unique identifier for the record, an integer from
	      0 to 0xFFFFFF.  Since id values should only be assigned
	      by the handheld, a value of 0 can be used to signify "no
	      id assigned yet".</P
></DD
><DT
><TT
CLASS="STRUCTFIELD"
><I
>index</I
></TT
> (<SPAN
CLASS="TYPE"
>integer</SPAN
>)</DT
><DD
><P
>The index (from 0 to the length of the database) at
	      which this record was found.</P
></DD
></DL
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="REF-BLOCKS-RECORD-METHODS"
>Methods</A
></H2
><P
></P
><DL
><DT
><TT
CLASS="FUNCTION"
>__init__</TT
> (<TT
CLASS="PARAMETER"
><I
>raw</I
></TT
>='',
	    <TT
CLASS="PARAMETER"
><I
>index</I
></TT
>=0, <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>=0, <TT
CLASS="PARAMETER"
><I
>attr</I
></TT
>=0,
	    <TT
CLASS="PARAMETER"
><I
>category</I
></TT
>=0)</DT
><DD
><P
>Create a new Record object with the specified
	      contents, index, id, boolean attributes, and
	      category.</P
></DD
><DT
><TT
CLASS="FUNCTION"
>attributes</TT
></DT
><DD
><P
>Return an integer representing the record's boolean
	      attributes, in the same form as they appear on the
	      handheld.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="c47.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x263.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Blocks</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c47.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Class: AppBlock</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>