gwymoduleenums

gwymoduleenums —

Synopsis




enum        GwyFileOperation;
enum        GwyToolSwitchEvent;
enum        GwyRunType;

Description

Details

enum GwyFileOperation

typedef enum {
    GWY_FILE_NONE   = 0,
    GWY_FILE_LOAD   = 1 << 0,
    GWY_FILE_SAVE   = 1 << 1,
    GWY_FILE_DETECT = 1 << 2,
    GWY_FILE_MASK   = 0x07
} GwyFileOperation;

File type function file operations (capabilities).

GWY_FILE_NONE None.
GWY_FILE_LOAD Posibility to load files of this type.
GWY_FILE_SAVE Posibility to save files of this type.
GWY_FILE_DETECT Posibility to detect files are of this file type,
GWY_FILE_MASK The mask for all the flags.

enum GwyToolSwitchEvent

typedef enum {
    GWY_TOOL_SWITCH_WINDOW = 1,
    GWY_TOOL_SWITCH_TOOL
} GwyToolSwitchEvent;

Tool switch events.

GWY_TOOL_SWITCH_WINDOW The tool should be set for the data window because the user switched windows.
GWY_TOOL_SWITCH_TOOL The tool should be set for the data window because the user switched tools.

enum GwyRunType

typedef enum {
    GWY_RUN_NONE           = 0,
    GWY_RUN_WITH_DEFAULTS  = 1 << 0,
    GWY_RUN_NONINTERACTIVE = 1 << 1,
    GWY_RUN_MODAL          = 1 << 2,
    GWY_RUN_INTERACTIVE    = 1 << 3,
    GWY_RUN_MASK           = 0x0f
} GwyRunType;

Data processing function run-modes.

GWY_RUN_NONE None.
GWY_RUN_WITH_DEFAULTS The function is run non-interactively, and it should use default parameter values.
GWY_RUN_NONINTERACTIVE The function is run non-interactively, and it should use parameter values stored in the container to reproduce previous runs.
GWY_RUN_MODAL The function presents a [presumably simple] modal GUI to the user, it returns after finishing all operations.
GWY_RUN_INTERACTIVE The function presents a non-modal GUI to the user, it returns while after setting up the GUI, not after finishing its work.
GWY_RUN_MASK The mask for all the run modes.