e-util/e-util-enums.h

   1 /*
   2  * e-util-enums.h
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  10  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  15  *
  16  */
  17
  18 #if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
  19 #error "Only <e-util/e-util.h> should be included directly."
  20 #endif
  21
  22 #ifndef E_UTIL_ENUMS_H
  23 #define E_UTIL_ENUMS_H
  24
  25 #include <glib.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /**
  30  * EActivityState:
  31  * @E_ACTIVITY_RUNNING:
  32  *   The #EActivity is running.
  33  * @E_ACTIVITY_WAITING:
  34  *   The #EActivity is waiting to be run.
  35  * @E_ACTIVITY_CANCELLED:
  36  *   The #EActivity has been cancelled.
  37  * @E_ACTIVITY_COMPLETED:
  38  *   The #EActivity has completed.
  39  *
  40  * Various states of an #EActivity.
  41  **/
  42 typedef enum {
  43         E_ACTIVITY_RUNNING,
  44         E_ACTIVITY_WAITING,
  45         E_ACTIVITY_CANCELLED,
  46         E_ACTIVITY_COMPLETED
  47 } EActivityState;
  48
  49 /**
  50  * EAutomaticActionPolicy:
  51  * @E_AUTOMATIC_ACTION_POLICY_ASK:
  52  *   Ask the user whether to perform the action.
  53  * @E_AUTOMATIC_ACTION_POLICY_ALWAYS:
  54  *   Perform the action without interrupting the user.
  55  * @E_AUTOMATIC_ACTION_POLICY_NEVER:
  56  *   Do not perform the action and do not interrupt the user.
  57  *
  58  * Used for automatable actions based on the user's preference.  The user
  59  * is initially asked whether to perform the action automatically, and is
  60  * given either-or choices like "Yes, Always" or "No, Never".  The user's
  61  * response is then remembered for future sessions.
  62  **/
  63 typedef enum {
  64         E_AUTOMATIC_ACTION_POLICY_ASK,
  65         E_AUTOMATIC_ACTION_POLICY_ALWAYS,
  66         E_AUTOMATIC_ACTION_POLICY_NEVER
  67 } EAutomaticActionPolicy;
  68
  69 /**
  70  * EDateWeekday:
  71  * @E_DATE_BAD_WEEKDAY:
  72  *   Invalid value
  73  * @E_DATE_MONDAY:
  74  *   Monday
  75  * @E_DATE_TUESDAY:
  76  *   Tuesday
  77  * @E_DATE_WEDNESDAY:
  78  *   Wednesday
  79  * @E_DATE_THURSDAY:
  80  *   Thursday
  81  * @E_DATE_FRIDAY:
  82  *   Friday
  83  * @E_DATE_SATURDAY:
  84  *   Saturday
  85  * @E_DATE_SUNDAY:
  86  *   Sunday
  87  *
  88  * Enumeration representing a day of the week; @E_DATE_MONDAY,
  89  * @E_DATE_TUESDAY, etc.  @G_DATE_BAD_WEEKDAY is an invalid weekday.
  90  *
  91  * This enum type is intentionally compatible with #GDateWeekday.
  92  * It exists only because GLib does not provide a #GEnumClass for
  93  * #GDateWeekday.  If that ever changes, this enum can go away.
  94  **/
  95 /* XXX Be pedantic with the value assignments to ensure compatibility. */
  96 typedef enum {
  97         E_DATE_BAD_WEEKDAY = G_DATE_BAD_WEEKDAY,
  98         E_DATE_MONDAY = G_DATE_MONDAY,
  99         E_DATE_TUESDAY = G_DATE_TUESDAY,
 100         E_DATE_WEDNESDAY = G_DATE_WEDNESDAY,
 101         E_DATE_THURSDAY = G_DATE_THURSDAY,
 102         E_DATE_FRIDAY = G_DATE_FRIDAY,
 103         E_DATE_SATURDAY = G_DATE_SATURDAY,
 104         E_DATE_SUNDAY = G_DATE_SUNDAY
 105 } EDateWeekday;
 106
 107 /**
 108  * EDurationType:
 109  * @E_DURATION_MINUTES:
 110  *   Duration value is in minutes.
 111  * @E_DURATION_HOURS:
 112  *   Duration value is in hours.
 113  * @E_DURATION_DAYS:
 114  *   Duration value is in days.
 115  *
 116  * Possible units for a duration or interval value.
 117  *
 118  * This enumeration is typically used where the numeric value and the
 119  * units of the value are shown or recorded separately.
 120  **/
 121 typedef enum {
 122         E_DURATION_MINUTES,
 123         E_DURATION_HOURS,
 124         E_DURATION_DAYS
 125 } EDurationType;
 126
 127 typedef enum {
 128         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_NONE = 0,
 129         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_PARAGRAPH,
 130         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_PRE,
 131         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_ADDRESS,
 132         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_BLOCKQUOTE,
 133         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_H1,
 134         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_H2,
 135         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_H3,
 136         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_H4,
 137         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_H5,
 138         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_H6,
 139         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_UNORDERED_LIST,
 140         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_ORDERED_LIST,
 141         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_ORDERED_LIST_ROMAN,
 142         E_HTML_EDITOR_SELECTION_BLOCK_FORMAT_ORDERED_LIST_ALPHA
 143 } EHTMLEditorSelectionBlockFormat;
 144
 145 /* The values match the actual size in <font size="n"> */
 146 typedef enum {
 147         E_HTML_EDITOR_SELECTION_FONT_SIZE_TINY          = 1,
 148         E_HTML_EDITOR_SELECTION_FONT_SIZE_SMALL         = 2,
 149         E_HTML_EDITOR_SELECTION_FONT_SIZE_NORMAL        = 3,
 150         E_HTML_EDITOR_SELECTION_FONT_SIZE_BIG           = 4,
 151         E_HTML_EDITOR_SELECTION_FONT_SIZE_BIGGER        = 5,
 152         E_HTML_EDITOR_SELECTION_FONT_SIZE_LARGE         = 6,
 153         E_HTML_EDITOR_SELECTION_FONT_SIZE_VERY_LARGE    = 7
 154 } EHTMLEditorSelectionFontSize;
 155
 156 typedef enum {
 157         E_HTML_EDITOR_SELECTION_ALIGNMENT_LEFT,
 158         E_HTML_EDITOR_SELECTION_ALIGNMENT_CENTER,
 159         E_HTML_EDITOR_SELECTION_ALIGNMENT_RIGHT
 160 } EHTMLEditorSelectionAlignment;
 161
 162 typedef enum {
 163         E_HTML_EDITOR_SELECTION_GRANULARITY_CHARACTER,
 164         E_HTML_EDITOR_SELECTION_GRANULARITY_WORD
 165 } EHTMLEditorSelectionGranularity;
 166
 167 /**
 168  * EHTMLEditorViewCommand:
 169  * @E_HTML_EDITOR_VIEW_COMMAND_BACKGROUND_COLOR:
 170  *   Sets background color to given value.
 171  * @E_HTML_EDITOR_VIEW_COMMAND_BOLD:
 172  *   Toggles bold formatting of current selection.
 173  * @E_HTML_EDITOR_VIEW_COMMAND_COPY:
 174  *   Copies current selection to clipboard.
 175  * @E_HTML_EDITOR_VIEW_COMMAND_CREATE_LINK:
 176  *   Converts current selection to a link that points to URL in value
 177  * @E_HTML_EDITOR_VIEW_COMMAND_CUT:
 178  *   Cuts current selection to clipboard.
 179  * @E_HTML_EDITOR_VIEW_COMMAND_DEFAULT_PARAGRAPH_SEPARATOR:
 180  *   (XXX Explain me!)
 181  * @E_HTML_EDITOR_VIEW_COMMAND_DELETE:
 182  *   Deletes current selection.
 183  * @E_HTML_EDITOR_VIEW_COMMAND_FIND_STRING:
 184  *   Highlights given string.
 185  * @E_HTML_EDITOR_VIEW_COMMAND_FONT_NAME:
 186  *   Sets font name to given value.
 187  * @E_HTML_EDITOR_VIEW_COMMAND_FONT_SIZE:
 188  *   Sets font point size to given value (no units, just number)
 189  * @E_HTML_EDITOR_VIEW_COMMAND_FONT_SIZE_DELTA:
 190  *   Changes font size by given delta value (no units, just number)
 191  * @E_HTML_EDITOR_VIEW_COMMAND_FORE_COLOR:
 192  *   Sets font color to given value
 193  * @E_HTML_EDITOR_VIEW_COMMAND_FORMAT_BLOCK:
 194  *   Sets block type of current paragraph to given format. Allowed formats
 195  *   are "BLOCKQUOTE", "H1", "H2", "H3", "H4", "H5", "H6", "P", "PRE" and
 196  *   "ADDRESS".
 197  * @E_HTML_EDITOR_VIEW_COMMAND_FORWARD_DELETE:
 198  *   (XXX Explain me!)
 199  * @E_HTML_EDITOR_VIEW_COMMAND_HILITE_COLOR:
 200  *   Sets color in which results of "FindString" command should be
 201  *   highlighted to given value.
 202  * @E_HTML_EDITOR_VIEW_COMMAND_INDENT:
 203  *   Indents current paragraph by one level.
 204  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_HTML:
 205  *   Inserts give HTML code into document.
 206  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_HORIZONTAL_RULE:
 207  *   Inserts a horizontal rule (&lt;HR&gt;) on current line.
 208  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_IMAGE:
 209  *   Inserts an image with given source file.
 210  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_LINE_BREAK:
 211  *   Breaks line at current cursor position.
 212  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_NEW_LINE_IN_QUOTED_CONTENT:
 213  *   Breaks citation at current cursor position.
 214  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_ORDERED_LIST:
 215  *   Creates an ordered list environment at current cursor position.
 216  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_PARAGRAPH:
 217  *   Inserts a new paragraph at current cursor position.
 218  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_TEXT:
 219  *   Inserts given text at current cursor position.
 220  * @E_HTML_EDITOR_VIEW_COMMAND_INSERT_UNORDERED_LIST:
 221  *   Creates an undordered list environment at current cursor position.
 222  * @E_HTML_EDITOR_VIEW_COMMAND_ITALIC:
 223  *   Toggles italic formatting of current selection.
 224  * @E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_CENTER:
 225  *   Aligns current paragraph to center.
 226  * @E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_FULL:
 227  *   Justifies current paragraph to block.
 228  * @E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_NONE:
 229  *   Removes any justification or alignment of current paragraph.
 230  * @E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_RIGHT:
 231  *   Aligns current paragraph to right.
 232  * @E_HTML_EDITOR_VIEW_COMMAND_OUTDENT:
 233  *   Outdents current paragraph by one level.
 234  * @E_HTML_EDITOR_VIEW_COMMAND_PASTE:
 235  *   Pastes clipboard content at current cursor position.
 236  * @E_HTML_EDITOR_VIEW_COMMAND_PASTE_AND_MATCH_STYLE:
 237  *   Pastes clipboard content and matches its style to style at current
 238  *   cursor position.
 239  * @E_HTML_EDITOR_VIEW_COMMAND_PASTE_AS_PLAIN_TEXT:
 240  *   Pastes clipboard content at current cursor position removing any HTML
 241  *   formatting.
 242  * @E_HTML_EDITOR_VIEW_COMMAND_PRINT:
 243  *   Print current document.
 244  * @E_HTML_EDITOR_VIEW_COMMAND_REDO:
 245  *   Redoes last action.
 246  * @E_HTML_EDITOR_VIEW_COMMAND_REMOVE_FORMAT:
 247  *   Removes any formatting of current selection.
 248  * @E_HTML_EDITOR_VIEW_COMMAND_SELECT_ALL:
 249  *   Extends selects to the entire document.
 250  * @E_HTML_EDITOR_VIEW_COMMAND_STRIKETHROUGH:
 251  *   Toggles strikethrough formatting.
 252  * @E_HTML_EDITOR_VIEW_COMMAND_STYLE_WITH_CSS:
 253  *   Toggles whether style should be defined in CSS "style" attribute of
 254  *   elements or whether to use deprecated &lt;FONT&gt; tags. Depends on
 255  *   whether given value is "true" or "false".
 256  * @E_HTML_EDITOR_VIEW_COMMAND_SUBSCRIPT:
 257  *   Toggles subscript of current selection.
 258  * @E_HTML_EDITOR_VIEW_COMMAND_SUPERSCRIPT:
 259  *   Toggles superscript of current selection.
 260  * @E_HTML_EDITOR_VIEW_COMMAND_TRANSPOSE:
 261  *   (XXX Explain me!)
 262  * @E_HTML_EDITOR_VIEW_COMMAND_UNDERLINE:
 263  *   Toggles underline formatting of current selection.
 264  * @E_HTML_EDITOR_VIEW_COMMAND_UNDO:
 265  *   Undoes last action.
 266  * @E_HTML_EDITOR_VIEW_COMMAND_UNLINK:
 267  *   Removes active links (&lt;A&gt;) from current selection (if there's any).
 268  * @E_HTML_EDITOR_VIEW_COMMAND_UNSELECT:
 269  *   Cancels current selection.
 270  * @E_HTML_EDITOR_VIEW_COMMAND_USE_CSS:
 271  *   Whether to allow use of CSS or not depending on whether given value is
 272  *   "true" or "false".
 273  *
 274  * Specifies the DOM command to execute in e_editor_widget_exec_command().
 275  * Some commands require value to be passed in, which is always stated in the
 276  * documentation.
 277  */
 278 typedef enum {
 279         E_HTML_EDITOR_VIEW_COMMAND_BACKGROUND_COLOR,
 280         E_HTML_EDITOR_VIEW_COMMAND_BOLD,
 281         E_HTML_EDITOR_VIEW_COMMAND_COPY,
 282         E_HTML_EDITOR_VIEW_COMMAND_CREATE_LINK,
 283         E_HTML_EDITOR_VIEW_COMMAND_CUT,
 284         E_HTML_EDITOR_VIEW_COMMAND_DEFAULT_PARAGRAPH_SEPARATOR,
 285         E_HTML_EDITOR_VIEW_COMMAND_DELETE,
 286         E_HTML_EDITOR_VIEW_COMMAND_FIND_STRING,
 287         E_HTML_EDITOR_VIEW_COMMAND_FONT_NAME,
 288         E_HTML_EDITOR_VIEW_COMMAND_FONT_SIZE,
 289         E_HTML_EDITOR_VIEW_COMMAND_FONT_SIZE_DELTA,
 290         E_HTML_EDITOR_VIEW_COMMAND_FORE_COLOR,
 291         E_HTML_EDITOR_VIEW_COMMAND_FORMAT_BLOCK,
 292         E_HTML_EDITOR_VIEW_COMMAND_FORWARD_DELETE,
 293         E_HTML_EDITOR_VIEW_COMMAND_HILITE_COLOR,
 294         E_HTML_EDITOR_VIEW_COMMAND_INDENT,
 295         E_HTML_EDITOR_VIEW_COMMAND_INSERT_HTML,
 296         E_HTML_EDITOR_VIEW_COMMAND_INSERT_HORIZONTAL_RULE,
 297         E_HTML_EDITOR_VIEW_COMMAND_INSERT_IMAGE,
 298         E_HTML_EDITOR_VIEW_COMMAND_INSERT_LINE_BREAK,
 299         E_HTML_EDITOR_VIEW_COMMAND_INSERT_NEW_LINE_IN_QUOTED_CONTENT,
 300         E_HTML_EDITOR_VIEW_COMMAND_INSERT_ORDERED_LIST,
 301         E_HTML_EDITOR_VIEW_COMMAND_INSERT_PARAGRAPH,
 302         E_HTML_EDITOR_VIEW_COMMAND_INSERT_TEXT,
 303         E_HTML_EDITOR_VIEW_COMMAND_INSERT_UNORDERED_LIST,
 304         E_HTML_EDITOR_VIEW_COMMAND_ITALIC,
 305         E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_CENTER,
 306         E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_FULL,
 307         E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_LEFT,
 308         E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_NONE,
 309         E_HTML_EDITOR_VIEW_COMMAND_JUSTIFY_RIGHT,
 310         E_HTML_EDITOR_VIEW_COMMAND_OUTDENT,
 311         E_HTML_EDITOR_VIEW_COMMAND_PASTE,
 312         E_HTML_EDITOR_VIEW_COMMAND_PASTE_AND_MATCH_STYLE,
 313         E_HTML_EDITOR_VIEW_COMMAND_PASTE_AS_PLAIN_TEXT,
 314         E_HTML_EDITOR_VIEW_COMMAND_PRINT,
 315         E_HTML_EDITOR_VIEW_COMMAND_REDO,
 316         E_HTML_EDITOR_VIEW_COMMAND_REMOVE_FORMAT,
 317         E_HTML_EDITOR_VIEW_COMMAND_SELECT_ALL,
 318         E_HTML_EDITOR_VIEW_COMMAND_STRIKETHROUGH,
 319         E_HTML_EDITOR_VIEW_COMMAND_STYLE_WITH_CSS,
 320         E_HTML_EDITOR_VIEW_COMMAND_SUBSCRIPT,
 321         E_HTML_EDITOR_VIEW_COMMAND_SUPERSCRIPT,
 322         E_HTML_EDITOR_VIEW_COMMAND_TRANSPOSE,
 323         E_HTML_EDITOR_VIEW_COMMAND_UNDERLINE,
 324         E_HTML_EDITOR_VIEW_COMMAND_UNDO,
 325         E_HTML_EDITOR_VIEW_COMMAND_UNLINK,
 326         E_HTML_EDITOR_VIEW_COMMAND_UNSELECT,
 327         E_HTML_EDITOR_VIEW_COMMAND_USE_CSS
 328 } EHTMLEditorViewCommand;
 329
 330 /**
 331  * EImageLoadingPolicy:
 332  * @E_IMAGE_LOADING_POLICY_NEVER:
 333  *   Never load images from a remote server.
 334  * @E_IMAGE_LOADING_POLICY_SOMETIMES:
 335  *   Only load images from a remote server if the sender is a known contact.
 336  * @E_IMAGE_LOADING_POLICY_ALWAYS:
 337  *   Always load images from a remote server.
 338  *
 339  * Policy for loading remote image URLs in email.  Allowing images to be
 340  * loaded from a remote server may have privacy implications.
 341  **/
 342 typedef enum {
 343         E_IMAGE_LOADING_POLICY_NEVER,
 344         E_IMAGE_LOADING_POLICY_SOMETIMES,
 345         E_IMAGE_LOADING_POLICY_ALWAYS
 346 } EImageLoadingPolicy;
 347
 348 G_END_DECLS
 349
 350 #endif /* E_UTIL_ENUMS_H */