GnuCash Daily Diff
Dave Peticolas
peticolas@linas.org
Thu, 17 May 2001 08:02:43 -0500 (CDT)
Index: gnucash/ChangeLog
diff -u gnucash/ChangeLog:1.482 gnucash/ChangeLog:1.486
--- gnucash/ChangeLog:1.482 Wed May 16 04:33:28 2001
+++ gnucash/ChangeLog Thu May 17 05:37:33 2001
@@ -1,3 +1,39 @@
+2001-05-17 Dave Peticolas <dave@krondo.com>
+
+ * accounts/C/*: tweak detailed descriptions
+
+ * doc/sgml/C/xacc-reports.sgml: fix warnings
+
+ * doc/sgml/C/xacc-net-worth-barchart.sgml: fix warnings
+
+ * doc/sgml/C/xacc-gnucash-web-browser.sgml: fix warnings
+
+ * doc/sgml/C/xacc-gnome-mdi.sgml: fix warnings
+
+ * doc/sgml/C/xacc-common-report-options.sgml: fix warnings
+
+ * doc/sgml/C/Makefile.am: add new file to Makefile.am
+
+ * src/doc/design/gnucash-design.texinfo: update docs
+
+ * src/doc/design/engine.texinfo: update docs
+
+ * src/engine/Account.c: same as below
+
+ * src/engine/Account.h: use GNCAccountType instead of 'int'
+
+2001-05-17 Robert Graham Merkel <rgmerk@mira.net>
+
+ * doc/sgml/C/xacc-gnucash-web-browser.sgml: New file.
+
+ * doc/sgml/C/Makefile.am: add new file.
+
+ * doc/sgml/C/gnucash.sgml, xacc-gnome-mdi.sgml,
+ xacc-asset-liability-piecharts.sgml: more updated/new content.
+
+ * ChangeLog: fix wrong path in (my) previous changelog
+ entry.
+
2001-05-16 Dave Peticolas <dave@krondo.com>
* src/doc/design/gnucash-design.texinfo: update docs
@@ -17,7 +53,7 @@
* src/scm/html-utilities.scm ((gnc:html-make-empty-data-warning)):
update message.
- * src/scm/{gnucash.sgml, xacc-account-summary.sgml,
+ * doc/sgml/C/{gnucash.sgml, xacc-account-summary.sgml,
xacc-asset-liability-barcharts.sgml, xacc-reports.sgml}: more new
material.
Index: gnucash/accounts/C/acctchrt_brokerage.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_brokerage.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_brokerage.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_brokerage.gnucash-xea:1.2 Wed May 9 20:58:49 2001
+++ gnucash/accounts/C/acctchrt_brokerage.gnucash-xea Thu May 17 05:37:34 2001
@@ -8,9 +8,9 @@
(stock, bond, mutual fund, index fund, interest, dividend)
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
investments (stock, bond, mutual fund, index fund, interest,
- dividend)
+ dividend).
</gnc-act:long-description>
<gnc:account version="2.0.0">
<act:name>Assets</act:name>
Index: gnucash/accounts/C/acctchrt_carloan.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_carloan.gnucash-xea:1.3 gnucash/accounts/C/acctchrt_carloan.gnucash-xea:1.4
--- gnucash/accounts/C/acctchrt_carloan.gnucash-xea:1.3 Tue May 15 14:11:27 2001
+++ gnucash/accounts/C/acctchrt_carloan.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
Accounts for car loan and associated interest
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
a car loan (car loan, car loan interest).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_cdmoneymkt.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_cdmoneymkt.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_cdmoneymkt.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_cdmoneymkt.gnucash-xea:1.2 Tue May 15 14:11:27 2001
+++ gnucash/accounts/C/acctchrt_cdmoneymkt.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
Accounts for CD and money market investments
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
CDs or money market accounts (CD, CD interest, money market, money
market interest).
</gnc-act:long-description>
Index: gnucash/accounts/C/acctchrt_childcare.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_childcare.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_childcare.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_childcare.gnucash-xea:1.2 Tue May 15 14:11:27 2001
+++ gnucash/accounts/C/acctchrt_childcare.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
An account for tracking childcare costs
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
childcare expenses.
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_currency.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_currency.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_currency.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_currency.gnucash-xea:1.2 Tue May 15 14:11:27 2001
+++ gnucash/accounts/C/acctchrt_currency.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
Account for trading and converting a foreign currency
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you convert
+ You would want to select this set of accounts if you convert
foreign currencies.
Note: account currently in DEM; edit account to change currency.
Index: gnucash/accounts/C/acctchrt_eduloan.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_eduloan.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_eduloan.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_eduloan.gnucash-xea:1.2 Tue May 15 14:11:27 2001
+++ gnucash/accounts/C/acctchrt_eduloan.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
Accounts for school loan and associated interest
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
an educational loan (education loan, education loan interest).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_fixedassets.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_fixedassets.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_fixedassets.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_fixedassets.gnucash-xea:1.2 Tue May 15 14:11:27 2001
+++ gnucash/accounts/C/acctchrt_fixedassets.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
Accounts for tracking large fixed assets
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
large fixed assets (house, vehicle, vacation home, other assets).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_homeloan.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_homeloan.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_homeloan.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_homeloan.gnucash-xea:1.2 Tue May 15 14:11:28 2001
+++ gnucash/accounts/C/acctchrt_homeloan.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
Accounts for home loan and associated interest
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
a home loan (mortgage loan, mortgage interest).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_homeown.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_homeown.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_homeown.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_homeown.gnucash-xea:1.2 Tue May 15 14:11:28 2001
+++ gnucash/accounts/C/acctchrt_homeown.gnucash-xea Thu May 17 05:37:34 2001
@@ -7,7 +7,7 @@
Expenses associated with owning a home
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you own a home.
+ You would want to select this set of accounts if you own a home.
This set provides a group of accounts to track home expenses
(insurance, taxes, home repair).
</gnc-act:long-description>
Index: gnucash/accounts/C/acctchrt_otherloan.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_otherloan.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_otherloan.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_otherloan.gnucash-xea:1.2 Tue May 15 14:11:28 2001
+++ gnucash/accounts/C/acctchrt_otherloan.gnucash-xea Thu May 17 05:37:35 2001
@@ -7,7 +7,7 @@
Accounts for tracking other loans and associated interest
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
something other than a home loan (other loan, other loan interest).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_renter.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_renter.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_renter.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_renter.gnucash-xea:1.2 Tue May 15 14:11:28 2001
+++ gnucash/accounts/C/acctchrt_renter.gnucash-xea Thu May 17 05:37:35 2001
@@ -7,7 +7,7 @@
Expenses associated with renting a home
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you rent a home
+ You would want to select this set of accounts if you rent a home
or apartment (rent, renter's insurance).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_retiremt.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_retiremt.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_retiremt.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_retiremt.gnucash-xea:1.2 Tue May 15 14:11:28 2001
+++ gnucash/accounts/C/acctchrt_retiremt.gnucash-xea Thu May 17 05:37:35 2001
@@ -7,7 +7,7 @@
Retirement account with related investment subaccounts
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
+ You would want to select this set of accounts if you have
retirement accounts (stock, bond, mutual fund, index fund).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/accounts/C/acctchrt_spouseinc.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_spouseinc.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_spouseinc.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_spouseinc.gnucash-xea:1.2 Tue May 15 14:11:28 2001
+++ gnucash/accounts/C/acctchrt_spouseinc.gnucash-xea Thu May 17 05:37:35 2001
@@ -7,8 +7,8 @@
Accounts for tracking spouse's income separately
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
- a working spouse (salary(spouse), taxes (spouse)).
+ You would want to select this set of accounts if you have
+ a working spouse (salary (spouse), taxes (spouse)).
</gnc-act:long-description>
<gnc:account version="2.0.0">
<act:name>Income</act:name>
Index: gnucash/accounts/C/acctchrt_spouseretire.gnucash-xea
diff -u gnucash/accounts/C/acctchrt_spouseretire.gnucash-xea:1.2 gnucash/accounts/C/acctchrt_spouseretire.gnucash-xea:1.3
--- gnucash/accounts/C/acctchrt_spouseretire.gnucash-xea:1.2 Tue May 15 14:11:28 2001
+++ gnucash/accounts/C/acctchrt_spouseretire.gnucash-xea Thu May 17 05:37:35 2001
@@ -7,8 +7,8 @@
Retirement account with related investment accounts for spouse
</gnc-act:short-description>
<gnc-act:long-description>
- You would want to select these set of accounts if you have
- investments in a spouse's name(stock, bond, mutual fund, index
+ You would want to select this set of accounts if you have
+ investments in a spouse's name (stock, bond, mutual fund, index
fund, interest, dividend).
</gnc-act:long-description>
<gnc:account version="2.0.0">
Index: gnucash/doc/sgml/C/Makefile.am
diff -u gnucash/doc/sgml/C/Makefile.am:1.20 gnucash/doc/sgml/C/Makefile.am:1.22
--- gnucash/doc/sgml/C/Makefile.am:1.20 Wed May 16 02:52:45 2001
+++ gnucash/doc/sgml/C/Makefile.am Thu May 17 05:28:47 2001
@@ -17,6 +17,7 @@
xacc-balancesheet.sgml \
xacc-chartofaccts.sgml \
xacc-commodity.sgml \
+ xacc-common-report-options.sgml \
xacc-currencyhandling.sgml \
xacc-dateinput.sgml \
xacc-depreciation.sgml \
@@ -24,6 +25,7 @@
xacc-doubleentry.sgml \
xacc-euro.sgml \
xacc-gnome-mdi.sgml \
+ xacc-gnucash-web-browser.sgml \
xacc-gpl.sgml \
xacc-incomeexpense.sgml \
xacc-income-expense-barcharts.sgml \
Index: gnucash/doc/sgml/C/gnucash.sgml
diff -u gnucash/doc/sgml/C/gnucash.sgml:1.12 gnucash/doc/sgml/C/gnucash.sgml:1.13
--- gnucash/doc/sgml/C/gnucash.sgml:1.12 Wed May 16 02:52:45 2001
+++ gnucash/doc/sgml/C/gnucash.sgml Thu May 17 02:30:31 2001
@@ -17,6 +17,7 @@
<!entity xacceuro system "xacc-euro.sgml">
<!entity xaccdateinput system "xacc-dateinput.sgml">
<!entity xaccgnomemdi system "xacc-gnome-mdi.sgml">
+<!entity xaccgnucashwebbrowser system "xacc-gnucash-web-browser.sgml">
<!entity xaccincomeexpense system "xacc-incomeexpense.sgml">
<!entity xaccincomeexpensebarcharts system "xacc-income-expense-barcharts.sgml">
<!entity xaccincomeexpensepiecharts system "xacc-income-expense-piecharts.sgml">
@@ -72,6 +73,7 @@
&xacceuro;
&xaccdateinput;
&xaccgnomemdi;
+&xaccgnucashwebbrowser;
&xaccincomeexpense;
&xaccincomeexpensebarcharts;
&xaccincomeexpensepiecharts;
Index: gnucash/doc/sgml/C/xacc-asset-liability-piecharts.sgml
diff -u gnucash/doc/sgml/C/xacc-asset-liability-piecharts.sgml:1.1 gnucash/doc/sgml/C/xacc-asset-liability-piecharts.sgml:1.2
--- gnucash/doc/sgml/C/xacc-asset-liability-piecharts.sgml:1.1 Tue May 15 07:22:06 2001
+++ gnucash/doc/sgml/C/xacc-asset-liability-piecharts.sgml Thu May 17 02:30:31 2001
@@ -6,7 +6,27 @@
<title>Asset and Liability Piecharts</title>
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
</para>
-<para>This is not yet documented.</para>
+<para>These piecharts are useful for getting an
+view of how your assets and liabilities are categorized.
+By selecting options appropriately, you can examine, say,
+the allocation of your stock portfolio, or get an overall
+view of your investment mix.
+Note that piecharts can be rotated by clicking on them and
+dragging the mouse, and individual segments can be "exploded".</para>
+
+
+<para>Options available for these reports include:</para>
+<itemizedlist>
+ <listitem><para><emphasis><link linkend="xacc-options-accounts">
+ Accounts</link></emphasis></para>
+ </listitem>
+ <listitem><para><emphasis><link linkend="xacc-options-report-title">
+ Report Title</link></emphasis></para></listitem>
+ <listitem><para><emphasis><link linkend="xacc-options-date">
+ Date</link></emphasis></para>
+ </listitem>
+ <listitem><para><emphasis>Add more!!!</emphasis></para></listitem>
+</itemizedlist>
</sect1>
</article>
Index: gnucash/doc/sgml/C/xacc-common-report-options.sgml
diff -u gnucash/doc/sgml/C/xacc-common-report-options.sgml:1.2 gnucash/doc/sgml/C/xacc-common-report-options.sgml:1.3
--- gnucash/doc/sgml/C/xacc-common-report-options.sgml:1.2 Wed May 16 02:52:45 2001
+++ gnucash/doc/sgml/C/xacc-common-report-options.sgml Thu May 17 05:28:47 2001
@@ -1,10 +1,10 @@
-<ARTICLE ID="XACC-COMMON-REPORT-OPTIONS"
-<ARTHEADER>
-<TITLE>Common Report Options</TITLE>
-</ARTHEADER>
-<SECT1>
-<TITLE> Common Report Options</TITLE>
-<PARA>Many reports share similar sorts of options. Some common ones
+<article ID="XACC-COMMON-REPORT-OPTIONS"
+<artheader>
+<title>Common Report Options</title>
+</artheader>
+<sect1>
+<title> Common Report Options</title>
+<para>Many reports share similar sorts of options. Some common ones
include:
<itemizedlist>
@@ -87,5 +87,6 @@
prices at current values, or prices at the time of the report date.</para>
</listitem>
</itemizedlist>
+</para>
</sect1>
-</article>
\ No newline at end of file
+</article>
Index: gnucash/doc/sgml/C/xacc-gnome-mdi.sgml
diff -u gnucash/doc/sgml/C/xacc-gnome-mdi.sgml:1.1 gnucash/doc/sgml/C/xacc-gnome-mdi.sgml:1.3
--- gnucash/doc/sgml/C/xacc-gnome-mdi.sgml:1.1 Tue May 15 07:22:06 2001
+++ gnucash/doc/sgml/C/xacc-gnome-mdi.sgml Thu May 17 05:28:47 2001
@@ -6,7 +6,56 @@
<title>The Gnome MDI</title>
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
</para>
-<para>This is not yet documented.</para>
+<para>GnuCash can display multiple views of your finances at once, in
+multiple windows, a tabbed "notebook" style, or in one plain window.
+This facility is provided through the GNOME MDI (multiple document
+interface). When you open a new
+<link linkend="xacc-mainwin">account tree</link>
+or <link linkend="xacc-reports">report</link> using the file menu, the
+new view can be displayed in several ways.
+</para>
+
+</sect1>
+<sect1 id="xacc-notebook-view">
+<title>Notebook View</title>
+<para><emphasis>Picture Needed Here!</emphasis></para>
+<para>Notebook view puts all new views in the main window, but places
+them on named tabs - just like a real notebook, in fact. You can bring
+a notebook tab to the front by clicking on it.</para>
+</sect1>
+
+<sect1 id="xacc-multiple-windows-view">
+<title>Multiple Windows</title>
+<para><emphasis>Picture Needed Here!</emphasis></para>
+<para>If this mode is selected, a new top-level window will be created
+for the new view. You can move and resize this window any way you
+want, independently of the original gnucash main window. If you have
+a window manager that supports multiple desktops, you can happily
+move it onto a to a different one.
+</para>
+</sect1>
+
+<sect1 id="xacc-single-window-view">
+<title>Single Window</title>
+<para><emphasis>Picture Needed Here!</emphasis></para>
+<para>The single-window view works like the notebook view, except
+that instead of using tabs to select which report/account
+tree you wish to view, you can select them from the Window menu.
+</para>
+</sect1>
+
+<sect1 id="xacc-selecting-mdi-mode">
+<title>Selecting MDI Modes</title>
+<para>MDI mode can be set in two different ways. Firstly
+you can set it within GnuCash through the "Application MDI Mode"
+option in the <link linkend="xacc-preferences">
+Preferences Dialog</link></para>
+<para>However, if you prefer a particular MDI mode across all your
+GNOME applications, you can set the preference for all of them in
+the MDI section of the GNOME Configuration program (see the GNOME
+on-line help for more details). To get GnuCash to recognize the
+global setting, set the "Application MDI Mode" option in the preferences
+dialog to "Use GNOME Default".</para>
</sect1>
</article>
Index: gnucash/doc/sgml/C/xacc-gnucash-web-browser.sgml
diff -u /dev/null gnucash/doc/sgml/C/xacc-gnucash-web-browser.sgml:1.2
--- /dev/null Thu May 17 08:01:30 2001
+++ gnucash/doc/sgml/C/xacc-gnucash-web-browser.sgml Thu May 17 05:28:47 2001
@@ -0,0 +1,37 @@
+<article id="xacc-gnucash-web-browser">
+<artheader>
+<title>GnuCash as a Web Browser?</title>
+</artheader>
+<sect1>
+<title>GnuCash as a Web Browser?</title>
+<para><emphasis>Picture Required!!!</emphasis></para>
+
+<para>GnuCash has the ability to display most web pages as a "Frame URL"
+report.
+This can be very useful, particularly as a way to display web-based
+financial information, in combination with private gnucash data
+ as part of a <link linkend="xacc-multicolumn-view-report">
+Multicolumn View</link>.</para>
+<para>Note that GnuCash's web viewer is not as sophisticated as
+fully-fledged web browsers, and may not fully display pages containing
+Javascript, Flash animation, movies and sound, and so on. If you want
+to do that, you need a stand-alone browser like <emphasis>Mozilla</emphasis>.
+</para>
+<para>Options supported by this report include the following:
+<itemizedlist>
+
+<listitem><para><emphasis><link linkend="xacc-options-report-title">
+ Report Title</link></emphasis></para></listitem>
+<listitem><para><emphasis><link linkend="xacc-options-style-sheet">
+ Stylesheet</link></emphasis> (Note: this option has virtually
+no effect on this special-purpose report)</para></listitem>
+<listitem><para><emphasis>URL</emphasis>: The URL to display.</para></listitem>
+</itemizedlist>
+</para>
+
+</sect1>
+</article>
+
+<!-- Local variables: -->
+<!-- sgml-parent-document: "gnucash.sgml" -->
+<!-- End: -->
Index: gnucash/doc/sgml/C/xacc-net-worth-barchart.sgml
diff -u gnucash/doc/sgml/C/xacc-net-worth-barchart.sgml:1.1 gnucash/doc/sgml/C/xacc-net-worth-barchart.sgml:1.2
--- gnucash/doc/sgml/C/xacc-net-worth-barchart.sgml:1.1 Tue May 15 20:11:21 2001
+++ gnucash/doc/sgml/C/xacc-net-worth-barchart.sgml Thu May 17 05:28:47 2001
@@ -24,7 +24,7 @@
your assets and liabilities, respectively</para></listitem>
<listitem><para>Show Net Worth Bars</para>
<para>Show a a bar in each time step representing your overall
-net worth at that time.</para>
+net worth at that time.</para></listitem>
</itemizedlist>
</sect1>
</article>
Index: gnucash/doc/sgml/C/xacc-reports.sgml
diff -u gnucash/doc/sgml/C/xacc-reports.sgml:1.11 gnucash/doc/sgml/C/xacc-reports.sgml:1.12
--- gnucash/doc/sgml/C/xacc-reports.sgml:1.11 Wed May 16 02:52:45 2001
+++ gnucash/doc/sgml/C/xacc-reports.sgml Thu May 17 05:28:47 2001
@@ -17,6 +17,8 @@
If you examine just assets or liabilities, <link linkend="xacc-asset-liability-barcharts">
barcharts</link> showing data over time are available, as are
<link linkend="xacc-asset-liability-piecharts">piecharts</link>.
+</para>
+</listitem>
<listitem><para><link linkend="xacc-pnl"> Profit And Loss State:
</link> shows Income and/or Expenses over a selectable period. </para>
@@ -43,6 +45,8 @@
<listitem> <para><link linkend="xacc-balancereport">Balance
Tracker</link> tracks the balance of one or more accounts over time,
with the option of displaying both tables and a bar chart.</para>
+</listitem>
+
</itemizedlist>
</para>
@@ -92,10 +96,10 @@
later viewing or printing. </para> </listitem>
<listitem> <para><emphasis>Close</emphasis> closes the report window.
-</para> </listitem>
+</para></listitem>
</itemizedlist>
-
+</para>
</sect1>
<sect1 id="xacc-multiple-reports">
Index: gnucash/src/doc/design/engine.texinfo
diff -u gnucash/src/doc/design/engine.texinfo:1.34 gnucash/src/doc/design/engine.texinfo:1.35
--- gnucash/src/doc/design/engine.texinfo:1.34 Wed May 16 04:33:30 2001
+++ gnucash/src/doc/design/engine.texinfo Thu May 17 05:18:46 2001
@@ -1744,6 +1744,8 @@
@menu
* Account Types::
* General Account API::
+* Account Type API::
+* Account Getters::
@end menu
@@ -1802,7 +1804,7 @@
@end table
-@node General Account API, , Account Types, Accounts
+@node General Account API, Account Type API, Account Types, Accounts
@subsection General Account API
@deftypefun {Account *} xaccMallocAccount (void)
@@ -1852,6 +1854,88 @@
@deftypefun void xaccAccountSetSlots_nc (Account * @var{account}, kvp_frame * @var{frame})
Set the @code{kvp_frame} associated wih @var{account}. After the call,
@var{frame} is owned by @var{account}, so don't destroy it.
+@end deftypefun
+
+
+@node Account Type API, Account Getters, General Account API, Accounts
+@subsection Account Type API
+
+@deftypefun {const char *} xaccAccountGetTypeStr (GNCAccountType @var{type})
+Return a string corresponding to the given Account type suitable for
+display by a GUI. The string is translated with gettext according to
+the current locale.
+@end deftypefun
+
+@deftypefun {char *} xaccAccountTypeEnumAsString (GNCAccountType @var{type})
+Return a string corresponding to the given Account type. The string
+is not translated and is independent of the current locale.
+@end deftypefun
+
+@deftypefun gboolean xaccAccountStringToType (const char * @var{str}, GNCAccountType * @var{type})
+Converts a string of the form returned by @code{xaccAccountTypeEnumAsString}
+to a type, return in @var{type}. Returns true if the string corresponds
+to an actual type.
+@end deftypefun
+
+@deftypefun GNCAccountType xaccAccountStringToEnum (const char * @var{str})
+Similar to @code{xaccAccountStringToEnum}, but returns the type. If
+@var{str} does not correspond to any valid type, @code{BAD_TYPE} is
+returned.
+@end deftypefun
+
+@deftypefun gboolean xaccAccountTypesCompatible (GNCAccountType @var{parent_type}, GNCAccountType @var{child_type})
+Returns TRUE if accounts of type @var{parent_type} can have child accounts
+of type @var{child_type}. This compatibility is not enforced by the
+engine, but one day it may be!
+@end deftypefun
+
+
+@node Account Getters, , Account Type API, Accounts
+@subsection Account Getters
+
+@deftypefun GNCAccountType xaccAccountGetType (Account * @var{account})
+Return the type of @var{account}.
+@end deftypefun
+
+@deftypefun {const char *} xaccAccountGetName (Account * @var{account})
+Return the name of @var{account}.
+@end deftypefun
+
+@deftypefun {const char *} xaccAccountGetCode (Account * @var{account})
+Return the code of @var{account}.
+@end deftypefun
+
+@deftypefun {const char *} xaccAccountGetDescription (Account * @var{account})
+Return the description of @var{account}.
+@end deftypefun
+
+@deftypefun {const char *} xaccAccountGetNotes (Account * @var{account})
+Return the notes of @var{account}.
+@end deftypefun
+
+@deftypefun {gnc_commodity *} xaccAccountGetCurrency (Account * @var{account})
+Return the currency of @var{account}.
+@end deftypefun
+
+@deftypefun int xaccAccountGetCurrencySCU (Account * @var{account})
+Return the SCU (smallest convertible unit) of @var{account}'s
+currency.
+@end deftypefun
+
+@deftypefun {gnc_commodity *} xaccAccountGetSecurity (Account * @var{account})
+Return the security of @var{account}. For accounts without shares, this
+field will be @code{NULL}.
+@end deftypefun
+
+@deftypefun int xaccAccountGetSecuritySCU (Account * @var{account})
+Return the SCU (smallest convertible unit) of @var{account}'s
+security.
+@end deftypefun
+
+@deftypefun {gnc_commodity *} xaccAccountGetEffectiveSecurity (Account * @var{account})
+Get the `effective' security of the account. If the account has a non-NULL
+security field, that field will be returned. Otherwise, the currency will
+be returned.
@end deftypefun
Index: gnucash/src/doc/design/gnucash-design.texinfo
diff -u gnucash/src/doc/design/gnucash-design.texinfo:1.27 gnucash/src/doc/design/gnucash-design.texinfo:1.28
--- gnucash/src/doc/design/gnucash-design.texinfo:1.27 Wed May 16 04:33:31 2001
+++ gnucash/src/doc/design/gnucash-design.texinfo Thu May 17 05:18:47 2001
@@ -140,6 +140,8 @@
* Account Types::
* General Account API::
+* Account Type API::
+* Account Getters::
GNCBooks
Index: gnucash/src/engine/Account.c
diff -u gnucash/src/engine/Account.c:1.149 gnucash/src/engine/Account.c:1.150
--- gnucash/src/engine/Account.c:1.149 Wed May 16 04:33:32 2001
+++ gnucash/src/engine/Account.c Thu May 17 05:18:48 2001
@@ -1810,7 +1810,7 @@
if(safe_strcmp(#x, (str)) == 0) { *type = x; return(TRUE); }
gboolean
-xaccAccountStringToType(const char* str, int *type) {
+xaccAccountStringToType(const char* str, GNCAccountType *type) {
GNC_RETURN_ON_MATCH(NO_TYPE);
GNC_RETURN_ON_MATCH(BANK);
@@ -1841,11 +1841,11 @@
GNCAccountType
xaccAccountStringToEnum(const char* str)
{
- int type;
+ GNCAccountType type;
gboolean rc;
rc = xaccAccountStringToType(str, &type);
if (FALSE == rc) return BAD_TYPE;
- return ((GNCAccountType) type);
+ return type;
}
/********************************************************************\
@@ -1883,7 +1883,8 @@
\********************************************************************/
gboolean
-xaccAccountTypesCompatible (int parent_type, int child_type)
+xaccAccountTypesCompatible (GNCAccountType parent_type,
+ GNCAccountType child_type)
{
gboolean compatible = FALSE;
Index: gnucash/src/engine/Account.h
diff -u gnucash/src/engine/Account.h:1.71 gnucash/src/engine/Account.h:1.72
--- gnucash/src/engine/Account.h:1.71 Wed May 16 04:33:32 2001
+++ gnucash/src/engine/Account.h Thu May 17 05:18:48 2001
@@ -105,13 +105,16 @@
const char * xaccAccountGetTypeStr (GNCAccountType type); /* GUI names */
/* Conversion routines for the account types to/from strings.
- Critical for the text communication mechanisms. i.e. INCOME ->
- "INCOME". */
+ * Critical for the text communication mechanisms. i.e. INCOME ->
+ * "INCOME". */
char * xaccAccountTypeEnumAsString (GNCAccountType type);
-gboolean xaccAccountStringToType (const char* str, int *type);
+gboolean xaccAccountStringToType (const char* str, GNCAccountType *type);
GNCAccountType xaccAccountStringToEnum (const char* str);
-gboolean xaccAccountTypesCompatible (int parent_type, int child_type);
+/* Return TRUE if accounts of type parent_type can have accounts
+ * of type child_type as children. */
+gboolean xaccAccountTypesCompatible (GNCAccountType parent_type,
+ GNCAccountType child_type);
/* Compare two accounts for equality - this is a deep compare. */
gboolean xaccAccountEqual(Account *a, Account* b, gboolean check_guids);