Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

FreqSpec.h File Reference


Detailed Description

Period / Date Frequency Specification.

Author:
Copyright (C) 2001 Joshua Sled <jsled@asynchronous.org>

Copyright (C) 2001 Ben Stanley <bds02@uow.edu.au>

#include "config.h"
#include <glib.h>
#include "qofid.h"
#include "guid.h"
#include "qofbook.h"

Typedefs

typedef enum gncp_FreqType FreqType
typedef enum gncp_UIFreqType UIFreqType
typedef gncp_freq_spec FreqSpec

Enumerations

enum  gncp_FreqType {
  INVALID, ONCE, DAILY, WEEKLY,
  MONTHLY, MONTH_RELATIVE, COMPOSITE
}
enum  gncp_UIFreqType {
  UIFREQ_NONE, UIFREQ_ONCE, UIFREQ_DAILY, UIFREQ_DAILY_MF,
  UIFREQ_WEEKLY, UIFREQ_BI_WEEKLY, UIFREQ_SEMI_MONTHLY, UIFREQ_MONTHLY,
  UIFREQ_QUARTERLY, UIFREQ_TRI_ANUALLY, UIFREQ_SEMI_YEARLY, UIFREQ_YEARLY,
  UIFREQ_NUM_UI_FREQSPECS
}

Functions

FreqSpec * xaccFreqSpecMalloc (QofBook *book)
void xaccFreqSpecCleanUp (FreqSpec *fs)
void xaccFreqSpecFree (FreqSpec *fs)
FreqType xaccFreqSpecGetType (FreqSpec *fs)
void xaccFreqSpecSetUIType (FreqSpec *fs, UIFreqType newUIFreqType)
UIFreqType xaccFreqSpecGetUIType (FreqSpec *fs)
void xaccFreqSpecSetNone (FreqSpec *fs)
void xaccFreqSpecSetOnceDate (FreqSpec *fs, const GDate *when)
void xaccFreqSpecSetDaily (FreqSpec *fs, const GDate *initial_date, guint interval_days)
void xaccFreqSpecSetWeekly (FreqSpec *fs, const GDate *inital_date, guint interval_weeks)
void xaccFreqSpecSetMonthly (FreqSpec *fs, const GDate *inital_date, guint interval_months)
void xaccFreqSpecSetMonthRelative (FreqSpec *fs, const GDate *inital_date, guint interval_months)
void xaccFreqSpecSetComposite (FreqSpec *fs)
void xaccFreqSpecGetFreqStr (FreqSpec *fs, GString *str)
int xaccFreqSpecGetOnce (FreqSpec *fs, GDate *outGD)
int xaccFreqSpecGetDaily (FreqSpec *fs, int *outRepeat)
int xaccFreqSpecGetWeekly (FreqSpec *fs, int *outRepeat, int *outDayOfWeek)
int xaccFreqSpecGetMonthly (FreqSpec *fs, int *outRepeat, int *outDayOfMonth, int *outMonthOffset)
GList * xaccFreqSpecCompositeGet (FreqSpec *fs)
void xaccFreqSpecCompositeAdd (FreqSpec *fs, FreqSpec *fsToAdd)
void xaccFreqSpecGetNextInstance (FreqSpec *fs, const GDate *in_date, GDate *out_date)
int gnc_freq_spec_compare (FreqSpec *a, FreqSpec *b)


Generated on Sun May 23 15:41:46 2004 for QOF by doxygen 1.3.6-20040222