mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
Restructure the src directory
It is split into - /libgnucash (for the non-gui bits) - /gnucash (for the gui) - /common (misc source files used by both) - /bindings (currently only holds python bindings) This is the first step in restructuring the code. It will need much more fine tuning later on.
This commit is contained in:
121
libgnucash/engine/gncJob.h
Normal file
121
libgnucash/engine/gncJob.h
Normal file
@@ -0,0 +1,121 @@
|
||||
/********************************************************************\
|
||||
* gncJob.h -- the Core Job Interface *
|
||||
* *
|
||||
* 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 Business
|
||||
@{ */
|
||||
/** @addtogroup Job
|
||||
@{ */
|
||||
/** @file gncJob.h
|
||||
@brief Job Interface
|
||||
@author Copyright (C) 2001, 2002 Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
|
||||
#ifndef GNC_JOB_H_
|
||||
#define GNC_JOB_H_
|
||||
|
||||
typedef struct _gncJob GncJob;
|
||||
typedef struct _gncJobClass GncJobClass;
|
||||
|
||||
#include "gncAddress.h"
|
||||
#include "gncOwner.h"
|
||||
|
||||
#define GNC_ID_JOB "gncJob"
|
||||
|
||||
/* --- type macros --- */
|
||||
#define GNC_TYPE_JOB (gnc_job_get_type ())
|
||||
#define GNC_JOB(o) \
|
||||
(G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_JOB, GncJob))
|
||||
#define GNC_JOB_CLASS(k) \
|
||||
(G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_JOB, GncJobClass))
|
||||
#define GNC_IS_JOB(o) \
|
||||
(G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_JOB))
|
||||
#define GNC_IS_JOB_CLASS(k) \
|
||||
(G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_JOB))
|
||||
#define GNC_JOB_GET_CLASS(o) \
|
||||
(G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_JOB, GncJobClass))
|
||||
GType gnc_job_get_type(void);
|
||||
|
||||
/* Create/Destroy Functions */
|
||||
|
||||
GncJob *gncJobCreate (QofBook *book);
|
||||
void gncJobDestroy (GncJob *job);
|
||||
|
||||
/** \name Set Functions
|
||||
@{
|
||||
*/
|
||||
|
||||
void gncJobSetID (GncJob *job, const char *id);
|
||||
void gncJobSetName (GncJob *job, const char *jobname);
|
||||
void gncJobSetReference (GncJob *job, const char *owner_reference);
|
||||
void gncJobSetRate (GncJob *job, gnc_numeric rate);
|
||||
void gncJobSetOwner (GncJob *job, GncOwner *owner);
|
||||
void gncJobSetActive (GncJob *job, gboolean active);
|
||||
|
||||
/** @} */
|
||||
void gncJobBeginEdit (GncJob *job);
|
||||
void gncJobCommitEdit (GncJob *job);
|
||||
|
||||
/** \name Get Functions
|
||||
@{
|
||||
*/
|
||||
|
||||
const char * gncJobGetID (const GncJob *job);
|
||||
const char * gncJobGetName (const GncJob *job);
|
||||
const char * gncJobGetReference (const GncJob *job);
|
||||
gnc_numeric gncJobGetRate (const GncJob *job);
|
||||
GncOwner * gncJobGetOwner (GncJob *job);
|
||||
gboolean gncJobGetActive (const GncJob *job);
|
||||
|
||||
/** @} */
|
||||
|
||||
/** Return a pointer to the instance gncJob that is identified
|
||||
* by the guid, and is residing in the book. Returns NULL if the
|
||||
* instance can't be found.
|
||||
* Equivalent function prototype is
|
||||
* GncJob * gncJobLookup (QofBook *book, const GncGUID *guid);
|
||||
*/
|
||||
static inline GncJob * gncJobLookup (const QofBook *book, const GncGUID *guid)
|
||||
{
|
||||
QOF_BOOK_RETURN_ENTITY(book, guid, GNC_ID_JOB, GncJob);
|
||||
}
|
||||
|
||||
/* Other functions */
|
||||
|
||||
int gncJobCompare (const GncJob *a, const GncJob *b);
|
||||
gboolean gncJobEqual(const GncJob *a, const GncJob *b);
|
||||
|
||||
#define JOB_ID "id"
|
||||
#define JOB_NAME "name"
|
||||
#define JOB_REFERENCE "reference"
|
||||
#define JOB_RATE "rate"
|
||||
#define JOB_OWNER "owner"
|
||||
#define Q_JOB_OWNER "owner_collection"
|
||||
#define JOB_ACTIVE "active"
|
||||
|
||||
/** deprecated functions */
|
||||
#define gncJobGetBook(x) qof_instance_get_book(QOF_INSTANCE(x))
|
||||
#define gncJobGetGUID(x) qof_instance_get_guid(QOF_INSTANCE(x))
|
||||
#define gncJobRetGUID(x) (x ? *(qof_instance_get_guid(QOF_INSTANCE(x))) : *(guid_null()))
|
||||
#define gncJobLookupDirect(G,B) gncJobLookup((B),&(G))
|
||||
|
||||
#endif /* GNC_JOB_H_ */
|
||||
/** @} */
|
||||
/** @} */
|
||||
Reference in New Issue
Block a user