mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-11-29 12:14:31 -06:00
106 lines
3.4 KiB
C
106 lines
3.4 KiB
C
/* gncBusiness.h -- Business Helper Functions
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License as
|
|
* published by the Free Software Foundation; either version 2 of
|
|
* the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, contact:
|
|
*
|
|
* Free Software Foundation Voice: +1-617-542-5942
|
|
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652
|
|
* Boston, MA 02110-1301, USA gnu@gnu.org
|
|
*/
|
|
/** @addtogroup Engine
|
|
@{ */
|
|
/** @addtogroup Business
|
|
The Business Engine provides a set of structures for
|
|
that provide small-business accounting features.
|
|
@{ */
|
|
|
|
/** @file gncBusiness.h -- Business Helper Functions
|
|
* @author Copyright (C) 2002 Derek Atkins
|
|
* @author Derek Atkins <warlord@MIT.EDU>
|
|
*/
|
|
|
|
/** @} */
|
|
/** @} */
|
|
#ifndef GNC_BUSINESS_H_
|
|
#define GNC_BUSINESS_H_
|
|
|
|
#include <glib.h>
|
|
|
|
#include "qof.h"
|
|
#include "Account.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
/* KVP key for report PDF directories */
|
|
#define OWNER_EXPORT_PDF_DIRNAME "export-pdf-directory"
|
|
#define LAST_POSTED_TO_ACCT "last-posted-to-acct"
|
|
#define GNC_PAYMENT "payment"
|
|
#define GNC_LAST_ACCOUNT "last_acct"
|
|
|
|
/* @deprecated backwards-compat definitions */
|
|
#define GNC_BILLTERM_MODULE_NAME GNC_ID_BILLTERM
|
|
#define GNC_CUSTOMER_MODULE_NAME GNC_ID_CUSTOMER
|
|
#define GNC_EMPLOYEE_MODULE_NAME GNC_ID_EMPLOYEE
|
|
#define GNC_ENTRY_MODULE_NAME GNC_ID_ENTRY
|
|
#define GNC_INVOICE_MODULE_NAME GNC_ID_INVOICE
|
|
#define GNC_JOB_MODULE_NAME GNC_ID_JOB
|
|
#define GNC_ORDER_MODULE_NAME GNC_ID_ORDER
|
|
#define GNC_OWNER_MODULE_NAME GNC_ID_OWNER
|
|
#define GNC_TAXTABLE_MODULE_NAME GNC_ID_TAXTABLE
|
|
#define GNC_VENDOR_MODULE_NAME GNC_ID_VENDOR
|
|
|
|
/* The initialization of the business objects is done in
|
|
* cashobjects_register() of <engine/cashobjects.h>. */
|
|
|
|
#ifndef DI
|
|
# ifdef _MSC_VER
|
|
/* MSVC compiler doesn't have C99 "designated initializers"
|
|
* so we wrap them in a macro that is empty on MSVC. */
|
|
# define DI(x) /* */
|
|
# else
|
|
# define DI(x) x
|
|
# endif
|
|
#endif
|
|
|
|
/** Returns a GList of all objects of the given type_name in the given
|
|
* book. */
|
|
GList * gncBusinessGetList (QofBook *book, QofIdTypeConst type_name,
|
|
gboolean all_including_inactive);
|
|
|
|
/** For SWIG: A GList containing GncOwner. */
|
|
typedef GList OwnerList;
|
|
|
|
/** Returns a GList of all objects of the given type_name in the given
|
|
* book, but each object is wrapped in a GncOwner object.
|
|
*
|
|
* The wrapping was done by qofOwnerSetEntity(), hence the owner will
|
|
* contain data only for {CUSTOMER, JOB, VENDOR, EMPLOYEE}, otherwise
|
|
* the owner will be of type GNC_OWNER_NONE and not contain the
|
|
* original data. */
|
|
OwnerList * gncBusinessGetOwnerList (QofBook *book, QofIdTypeConst type_name,
|
|
gboolean all_including_inactive);
|
|
|
|
/** Returns whether the given account type is a valid type to use in
|
|
* business payments. Currently payments are allowed to/from assets,
|
|
* liabilities and equity accounts. */
|
|
gboolean gncBusinessIsPaymentAcctType (GNCAccountType type);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* GNC_BUSINESS_H_ */
|