File: org-clock.el.html

This file contains the time clocking code for Org mode

Defined variables (61)

org-clock-ask-before-exitingIf non-nil, ask if the user wants to clock out before exiting Emacs.
org-clock-auto-clock-resolutionWhen to automatically resolve open clocks found in Org buffers.
org-clock-auto-clockout-timerTimer for auto clocking out when Emacs is idle.
org-clock-before-select-task-hookHook called in task selection just before prompting the user.
org-clock-cancel-hookHook run when canceling the current clock.
org-clock-clocked-in-displayWhen clocked in for a task, Org can display the current
org-clock-clocktable-default-propertiesDefault properties for new clocktables.
org-clock-clocktable-formatterFunction to turn clocking data into a table.
org-clock-clocktable-language-setupTerms used in clocktable, translated to different languages.
org-clock-continuouslyNon-nil means to start clocking from the last clock-out time, if any.
org-clock-current-taskTask currently clocked in.
org-clock-default-taskMarker pointing to the default task that should clock time.
org-clock-display-default-rangeDefault range when displaying clocks with ‘org-clock-display’.
org-clock-effortEffort estimate of the currently clocking task.
org-clock-file-time-cell-formatFormat string for the file time cells.
org-clock-file-total-minutesHolds the file total time in minutes, after a call to ‘org-clock-sum’.
org-clock-frame-title-formatThe value for ‘frame-title-format’ when clocking in.
org-clock-goto-before-contextNumber of lines of context to display before currently clocked-in entry.
org-clock-goto-hookHook run when selecting the currently clocked-in entry.
org-clock-goto-may-find-recent-taskNon-nil means ‘org-clock-goto’ can go to recent task if no active clock.
org-clock-has-been-usedHas the clock been used during the current Emacs session?
org-clock-heading-functionWhen non-nil, should be a function to create ‘org-clock-heading’.
org-clock-historyList of marker pointing to recent clocked tasks.
org-clock-history-lengthNumber of clock tasks to remember in history.
org-clock-idle-timeWhen non-nil, resolve open clocks if the user is idle more than X minutes.
org-clock-in-hookHook run when starting the clock.
org-clock-in-prepare-hookHook run when preparing the clock.
org-clock-in-resumeIf non-nil, resume clock when clocking into task with open clock.
org-clock-in-switch-to-stateSet task to a special todo state while clocking it.
org-clock-interrupted-taskMarker pointing to the task that has been interrupted by the current clock.
org-clock-into-drawerNon-nil when clocking info should be wrapped into a drawer.
org-clock-leftover-timeIf non-nil, user canceled a clock; this is when leftover time started.
org-clock-loadedWas the clock file loaded?
org-clock-mode-line-entryInformation for the mode line about the running clock.
org-clock-mode-line-totalDefault setting for the time included for the mode line clock.
org-clock-notification-was-shownShows if we have shown notification already.
org-clock-out-hookHook run when stopping the current clock.
org-clock-out-remove-zero-time-clocksNon-nil means remove the clock line when the resulting time is zero.
org-clock-out-switch-to-stateSet task to a special todo state after clocking out.
org-clock-out-when-doneWhen non-nil, clock will be stopped when the clocked entry is marked DONE.
org-clock-persistWhen non-nil, save the running clock when Emacs is closed.
org-clock-persist-fileFile to save clock data to.
org-clock-persist-query-resumeWhen non-nil, ask before resuming any stored clock during load.
org-clock-persist-query-saveWhen non-nil, ask before saving the current clock on exit.
org-clock-report-include-clocking-taskWhen non-nil, include the current clocking task time in clock reports.
org-clock-resolve-expertNon-nil means do not show the splash buffer with the clock resolver.
org-clock-rounding-minutesRounding minutes when clocking in or out.
org-clock-soundSound to use for notifications.
org-clock-stored-historyClock history, populated by ‘org-clock-load’.
org-clock-stored-resume-clockClock to resume, saved by ‘org-clock-load’.
org-clock-string-limitMaximum length of clock strings in the mode line. 0 means no limit.
org-clock-task-overrunInternal flag indicating if the clock has overrun the planned time.
org-clock-task-overrun-textExtra mode line text to indicate that the clock is overrun.
org-clock-total-timeHolds total time, spent previously on currently clocked item.
org-clock-total-time-cell-formatFormat string for the total time cells.
org-clock-update-periodNumber of seconds between mode line clock string updates.
org-clock-x11idle-program-nameName of the program which prints X11 idle time in milliseconds.
org-clocktable-defaultsDefault properties for clock tables.
org-show-notification-handlerFunction or program to send notification with.
org-show-notification-timeoutNumber of seconds to wait before closing Org notifications.
org-task-overrun-textExtra mode line text to indicate that the clock is overrun.

Defined functions (72)

org-clock--mode-line-heading()
org-clock--translate(S LANGUAGE)
org-clock-auto-clockout()
org-clock-cancel()
org-clock-clock-cancel(CLOCK)
org-clock-clock-in(CLOCK &optional RESUME START-TIME)
org-clock-clock-out(CLOCK &optional FAIL-QUIETLY AT-TIME)
org-clock-display(&optional ARG)
org-clock-drawer-name()
org-clock-find-position(FIND-UNCLOSED)
org-clock-get-clock-string()
org-clock-get-clocked-time()
org-clock-get-clocktable(&rest PROPS)
org-clock-get-last-clock-out-time()
org-clock-get-sum-start()
org-clock-get-table-data(FILE PARAMS)
org-clock-goto(&optional SELECT)
org-clock-history-push(&optional POS BUFFER)
org-clock-in(&optional SELECT START-TIME)
org-clock-in-last(&optional ARG)
org-clock-insert-selection-line(I MARKER)
org-clock-into-drawer()
org-clock-jump-to-current-clock(&optional EFFECTIVE-CLOCK)
org-clock-kill-emacs-query()
org-clock-load()
org-clock-mark-default-task()
org-clock-modify-effort-estimate(&optional VALUE)
org-clock-notify-once-if-expired()
org-clock-out(&optional SWITCH-TO-STATE FAIL-QUIETLY AT-TIME)
org-clock-out-if-current()
org-clock-play-sound(&optional CLOCK-SOUND)
org-clock-put-overlay(TIME)
org-clock-remove-empty-clock-drawer()
org-clock-remove-overlays(&optional BEG END NOREMOVE)
org-clock-report(&optional ARG)
org-clock-resolve(CLOCK &optional PROMPT-FN LAST-VALID FAIL-QUIETLY)
org-clock-resolve-clock(CLOCK RESOLVE-TO CLOCK-OUT-TIME CLOSE RESTART FAIL-QUIETLY)
org-clock-restore-frame-title-format()
org-clock-save()
org-clock-save-markers-for-cut-and-paste(BEG END)
org-clock-select-task(&optional PROMPT)
org-clock-special-range(KEY &optional TIME AS-STRINGS WSTART MSTART)
org-clock-sum(&optional TSTART TEND HEADLINE-FILTER PROPNAME)
org-clock-sum-current-item(&optional TSTART)
org-clock-sum-custom(&optional HEADLINE-FILTER RANGE PROPNAME)
org-clock-sum-today(&optional HEADLINE-FILTER)
org-clock-timestamps-change(UPDOWN &optional N)
org-clock-timestamps-down(&optional N)
org-clock-timestamps-up(&optional N)
org-clock-update-mode-line(&optional REFRESH)
org-clock-update-time-maybe()
org-clocking-p()
org-clocktable-indent-string(LEVEL)
org-clocktable-shift(DIR N)
org-clocktable-steps(PARAMS)
org-clocktable-write-default(IPOS TABLES PARAMS)
org-count-quarter(N)
org-day-of-week(DAY MONTH YEAR)
org-dblock-write:clocktable(PARAMS)
org-emacs-idle-seconds()
org-find-open-clocks(FILE)
org-is-active-clock(CLOCK)
org-mac-idle-seconds()
org-notify(NOTIFICATION &optional PLAY-SOUND)
org-quarter-to-date(QUARTER YEAR)
org-resolve-clocks(&optional ONLY-DANGLING-P PROMPT-FN LAST-VALID)
org-resolve-clocks-if-idle()
org-show-notification(NOTIFICATION)
org-user-idle-seconds()
org-with-clock(CLOCK &rest FORMS)
org-with-clock-position(CLOCK &rest FORMS)
org-x11-idle-seconds()

Defined faces (0)