ui/common/context.h

   1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   3  *
   4  * Copyright 2017 Olaf Wintermann. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  *   1. Redistributions of source code must retain the above copyright
  10  *      notice, this list of conditions and the following disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above copyright
  13  *      notice, this list of conditions and the following disclaimer in the
  14  *      documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef UIC_CONTEXT_H
  30 #define UIC_CONTEXT_H
  31
  32 #include "../ui/toolkit.h"
  33 #include <ucx/map.h>
  34 #include <ucx/mempool.h>
  35 #include <ucx/list.h>
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 typedef struct UiVar         UiVar;
  42 typedef struct UiListPtr     UiListPtr;
  43 typedef struct UiListVar     UiListVar;
  44 typedef struct UiGroupWidget UiGroupWidget;
  45
  46 typedef enum UiVarType UiVarType;
  47
  48 enum UiVarType {
  49     UI_VAR_SPECIAL = 0,
  50     UI_VAR_INTEGER,
  51     UI_VAR_DOUBLE,
  52     UI_VAR_STRING,
  53     UI_VAR_TEXT,
  54     UI_VAR_LIST,
  55     UI_VAR_RANGE
  56 };
  57
  58 struct UiContext {
  59     UiContext     *parent;
  60     UiObject      *obj;
  61     UcxMempool    *mempool;
  62
  63     void          *document;
  64     UcxList       *documents;
  65
  66     UcxMap        *vars; // manually created context vars
  67     UcxMap        *vars_unbound; // unbound vars created by widgets
  68
  69     UcxList       *groups; // int list
  70     UcxList       *group_widgets; // UiGroupWidget* list
  71
  72     void (*attach_document)(UiContext *ctx, void *document);
  73     void (*detach_document2)(UiContext *ctx, void *document);
  74
  75     char          *title;
  76
  77 #ifdef UI_GTK
  78     GtkAccelGroup *accel_group;
  79 #endif
  80
  81     ui_callback   close_callback;
  82     void          *close_data;
  83 };
  84
  85 // UiVar replacement, rename it to UiVar when finished
  86 struct UiVar {
  87     void      *value;
  88     UiVarType type;
  89     UiVar    *from;
  90     UiContext *from_ctx;
  91 };
  92
  93 struct UiGroupWidget {
  94     void          *widget;
  95     ui_enablefunc enable;
  96     int           *groups;
  97     int           numgroups;
  98 };
  99
 100
 101 void uic_init_global_context(void);
 102
 103 UiContext* uic_context(UiObject *toplevel, UcxMempool *mp);
 104 UiContext* uic_root_context(UiContext *ctx);
 105 void uic_context_set_document(UiContext *ctx, void *document); // deprecated
 106 void uic_context_detach_document(UiContext *ctx); // deprecated
 107
 108 void uic_context_attach_document(UiContext *ctx, void *document);
 109 void uic_context_detach_document2(UiContext *ctx, void *document);
 110 void uic_context_detach_all(UiContext *ctx);
 111
 112 UiVar* uic_get_var(UiContext *ctx, const char *name);
 113 UiVar* uic_create_var(UiContext *ctx, const char *name, UiVarType type);
 114 void* uic_create_value(UiContext *ctx, UiVarType type);
 115
 116 void uic_copy_binding(UiVar *from, UiVar *to, UiBool copytodoc);
 117 void uic_save_var2(UiVar *var);
 118 void uic_unbind_var(UiVar *var);
 119
 120 void uic_reg_var(UiContext *ctx, char *name, UiVarType type, void *value);
 121
 122 void uic_remove_bound_var(UiContext *ctx, UiVar *var);
 123
 124 void uic_check_group_widgets(UiContext *ctx);
 125 void uic_add_group_widget(UiContext *ctx, void *widget, ui_enablefunc enable, UcxList *groups);
 126
 127
 128 #ifdef  __cplusplus
 129 }
 130 #endif
 131
 132 #endif  /* UIC_CONTEXT_H */
 133