Documentation for gnc
Index
Types
POINTER-ARRAY |
POINTER-TOKEN
Functions
gnc:account-auto-code |
gnc:account-begin-edit |
gnc:account-commit-edit |
gnc:account-get-acc-info |
gnc:account-get-balance |
gnc:account-get-children |
gnc:account-get-cleared-balance |
gnc:account-get-code |
gnc:account-get-currency |
gnc:account-get-description |
gnc:account-get-flags |
gnc:account-get-guid |
gnc:account-get-id |
gnc:account-get-name |
gnc:account-get-notes |
gnc:account-get-parent |
gnc:account-get-reconciled-balance |
gnc:account-get-security |
gnc:account-get-share-balance |
gnc:account-get-split |
gnc:account-get-split-count |
gnc:account-get-split-list |
gnc:account-get-type |
gnc:account-get-type-string |
gnc:account-insert-split |
gnc:account-lookup |
gnc:account-nth-account |
gnc:account-occurences-in-list |
gnc:account-order |
gnc:account-reverse-balance? |
gnc:account-set-code |
gnc:account-set-currency |
gnc:account-set-description |
gnc:account-set-name |
gnc:account-set-notes |
gnc:account-set-security |
gnc:account-set-type |
gnc:account-staged-transaction-traversal |
gnc:account-type->symbol |
gnc:add-extension |
gnc:amount->string-helper |
gnc:budget-dialog-create |
gnc:cast-to-inv-acct |
gnc:check-date-order |
gnc:check-trans-date-order |
gnc:choose-item-from-list-dialog |
gnc:convert-from-euro |
gnc:convert-to-euro |
gnc:count-splits |
gnc:dmy2timespec |
gnc:error-dialog |
gnc:file-query-save |
gnc:file-quit |
gnc:file-selection-dialog |
gnc:free-account |
gnc:free-query |
gnc:get-account-from-full-name |
gnc:get-accounts |
gnc:get-current-accounts |
gnc:get-current-group |
gnc:get-num-accounts |
gnc:gettext-helper |
gnc:group-begin-staged-transaction-traversals |
gnc:group-get-account |
gnc:group-get-balance |
gnc:group-get-guid |
gnc:group-get-num-accounts |
gnc:group-get-parent |
gnc:group-insert-account |
gnc:group-lookup |
gnc:group-staged-transaction-traversal |
gnc:guid-type-helper |
gnc:history-get-last |
gnc:info-dialog |
gnc:init-account |
gnc:init-session |
gnc:insert-subaccount |
gnc:inv-acct-get-price-src |
gnc:inv-acct-set-price-src |
gnc:is-euro-currency |
gnc:ith-split |
gnc:locale-default-currency |
gnc:lowlev-app-init |
gnc:malloc-account |
gnc:malloc-account-group |
gnc:malloc-query |
gnc:malloc-session |
gnc:merge-accounts |
gnc:move-far-end |
gnc:move-far-end-by-name |
gnc:option-db-register-option |
gnc:option-invoke-callback |
gnc:option-refresh-ui |
gnc:print-check-dialog-create |
gnc:print-date |
gnc:print-dialog-create |
gnc:print-session-create |
gnc:print-session-destroy |
gnc:print-session-done |
gnc:print-session-moveto |
gnc:print-session-text |
gnc:query-add-account |
gnc:query-get-splits |
gnc:query-set-group |
gnc:refresh-main-window |
gnc:report-window |
gnc:session-begin-file |
gnc:session-destroy |
gnc:session-end |
gnc:session-get-group |
gnc:session-save |
gnc:set-log-level-global |
gnc:split-create |
gnc:split-destroy |
gnc:split-get-account |
gnc:split-get-action |
gnc:split-get-balance |
gnc:split-get-cost-basis |
gnc:split-get-docref |
gnc:split-get-guid |
gnc:split-get-memo |
gnc:split-get-parent |
gnc:split-get-reconcile-state |
gnc:split-get-reconciled-date |
gnc:split-get-share-amount |
gnc:split-get-share-balance |
gnc:split-get-share-price |
gnc:split-get-value |
gnc:split-lookup |
gnc:split-set-action |
gnc:split-set-base-value |
gnc:split-set-docref |
gnc:split-set-memo |
gnc:split-set-reconcile |
gnc:split-set-share-amount |
gnc:split-set-share-price |
gnc:split-set-share-price-and-amount |
gnc:split-set-value |
gnc:transaction-append-split |
gnc:transaction-begin-edit |
gnc:transaction-commit-edit |
gnc:transaction-create |
gnc:transaction-destroy |
gnc:transaction-get-date-entered |
gnc:transaction-get-date-posted |
gnc:transaction-get-description |
gnc:transaction-get-docref |
gnc:transaction-get-guid |
gnc:transaction-get-num |
gnc:transaction-get-split |
gnc:transaction-get-split-count |
gnc:transaction-init |
gnc:transaction-is-common-currency |
gnc:transaction-is-open |
gnc:transaction-lookup |
gnc:transaction-set-action |
gnc:transaction-set-date |
gnc:transaction-set-date-entered |
gnc:transaction-set-date-posted |
gnc:transaction-set-date-time-pair |
gnc:transaction-set-date-today |
gnc:transaction-set-description |
gnc:transaction-set-docref |
gnc:transaction-set-memo |
gnc:transaction-set-xnum |
gnc:ui-destroy |
gnc:ui-destroy-all-subwindows |
gnc:ui-is-running? |
gnc:ui-is-terminating? |
gnc:ui-main |
gnc:ui-open-file |
gnc:ui-select-file |
gnc:ui-shutdown |
gnc:verify-dialog |
gnc:warning-dialog |
pointer-array-length |
pointer-array-ref |
pointer-token-eq? |
pointer-token-null?
(no constants defined)
Types
- type POINTER-TOKEN
-
- type POINTER-ARRAY
-
Constants
Functions
- (pointer-token-null? a)
- a is a POINTER-TOKEN.
Returns bool.
Returns boolean indicating whether or not this is a null pointer.
- (pointer-array-ref a index)
- a is a POINTER-ARRAY, index is a int.
Returns POINTER-TOKEN.
Returns the POINTER_TOKEN item at given index in a (zero-indexing).
- (pointer-array-length a)
- a is a POINTER-ARRAY.
Returns unsigned-long.
Returns the number of items in a.
- (pointer-token-eq? a b)
- a is a POINTER-TOKEN, b is a POINTER-TOKEN.
Returns bool.
Equality predicate for 2 pointer tokens.
- (gnc:group-get-guid group)
- group is a AccountGroup*.
Returns guid-scm.
Return the guid of the given account group.
- (gnc:group-lookup guid)
- guid is a guid-scm.
Returns AccountGroup*.
Lookup a group given a guid.
- (gnc:account-get-guid account)
- account is a Account*.
Returns guid-scm.
Return the guid of the given account.
- (gnc:account-lookup guid)
- guid is a guid-scm.
Returns Account*.
Lookup an account given a guid.
- (gnc:transaction-get-guid trans)
- trans is a Transaction*.
Returns guid-scm.
Return the guid of the given transaction.
- (gnc:transaction-lookup guid)
- guid is a guid-scm.
Returns Transaction*.
Lookup a transaction given a guid.
- (gnc:split-get-guid split)
- split is a Split*.
Returns guid-scm.
Return the guid of the given split.
- (gnc:split-lookup guid)
- guid is a guid-scm.
Returns Split*.
Lookup a split given a guid.
- (gnc:guid-type-helper guid)
- guid is a guid-scm.
Returns int.
Return the type of entity referenced by a guid.
- (gnc:ith-split sarray i)
- sarray is a Split**, i is a int.
Returns Split*.
Return split number i in list.
- (gnc:split-get-balance s)
- s is a Split*.
Returns double.
Return balance at split.
- (gnc:split-get-share-balance s)
- s is a Split*.
Returns double.
Return share balance at split.
- (gnc:split-get-cost-basis s)
- s is a Split*.
Returns double.
Return the cost basis of the split.
- (gnc:split-get-memo s)
- s is a Split*.
Returns const-string.
Return split's memo.
- (gnc:split-get-action s)
- s is a Split*.
Returns const-string.
Return split's action.
- (gnc:split-get-docref s)
- s is a Split*.
Returns const-string.
Return split's document reference.
- (gnc:split-get-reconcile-state s)
- s is a Split*.
Returns char.
Return split's reconcile state.
- (gnc:split-get-reconciled-date s)
- s is a Split*.
Returns time-pair.
Return split's reconciliation date.
- (gnc:split-get-share-amount s)
- s is a Split*.
Returns double.
Return split's share amount.
- (gnc:split-get-share-price s)
- s is a Split*.
Returns double.
Return split's share price.
- (gnc:split-get-value s)
- s is a Split*.
Returns double.
Return split's value.
- (gnc:split-get-account s)
- s is a Split*.
Returns Account*.
Return split's account.
- (gnc:split-get-parent s)
- s is a Split*.
Returns Transaction*.
Return the parent transaction of the split.
- (gnc:transaction-get-split t i)
- t is a Transaction*, i is a int.
Returns Split*.
Returns a pointer to each of the splits in this transaction. Valid
values for i are zero to (number_of__splits-1). An invalid value of i
will cause NULL to be returned. A convenient way of cycling through
all splits is to start at zero, and kep incrementing until a null
pointer is returned.
- (gnc:transaction-get-num t)
- t is a Transaction*.
Returns const-string.
Return the transaction's num, an arbitrary user-assigned field. It
is intended to store a short id number, typically the check number,
deposit number, invoice number or other tracking number.
- (gnc:transaction-get-description t)
- t is a Transaction*.
Returns const-string.
Return the transaction description, an arbitrary user-assigned
value. It is meant to be a short descriptive phrase.
- (gnc:transaction-get-docref t)
- t is a Transaction*.
Returns const-string.
The docref field is a hook for arbitrary additional user-assigned
data, such as invoice numbers, clearing/posting reference numbers,
supporting document references, etc. This additional data should be
encoded in a machine-readable format, e.g. a mime-type encapsulated
form, which any key-value pairs being URL-encoded.
- (gnc:dmy2timespec day month year)
- day is a int, month is a int, year is a int.
Returns time-pair.
Return a given day, month, and year as a pair where the car is the
number of seconds and the cdr is the number of nanoseconds. FIXME:
since when?.
- (gnc:transaction-get-date-posted t)
- t is a Transaction*.
Returns time-pair.
Return the date the transaction was posted at the bank as a pair of
integers. The car is the number of seconds and the cdr is the number
of nanoseconds. FIXME: since when?
- (gnc:transaction-get-date-entered t)
- t is a Transaction*.
Returns time-pair.
Return the date the transaction was entered into the register as a
pair of integers. The car is the number of seconds and the cdr is the
number of nanoseconds. FIXME: since when?
- (gnc:transaction-set-date-posted t date)
- t is a Transaction*, date is a time-pair.
No return value.
Modifies the posted date of the transaction. (Footnote: this
shouldn't matter to a user, but anyone modifying the engine should
understand that when the transaction is committed, the date order of
each of the component splits will be checked, and they will be
restored in ascending date order.) The date given should be a pair of
integers. The car is the number of seconds and the cdr is the number
of nanoseconds. FIXME: since when?
- (gnc:transaction-set-date-entered t date)
- t is a Transaction*, date is a time-pair.
No return value.
Modifies entered date of the transaction. The date given should be a
pair of integers. The car is the number of seconds and the cdr is the
number of nanoseconds. FIXME: since when?
- (gnc:transaction-set-date-today t)
- t is a Transaction*.
No return value.
Sets the posted date of the transaction to today.
- (gnc:transaction-get-split-count t)
- t is a Transaction*.
Returns int.
Return the number of splits in the transaction.
- (gnc:count-splits splits)
- splits is a Split**.
Returns int.
Returns the number of splits in the array.
- (gnc:transaction-is-common-currency trans currency)
- trans is a Transaction*, currency is a const-string.
Returns bool.
Returns true if the currency is common in the transaction.
- (gnc:account-type->symbol type)
- type is a int.
Returns string-as-symbol.
Convert the account type to a symbol.
- (gnc:malloc-account)
- Returns Account*.
Allocate a new account structure.
- (gnc:init-account account)
- account is a Account*.
No return value.
Initialize an account structure.
- (gnc:free-account account)
- account is a Account*.
No return value.
Free an account structure.
- (gnc:account-begin-edit a defer)
- a is a Account*, defer is a int.
No return value.
The gnc:account-begin-edit and gnc:account-commit-edit
subroutines provide a psuedo-two-phase-commit wrapper for account
updates. They are mildly useful for detecting attempted updates
outside of their scope. However, they do not provide any true
two-phase-anything in the current implementation. The defer flag, if
set, will defer all attempts at rebalancing of accounts until the
commit.
- (gnc:account-commit-edit a)
- a is a Account*.
No return value.
The gnc:account-begin-edit and gnc:account-commit-edit
subroutines provide a psuedo-two-phase-commit wrapper for account
updates. They are mildly useful for detecting attempted updates
outside of their scope. However, they do not provide any true
two-phase-anything in the current implementation. The defer flag, if
set, will defer all attempts at rebalancing of accounts until the
commit.
- (gnc:account-get-id a)
- a is a Account*.
Returns int.
Retrieve an account's ID.
- (gnc:account-get-flags a)
- a is a Account*.
Returns char.
Retrieve an account's flags.
- (gnc:account-insert-split a s)
- a is a Account*, s is a Split*.
No return value.
Insert the split s into account a. If the split already belongs
to another account, it will be removed from that account first.
- (gnc:check-date-order a s)
- a is a Account*, s is a Split*.
Returns int.
Check to see if split s is in proper sorted date order with respect
to the other splits in account a.
- (gnc:check-trans-date-order t)
- t is a Transaction*.
Returns int.
Check to see if all of the splits in transaction t are in proper
date order.
- (gnc:account-occurences-in-list a l)
- a is a Account*, l is a Account**.
Returns int.
Return the number of times that account a appears in account list l.
- (gnc:account-order a1 a2)
- a1 is a Account**, a2 is a Account**.
Returns int.
Defines a sorting order on accounts. Returns -1 if a1 is "less
than" the second, +1 if the a1 is "greater than" the second, and 0
if they are equal. To determine the sort order, the account codes are
compared, and if these are equal, then account types, and, if these
are equal, then account names.
- (gnc:account-auto-code a digits)
- a is a Account*, digits is a int.
No return value.
Assign an automatically * generated account code to the account, if
one does not already exist. Account codes will have the indicated
number of digits in them. The numbering scheme roughly follows
generally accepted accounting practice, in that top-level accounts
will be number 100, 200, etc., second level accounts 110, 120,
... 210, 220, ... etc. and third level accounts 111, 112, ... etc.
- (gnc:move-far-end s a)
- s is a Split*, a is a Account*.
No return value.
Change the account to which the "far end" of the split belongs.
The "far end" is as follows: double-entry transactions by thier
nature consist of a set of two or more splits. If the transaction has
precisely two splits, then the "far end" is the "other split" of
the pair. If the transaction consists of three or more splits, then
the "far end" is undefined. All this procedure does is reparent the
"other split" to the indicated account.
- (gnc:move-far-end-by-name s accountname)
- s is a Split*, accountname is a const-string.
No return value.
Change the account to which the "far end" of the split belongs to
the account named accountname. The "far end" is as follows: double-entry
transactions by thier nature consist of a set of two or more splits.
If the transaction has precisely two splits, then the "far end" is
the "other split" of the pair. If the transaction consists of three
or more splits, then the "far end" is undefined. All this procedure
does is reparent the "other split" to the indicated account.
- (gnc:account-set-type a type)
- a is a Account*, type is a int.
No return value.
Set Account type.
Select from:
BANK = 0,
CASH = 1,
ASSET = 2,
CREDIT = 3,
LIABILITY = 4,
STOCK = 5,
MUTUAL= 6,
CURRENCY = 7,
INCOME = 8,
EXPENSE = 9,
EQUITY = 10,
NUM_ACCOUNT_TYPES = 11,
CHECKING = 11,
SAVINGS = 12,
MONEYMRKT = 13,
CREDITLINE = 14
- (gnc:account-set-name a name)
- a is a Account*, name is a const-string.
No return value.
Set account name
- (gnc:account-set-code a code)
- a is a Account*, code is a const-string.
No return value.
Set whatever cryptic code we wish to use as the alternative to
the account name.
Commonly these codes are numeric, and organize asset accounts together
in one number range, liability accounts in another number range, and
so forth...
- (gnc:account-set-description a description)
- a is a Account*, description is a const-string.
No return value.
Set a slightly-more-verbose description for the account.
- (gnc:account-set-notes a notes)
- a is a Account*, notes is a const-string.
No return value.
Set up a longer set of notes that provide a perhaps-very-verbose
description of the nature of a particular account.
- (gnc:account-set-currency a currency)
- a is a Account*, currency is a const-string.
No return value.
Set the account's currency.
- (gnc:account-set-security a security)
- a is a Account*, security is a const-string.
No return value.
Set the name of the security in which the account is denominated
This means that if the account is tracking (say) my holdings of RHAT
stock, that will be the currency, and the amount in the account will
be the number of shares. The value of that will be estimated as the
number of shares times the present trading price.
- (gnc:account-get-type-string type)
- type is a int.
Returns const-string.
What's the account type's name.
- (gnc:account-get-type a)
- a is a Account*.
Returns int.
What's the account type?
Values range thusly:
BANK = 0,
CASH = 1,
ASSET = 2,
CREDIT = 3,
LIABILITY = 4,
STOCK = 5,
MUTUAL= 6,
CURRENCY = 7,
INCOME = 8,
EXPENSE = 9,
EQUITY = 10,
NUM_ACCOUNT_TYPES = 11,
CHECKING = 11,
SAVINGS = 12,
MONEYMRKT = 13,
CREDITLINE = 14
- (gnc:account-get-name a)
- a is a Account*.
Returns const-string.
Get the brief name for the account.
- (gnc:account-get-code a)
- a is a Account*.
Returns const-string.
Get the account's ``account code.''
Commonly this is used to provide a hierarchy where accounts with
similar classifications (e.g. - Assets, Liabilities, Equity, Income,
Expenses) are given numeric codes in corresponding ``number ranges.''
- (gnc:account-get-description a)
- a is a Account*.
Returns const-string.
Get the slightly-verbose description of the account.
- (gnc:account-get-notes a)
- a is a Account*.
Returns const-string.
Get the fully-verbose description of the account.
- (gnc:account-get-currency a)
- a is a Account*.
Returns const-string.
Get the currency in which the account is denominated.
- (gnc:account-get-security a)
- a is a Account*.
Returns const-string.
If set, this indicates the security being tracked as the account
balance.
For instance, I might track my Motorola shares by specifying the
security as MOT, and then query the stock price periodically in order
to determine the value in $USD.
- (gnc:account-get-share-balance a)
- a is a Account*.
Returns double.
Return the number of shares held in a security account.
- (gnc:account-get-children a)
- a is a Account*.
Returns AccountGroup*.
Get a pointer to an AccountGroup that represents the set of
children to this account.
- (gnc:account-get-parent a)
- a is a Account*.
Returns AccountGroup*.
Get the pointer to the account's parent.
- (gnc:account-get-acc-info a)
- a is a Account*.
Returns AccInfo*.
Retrieve the AccInfo structure, a union of the other auxiliary
account info types, notably including:
- InvAcct, which stores investment information, and
- BankAcct, which stores bank account information.
These data structures store information used with OFX.
- (gnc:account-get-balance a)
- a is a Account*.
Returns double.
Undocumented.
- (gnc:account-get-cleared-balance a)
- a is a Account*.
Returns double.
Undocumented.
- (gnc:account-get-reconciled-balance a)
- a is a Account*.
Returns double.
Undocumented.
- (gnc:account-get-split a i)
- a is a Account*, i is a int.
Returns Split*.
Get the ith split recorded in account a.
- (gnc:account-get-split-list a)
- a is a Account*.
Returns Split**.
Get the list of splits in account a
- (gnc:account-get-split-count a)
- a is a Account*.
Returns int.
Get the number of splits recorded in account a.
- (gnc:account-nth-account a i)
- a is a Account**, i is a int.
Returns Account*.
Undocumented.
- (gnc:cast-to-inv-acct a)
- a is a AccInfo*.
Returns InvAcct*.
The AccInfo structure is just a union of the other account
auxilliary info types. The xaccCastToXXX() functions simply provide a
safe upcast mechanism (similar to that in C++ ... returns the address
if the cast is safe, otherwise returns NULL).
- (gnc:inv-acct-set-price-src a src)
- a is a InvAcct*, src is a const-string.
No return value.
The xaccInvAcctSetPriceSrc() and
xaccInvAcctGetPriceSrc() routines are used to get and set a string
that identifies the current source for investment pricing info.
Currently supported values include "yahoo", "fidelity",
"troweprice", etc.
- (gnc:inv-acct-get-price-src a)
- a is a InvAcct*.
Returns const-string.
The xaccInvAcctSetPriceSrc() and
xaccInvAcctGetPriceSrc() routines are used to get and set a string
that identifies the current source for investment pricing info.
Currently supported values include "yahoo", "fidelity",
"troweprice", etc.
- (gnc:malloc-account-group)
- Returns AccountGroup*.
Create a newaccount group.
- (gnc:merge-accounts g)
- g is a AccountGroup*.
No return value.
Merge accounts which have the same name and description. Used in
importing Quicken files.
- (gnc:get-num-accounts g)
- g is a AccountGroup*.
Returns int.
Return the number of accounts, including subaccounts, in the account
group
- (gnc:group-get-num-accounts g)
- g is a AccountGroup*.
Returns int.
Return the number of accounts in the indicated group only
(children not counted).
- (gnc:group-get-account g n)
- g is a AccountGroup*, n is a int.
Returns Account*.
Return account number n in account group g.
- (gnc:get-account-from-full-name g name separator)
- g is a AccountGroup*, name is a const-string, separator is a char.
Returns Account*.
Return account named name in group g. full path with separators.
- (gnc:group-get-parent g)
- g is a AccountGroup*.
Returns Account*.
Return the parent acount for the group.
- (gnc:group-get-balance g)
- g is a AccountGroup*.
Returns double.
Return balance of account group g.
- (gnc:group-insert-account g a)
- g is a AccountGroup*, a is a Account*.
No return value.
Add account a to group g.
- (gnc:insert-subaccount p c)
- p is a Account*, c is a Account*.
No return value.
Add a child account c to parent p
- (gnc:get-accounts g)
- g is a AccountGroup*.
Returns Account**.
Return an array containing all of the accounts, including
subaccounts, in the account group. The returned array should be freed
when no longer needed.
- (gnc:group-begin-staged-transaction-traversals group)
- group is a AccountGroup*.
No return value.
Sets things up to begin a sequence of staged traversals.
- (gnc:group-staged-transaction-traversal group stage thunk)
- group is a AccountGroup*, stage is a unsigned-int, thunk is a tSCM.
Returns bool.
FIXME: For now, see Group.h for info...
- (gnc:account-staged-transaction-traversal account stage thunk)
- account is a Account*, stage is a unsigned-int, thunk is a tSCM.
Returns bool.
FIXME: For now, see Group.h for info...
- (gnc:malloc-session)
- Returns Session*.
Allocates memory for a session object.
- (gnc:init-session s)
- s is a Session*.
No return value.
Initializes a session object.
- (gnc:session-destroy s)
- s is a Session*.
No return value.
Destroy a session object, and free the associated memory. Note that
this routine does *not* free the account group!
- (gnc:session-begin-file s filename)
- s is a Session*, filename is a const-string.
Returns AccountGroup*.
Undocumented.
- (gnc:session-get-group s)
- s is a Session*.
Returns AccountGroup*.
Undocumented.
- (gnc:session-save s)
- s is a Session*.
No return value.
Undocumented.
- (gnc:session-end s)
- s is a Session*.
No return value.
Undocumented.
- (gnc:malloc-query)
- Returns Query*.
Allocate a new query structure.
- (gnc:free-query q)
- q is a Query*.
No return value.
Free a query structure.
- (gnc:query-set-group q group)
- q is a Query*, group is a AccountGroup*.
No return value.
Set the account group the query will search through.
- (gnc:query-add-account q account query-op)
- q is a Query*, account is a Account*, query-op is a int.
No return value.
Add an account to a query.
- (gnc:query-get-splits q)
- q is a Query*.
Returns Split**.
Add an account to the query list
- (gnc:file-query-save)
- Returns bool.
Query the user whether to save the current file, and save
if they say 'Yes'. The return is false if the user says 'Cancel'.
- (gnc:file-quit)
- No return value.
Stop working with the current file.
- (gnc:history-get-last)
- Returns const-string.
Get the last file opened by the user.
- (gnc:locale-default-currency)
- Returns const-string.
Return the 3-character currency code of the current locale.
- (gnc:amount->string-helper amount print_currency_symbol print_separators is_shares_value curr_code)
- amount is a double, print_currency_symbol is a bool, print_separators is a bool, is_shares_value is a bool, curr_code is a const-string.
Returns const-string.
Print amount using current locale. The boolean arguments
determine formatting details. The string argument is an ISO currency code.
- (gnc:set-log-level-global level)
- level is a int.
No return value.
Set the logging level for all modules to level.
- (gnc:print-date date)
- date is a time-pair.
Returns const-string.
Returns a string with the date formatted according to the
current settings
- (gnc:option-refresh-ui option)
- option is a tSCM.
No return value.
Refresh the gui option with the current values.
- (gnc:option-invoke-callback callback data)
- callback is a OptionChangeCallback, data is a void*.
No return value.
Invoke the c option callback on the given data.
- (gnc:option-db-register-option db_handle option)
- db_handle is a int, option is a tSCM.
No return value.
Register the option with the option database db_handle.
- (gnc:lowlev-app-init)
- Returns int.
Low-level startup code.
- (gnc:ui-is-running?)
- Returns bool.
Predicate to determine if the UI is running.
- (gnc:ui-is-terminating?)
- Returns bool.
Predicate to determine if the UI is in the process of terminating.
- (gnc:ui-open-file filename)
- filename is a const-string.
Returns int.
Open filename.
- (gnc:ui-select-file)
- Returns int.
Open a UI to select and open a file.
- (gnc:ui-main)
- Returns int.
Main procedure for the UI.
- (gnc:ui-shutdown)
- No return value.
Shutdown the UI.
- (gnc:ui-destroy-all-subwindows)
- No return value.
Destroy all of the UI windows except for the main window.
- (gnc:ui-destroy)
- No return value.
Destroy the UI.
- (gnc:refresh-main-window)
- No return value.
Refresh the main window.
- (gnc:error-dialog message)
- message is a const-string.
No return value.
Show ok dialog box with given error message.
- (gnc:verify-dialog message yes_is_default)
- message is a const-string, yes_is_default is a bool.
Returns bool.
Show yes/no dialog box with given message.
- (gnc:get-current-accounts)
- Returns tSCM.
Get an SCM list of the current accounts
- (gnc:report-window title rendering-thunk options)
- title is a const-string, rendering-thunk is a tSCM, options is a tSCM.
No return value.
Show report window with the rendering-thunk and options.
- (gnc:info-dialog message)
- message is a const-string.
No return value.
Show ok dialog box with given message.
- (gnc:warning-dialog message)
- message is a const-string.
No return value.
Show warning dialog box with given message.
- (gnc:choose-item-from-list-dialog title items)
- title is a const-string, items is a tSCM.
Returns tSCM.
Display a dialog with a cancel button, allowing the
user to select an item from a list. The items parameter should be a
list of pairs of the form (name . thunk). The thunk will be called
with no arguments when the user clicks the item associated with name.
If the thunk returns a non #f value, then that value will be returned
as the result of this function in a pair of the form (cons 'result
value) (using a pair means that #f can be a legitimate return value).
This function may also return 'cancel if the user clicks cancel, or #f
if there's an unrecoverable error.
- (gnc:file-selection-dialog title filter)
- title is a const-string, filter is a const-string.
Returns const-string.
Lets the user select a file. Dialog has given title and filter.
- (gnc:add-extension extension)
- extension is a tSCM.
No return value.
- (gnc:get-current-group)
- Returns AccountGroup*.
Get the current top-level group.
- (gnc:transaction-destroy t)
- t is a Transaction*.
No return value.
Destroys the transaction in question.
- (gnc:transaction-begin-edit t defer)
- t is a Transaction*, defer is a int.
No return value.
Start an edit session on a transaction.
- (gnc:transaction-commit-edit t)
- t is a Transaction*.
No return value.
Commit edits to a transaction.
- (gnc:transaction-is-open t)
- t is a Transaction*.
Returns bool.
Returns true if the transaction t is open for editing.
- (gnc:split-destroy s)
- s is a Split*.
No return value.
Destroys the split in question. Probably only useful inside the context
of having a parent transaction with which one is working...
- (gnc:transaction-append-split t s)
- t is a Transaction*, s is a Split*.
No return value.
Adds a split to a transaction.
- (gnc:transaction-set-date t day month year)
- t is a Transaction*, day is a int, month is a int, year is a int.
No return value.
Set date on transaction based on day, month, year values
- (gnc:transaction-set-date-time-pair t date)
- t is a Transaction*, date is a time-pair.
No return value.
Set date on transaction based on the time-pair
- (gnc:transaction-set-xnum t xnum)
- t is a Transaction*, xnum is a const-string.
No return value.
Set the XNUM - e.g. - cheque number or other identifier
- (gnc:transaction-set-description t desc)
- t is a Transaction*, desc is a const-string.
No return value.
Set the transaction description.
- (gnc:transaction-set-docref t docs)
- t is a Transaction*, docs is a const-string.
No return value.
Set docref field on transaction
- (gnc:transaction-set-memo t mimeo)
- t is a Transaction*, mimeo is a const-string.
No return value.
Set Memo field on transaction
- (gnc:transaction-set-action t action)
- t is a Transaction*, action is a const-string.
No return value.
Set action on transaction
- (gnc:transaction-create)
- Returns Transaction*.
Create a Transaction structure
- (gnc:transaction-init t)
- t is a Transaction*.
No return value.
Create a Transaction structure
- (gnc:split-create)
- Returns Split*.
Create a Split structure
- (gnc:split-set-value s amount)
- s is a Split*, amount is a double.
No return value.
Set value for split
- (gnc:split-set-base-value s amount currency)
- s is a Split*, amount is a double, currency is a const-string.
No return value.
Set value for split with currency
- (gnc:split-set-memo s memo)
- s is a Split*, memo is a const-string.
No return value.
Set memo for a split
- (gnc:split-set-action s action)
- s is a Split*, action is a const-string.
No return value.
Set Action for a split.
- (gnc:split-set-docref s docs)
- s is a Split*, docs is a const-string.
No return value.
Set document reference for split entry
- (gnc:split-set-reconcile s value)
- s is a Split*, value is a char.
No return value.
Set reconcile state for split entry
- (gnc:split-set-share-price s value)
- s is a Split*, value is a double.
No return value.
Set share price for split entry
- (gnc:split-set-share-amount s value)
- s is a Split*, value is a double.
No return value.
Set number of shares for split entry
- (gnc:split-set-share-price-and-amount s price amount)
- s is a Split*, price is a double, amount is a double.
No return value.
Set the share price and amount for split entry
- (gnc:gettext-helper string)
- string is a const-string.
Returns const-string.
Returns the translated version of string
- (gnc:print-session-create)
- Returns PrintSession*.
Start a new print session.
- (gnc:print-session-destroy p)
- p is a PrintSession*.
No return value.
Free a print session's resources
- (gnc:print-session-moveto p x y)
- p is a PrintSession*, x is a double, y is a double.
No return value.
Move the current point
- (gnc:print-session-text p text)
- p is a PrintSession*, text is a const-string.
No return value.
Show some text in Courier 16
- (gnc:print-session-done p)
- p is a PrintSession*.
No return value.
Let the print context know you're finished with it.
- (gnc:print-dialog-create p)
- p is a PrintSession*.
Returns PrintDialog*.
Pop up a dialog to allow a PrintSession to be previewed or printed.
- (gnc:print-check-dialog-create callback)
- callback is a tSCM.
Returns PrintCheckDialog*.
Pop up a dialog to set up printing a check.
- (gnc:is-euro-currency currency)
- currency is a const-string.
Returns bool.
Check if a given currency is a EURO currency
- (gnc:convert-to-euro currency value)
- currency is a const-string, value is a double.
Returns double.
Convert a amount in a given currency to EURO
- (gnc:convert-from-euro currency value)
- currency is a const-string, value is a double.
Returns double.
Convert a amount in EURO to a given currency
- (gnc:budget-dialog-create budget apply_func)
- budget is a tSCM, apply_func is a tSCM.
Returns BudgetDialog*.
Create a budget dialog using the given budget. The apply_func is called when the user clicks 'Ok' or 'Apply'.
- (gnc:account-reverse-balance? account)
- account is a Account*.
Returns bool.
Given an account, find out whether the balance should be reversed for display