Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
PIM
KAlarm
Commits
61ed4e89
Commit
61ed4e89
authored
Jan 21, 2021
by
David Jarvie
Browse files
Improve API documentation
parent
889a0628
Changes
1
Hide whitespace changes
Inline
Side-by-side
src/kaevent.h
View file @
61ed4e89
...
...
@@ -2,7 +2,7 @@
* kaevent.h - represents KAlarm calendar events
* This file is part of kalarmcal library, which provides access to KAlarm
* calendar data.
* SPDX-FileCopyrightText: 2001-202
0
David Jarvie <djarvie@kde.org>
* SPDX-FileCopyrightText: 2001-202
1
David Jarvie <djarvie@kde.org>
*
* SPDX-License-Identifier: LGPL-2.0-or-later
*/
...
...
@@ -268,13 +268,31 @@ public:
LIMIT_REMINDER
//!< a reminder
};
/**
Alarm
trigger type. */
/**
Next
trigger type
for an alarm
. */
enum
TriggerType
{
ALL_TRIGGER
,
//!< next trigger, including reminders, ignoring working hours & holidays
MAIN_TRIGGER
,
//!< next trigger, excluding reminders, ignoring working hours & holidays
WORK_TRIGGER
,
//!< next main working time trigger, excluding reminders
ALL_WORK_TRIGGER
,
//!< next actual working time trigger, including reminders
DISPLAY_TRIGGER
//!< next trigger time for display purposes (i.e. excluding reminders)
/** Next trigger, including reminders. No account is taken of any
* working hours or holiday restrictions when evaluating this. */
ALL_TRIGGER
,
/** Next trigger of the main alarm, i.e. excluding reminders. No
* account is taken of any working hours or holiday restrictions when
* evaluating this. */
MAIN_TRIGGER
,
/** Next trigger of the main alarm, i.e. excluding reminders, taking
* account of any working hours or holiday restrictions. If the event
* has no working hours or holiday restrictions, this is equivalent to
* MAIN_TRIGGER. */
WORK_TRIGGER
,
/** Next trigger, including reminders, taking account of any working
* hours or holiday restrictions. If the event has no working hours or
* holiday restrictions, this is equivalent to ALL_TRIGGER. */
ALL_WORK_TRIGGER
,
/** Next trigger time for display purposes (i.e. excluding reminders). */
DISPLAY_TRIGGER
};
/** Command execution error type for last time the alarm was triggered. */
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment