131 lines
3.5 KiB
C
131 lines
3.5 KiB
C
/*
|
|
* e-util-enums.h
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) version 3.
|
|
*
|
|
* 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with the program; if not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
|
|
#error "Only <e-util/e-util.h> should be included directly."
|
|
#endif
|
|
|
|
#ifndef E_UTIL_ENUMS_H
|
|
#define E_UTIL_ENUMS_H
|
|
|
|
#include <glib.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* EActivityState:
|
|
* @E_ACTIVITY_RUNNING:
|
|
* The #EActivity is running.
|
|
* @E_ACTIVITY_WAITING:
|
|
* The #EActivity is waiting to be run.
|
|
* @E_ACTIVITY_CANCELLED:
|
|
* The #EActivity has been cancelled.
|
|
* @E_ACTIVITY_COMPLETED:
|
|
* The #EActivity has completed.
|
|
*
|
|
* Various states of an #EActivity.
|
|
**/
|
|
typedef enum {
|
|
E_ACTIVITY_RUNNING,
|
|
E_ACTIVITY_WAITING,
|
|
E_ACTIVITY_CANCELLED,
|
|
E_ACTIVITY_COMPLETED
|
|
} EActivityState;
|
|
|
|
/**
|
|
* EAutomaticActionPolicy:
|
|
* @E_AUTOMATIC_ACTION_POLICY_ASK:
|
|
* Ask the user whether to perform the action.
|
|
* @E_AUTOMATIC_ACTION_POLICY_ALWAYS:
|
|
* Perform the action without interrupting the user.
|
|
* @E_AUTOMATIC_ACTION_POLICY_NEVER:
|
|
* Do not perform the action and do not interrupt the user.
|
|
*
|
|
* Used for automatable actions based on the user's preference. The user
|
|
* is initially asked whether to perform the action automatically, and is
|
|
* given either-or choices like "Yes, Always" or "No, Never". The user's
|
|
* response is then remembered for future sessions.
|
|
**/
|
|
typedef enum {
|
|
E_AUTOMATIC_ACTION_POLICY_ASK,
|
|
E_AUTOMATIC_ACTION_POLICY_ALWAYS,
|
|
E_AUTOMATIC_ACTION_POLICY_NEVER
|
|
} EAutomaticActionPolicy;
|
|
|
|
/**
|
|
* EDateWeekday:
|
|
* @E_DATE_BAD_WEEKDAY:
|
|
* Invalid value
|
|
* @E_DATE_MONDAY:
|
|
* Monday
|
|
* @E_DATE_TUESDAY:
|
|
* Tuesday
|
|
* @E_DATE_WEDNESDAY:
|
|
* Wednesday
|
|
* @E_DATE_THURSDAY:
|
|
* Thursday
|
|
* @E_DATE_FRIDAY:
|
|
* Friday
|
|
* @E_DATE_SATURDAY:
|
|
* Saturday
|
|
* @E_DATE_SUNDAY:
|
|
* Sunday
|
|
*
|
|
* Enumeration representing a day of the week; @E_DATE_MONDAY,
|
|
* @E_DATE_TUESDAY, etc. @G_DATE_BAD_WEEKDAY is an invalid weekday.
|
|
*
|
|
* This enum type is intentionally compatible with #GDateWeekday.
|
|
* It exists only because GLib does not provide a #GEnumClass for
|
|
* #GDateWeekday. If that ever changes, this enum can go away.
|
|
**/
|
|
/* XXX Be pedantic with the value assignments to ensure compatibility. */
|
|
typedef enum {
|
|
E_DATE_BAD_WEEKDAY = G_DATE_BAD_WEEKDAY,
|
|
E_DATE_MONDAY = G_DATE_MONDAY,
|
|
E_DATE_TUESDAY = G_DATE_TUESDAY,
|
|
E_DATE_WEDNESDAY = G_DATE_WEDNESDAY,
|
|
E_DATE_THURSDAY = G_DATE_THURSDAY,
|
|
E_DATE_FRIDAY = G_DATE_FRIDAY,
|
|
E_DATE_SATURDAY = G_DATE_SATURDAY,
|
|
E_DATE_SUNDAY = G_DATE_SUNDAY
|
|
} EDateWeekday;
|
|
|
|
/**
|
|
* EDurationType:
|
|
* @E_DURATION_MINUTES:
|
|
* Duration value is in minutes.
|
|
* @E_DURATION_HOURS:
|
|
* Duration value is in hours.
|
|
* @E_DURATION_DAYS:
|
|
* Duration value is in days.
|
|
*
|
|
* Possible units for a duration or interval value.
|
|
*
|
|
* This enumeration is typically used where the numeric value and the
|
|
* units of the value are shown or recorded separately.
|
|
**/
|
|
typedef enum {
|
|
E_DURATION_MINUTES,
|
|
E_DURATION_HOURS,
|
|
E_DURATION_DAYS
|
|
} EDurationType;
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* E_UTIL_ENUMS_H */
|