xwidget.h

Go to the documentation of this file.

/*
 *                           0BSD 
 * 
 *                    BSD Zero Clause License
 * 
 *  Copyright (c) 2019 Hermann Meyer
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted.
 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 *
 */
 
#pragma once
 
#ifndef XWIDGET_H
#define XWIDGET_H
 
#include "xputty.h"
#include "xwidget-platform.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*---------------------------------------------------------------------
----------------------------------------------------------------------- 
                    basic X11 widgets
-----------------------------------------------------------------------
----------------------------------------------------------------------*/
 
#define SYSTEM_TRAY_REQUEST_DOCK   0
#define SYSTEM_TRAY_BEGIN_MESSAGE   1
#define SYSTEM_TRAY_CANCEL_MESSAGE  2
 
typedef void (*vfunc)(void * widget, void * event, Xputty *main, void* user_data);
 
typedef void (*evfunc)(void * widget, void * event, void* user_data);
 
 
typedef void (*xevfunc)(void * widget, void* user_data);
 
typedef struct {
    xevfunc expose_callback;
    xevfunc configure_callback;
    xevfunc enter_callback;
    xevfunc leave_callback;
    xevfunc adj_callback;
    xevfunc value_changed_callback;
    xevfunc user_callback;
    xevfunc mem_free_callback;
    xevfunc configure_notify_callback;
    xevfunc map_notify_callback;
    xevfunc unmap_notify_callback;
    xevfunc dialog_callback;
    xevfunc dnd_notify_callback;
    xevfunc visibiliy_change_callback;
 
    evfunc button_press_callback;
    evfunc button_release_callback;
    evfunc double_click_callback;
    evfunc motion_callback;
    evfunc key_press_callback;
    evfunc key_release_callback;
} Func_t;
 
typedef enum {
    EXPOSE = 1,
    CONFIGURE,
    ENTER,
    LEAVE,
    ADJ_INTERN,
    VALUE_CHANGED,
    USER,
    MEM_FREE_CB,
    CONFIGURE_NOTIFY,
    MAP_NOTIFY,
    UNMAP_NOTIFY,
    DIALOG_RESPONSE,
    BUTTON_PRESS,
    BUTTON_RELEASE,
    POINTER_MOTION,
    KEY_PRESS,
    KEY_RELEASE,
} EventType;
 
typedef enum {
    WT_NONE,
    WT_WINDOW,
    WT_WIDGET,
    WT_BUTTON,
    WT_ON_OFF_BUTTON,
    WT_TOGGLE_BUTTON,
    WT_IMAGE_TOGGLE_BUTTON,
    WT_SWITCH_IMAGE_TOGGLE_BUTTON,
    WT_CHECK_BUTTON,
    WT_CHECK_BOX,
    WT_COMBOBOX,
    WT_FILE_DIALOG,
    WT_KNOB,
    WT_IMAGE_KNOB,
    WT_LABEL,
    WT_LISTBOX_VIEWPORT,
    WT_LISTBOX,
    WT_LISTBOX_ENTRY,
    WT_LISTVIEW_VIEWPORT,
    WT_LISTVIEW,
    WT_MENU,
    WT_MENU_VIEWPORT,
    WT_MENU_ITEM,
    WT_MENU_CHECK_ITEM,
    WT_MENU_RADIO_ITEM,
    WT_MESSAGE_DIALOG,
    WT_VMETER,
    WT_VMETER_SCALE,
    WT_HMETER,
    WT_HMETER_SCALE,
    WT_MIDI_KEYBOARD,
    WT_PLAYHEAD,
    WT_VSLIDER,
    WT_HSLIDER,
    WT_TOOLTIP,
    WT_TUNER,
    WT_VALUEDISPLAY,
    WT_TEXT_ENTRY,
} WidgetType;
 
#define XPUTTY_WIDGET_NAME_COUNT 38
#define XPUTTY_WIDGET_NAME_MAXLEN 256
static const char widget_type_names[XPUTTY_WIDGET_NAME_COUNT + 1][XPUTTY_WIDGET_NAME_MAXLEN] = {
    "WT_NONE",
    "WT_WINDOW",
    "WT_WIDGET",
    "WT_BUTTON",
    "WT_ON_OFF_BUTTON",
    "WT_TOGGLE_BUTTON",
    "WT_IMAGE_TOGGLE_BUTTON",
    "WT_SWITCH_IMAGE_TOGGLE_BUTTON",
    "WT_CHECK_BUTTON",
    "WT_CHECK_BOX",
    "WT_COMBOBOX",
    "WT_FILE_DIALOG",
    "WT_KNOB",
    "WT_IMAGE_KNOB",
    "WT_LABEL",
    "WT_LISTBOX_VIEWPORT",
    "WT_LISTBOX",
    "WT_LISTBOX_ENTRY",
    "WT_LISTVIEW_VIEWPORT",
    "WT_LISTVIEW",
    "WT_MENU",
    "WT_MENU_VIEWPORT",
    "WT_MENU_ITEM",
    "WT_MENU_CHECK_ITEM",
    "WT_MENU_RADIO_ITEM",
    "WT_MESSAGE_DIALOG",
    "WT_VMETER",
    "WT_VMETER_SCALE",
    "WT_HMETER",
    "WT_HMETER_SCALE",
    "WT_MIDI_KEYBOARD",
    "WT_PLAYHEAD",
    "WT_VSLIDER",
    "WT_HSLIDER",
    "WT_TOOLTIP",
    "WT_TUNER",
    "WT_VALUEDISPLAY",
    "WT_TEXT_ENTRY",
    "UNKNOWN"
};
 
typedef enum {
    NORTHWEST    ,
    NORTHEAST    ,
    SOUTHWEST     ,
    SOUTHEAST     ,
    SOUTHCENTER     ,
    EASTWEST     ,
    EASTNORTH     ,
    EASTSOUTH     ,
    WESTNORTH     ,
    WESTSOUTH     ,
    CENTER        ,
    ASPECT        ,
    FIXEDSIZE        ,
    MENUITEM      ,
    NONE          ,   
}Gravity;
 
typedef struct {
    Gravity gravity;
    int init_x;
    int init_y;
    int init_width;
    int init_height;
    float scale_x;
    float scale_y;
    float cscale_x;
    float cscale_y;
    float rcscale_x;
    float rcscale_y;
    float ascale;
} Resize_t;
 
enum {
    IS_WIDGET         = 1<<0,
    IS_WINDOW         = 1<<1,
    IS_POPUP          = 1<<2,
    IS_RADIO          = 1<<3,
    IS_TOOLTIP        = 1<<4,
    USE_TRANSPARENCY  = 1<<5,
    HAS_FOCUS         = 1<<6,
    HAS_POINTER       = 1<<7,
    HAS_TOOLTIP       = 1<<8,
    HAS_MEM           = 1<<9,
    NO_AUTOREPEAT     = 1<<10,
    FAST_REDRAW       = 1<<11,
    HIDE_ON_DELETE    = 1<<12,
    REUSE_IMAGE       = 1<<13,
    NO_PROPAGATE      = 1<<14,
    IS_SUBMENU        = 1<<15,
    DONT_PROPAGATE    = 1<<16,
 
};
 
struct Widget_t {
    char input_label[32];
    long long flags;
    const char* label;
    Xputty *app;
    XColor_t *color_scheme;
    Window widget;
    void *parent;
    void *parent_struct;
    void *private_struct;
    WidgetType widget_type;
    vfunc event_callback;
    Func_t func;
    cairo_surface_t *surface;
    cairo_t *cr;
    cairo_surface_t *buffer;
    cairo_t *crb;
    cairo_surface_t *image;
    Adjustment_t *adj_x;
    Adjustment_t *adj_y;
    Adjustment_t *adj;
    Childlist_t *childlist;
    XIC xic;
    XIM xim;
#ifdef __linux__
    Time double_click;
#endif
    int data;
    int state;
    int pos_x;
    int pos_y;
    int x;
    int y;
    int width;
    int height;
    Resize_t scale;
#ifdef _WIN32 //Widget_t extensions
    bool mouse_inside;
    Metrics_t metrics_min;
#endif //_WIN32 //Widget_t extensions
    xevfunc xpaste_callback;
};
 
 
Widget_t *create_window(Xputty *app, Window win,
                          int x, int y, int width, int height);
 
Widget_t *create_widget(Xputty *app, Widget_t *win,
                          int x, int y, int width, int height);
 
void connect_func(void (**event)(), void (*handler)());
 
void widget_set_title(Widget_t *w, const char *title);
 
void widget_show(Widget_t *w);
 
void pop_widget_show_all(Widget_t *w);
 
void submenu_widget_show_all(Widget_t *w);
 
void widget_hide(Widget_t *w);
 
void widget_hide_all(Widget_t *w);
 
void widget_show_all(Widget_t *w);
 
void show_tooltip(Widget_t *wid);
 
void hide_tooltip(Widget_t *wid);
 
Widget_t *get_toplevel_widget(Xputty *main);
 
void quit(Widget_t *w);
 
void quit_widget(Widget_t *w);
 
void transparent_draw(void * wid, void* user_data);
 
void widget_draw(void * w_, void* user_data);
 
void resize_childs(Widget_t *wid);
 
void widget_reset_scale(Widget_t *w);
 
void widget_set_scale(Widget_t *w);
 
void destroy_widget(Widget_t *w, Xputty *main);
 
void widget_event_loop(void *w_, void* event, Xputty *main, void* user_data);
 
void send_configure_event(Widget_t *w,int x, int y, int width, int height);
 
void send_button_press_event(Widget_t *w);
 
void send_button_release_event(Widget_t *w);
 
void send_systray_message(Widget_t *w);
 
void expose_widget(Widget_t *w);
 
int key_mapping(Display *dpy, XKeyEvent *xkey);
 
const char *widget_type_name(Widget_t *w);
 
void strdecode(char *target, const char *needle, const char *replacement);
 
void widget_set_dnd_aware(Widget_t *w);
 
void widget_set_dnd_unaware(Widget_t *w);
 
void handle_drag_data(Widget_t *w, XEvent* event);
 
void handle_dnd_enter(Xputty *main, XEvent* event);
 
void send_dnd_finished_event(Widget_t *w, XEvent* event);
 
void send_dnd_status_event(Widget_t *w, XEvent* event);
 
void copy_to_clipboard(Widget_t *w, char* text, int size);
 
void send_to_clipboard(Widget_t *w, XEvent* event);
 
 
int have_paste(Widget_t *w);
 
void request_paste_from_clipboard(Widget_t *w);
 
void receive_paste_from_clipboard(Widget_t *w, XEvent* event);
 
#ifdef __cplusplus
}
#endif
 
#endif //XWIDGET_H