widget.h

Go to the documentation of this file.

/*
 * rofi
 *
 * MIT/X11 License
 * Copyright © 2013-2017 Qball Cow <qball@gmpclient.org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#ifndef ROFI_WIDGET_H
#define ROFI_WIDGET_H
#include "keyb.h"
#include <cairo.h>
#include <glib.h>

typedef struct _widget widget;

typedef enum {
  WIDGET_TYPE_UNKNOWN,
  WIDGET_TYPE_LISTVIEW = SCOPE_MOUSE_LISTVIEW,
  WIDGET_TYPE_LISTVIEW_ELEMENT = SCOPE_MOUSE_LISTVIEW_ELEMENT,
  WIDGET_TYPE_EDITBOX = SCOPE_MOUSE_EDITBOX,
  WIDGET_TYPE_SCROLLBAR = SCOPE_MOUSE_SCROLLBAR,
  WIDGET_TYPE_MODE_SWITCHER = SCOPE_MOUSE_MODE_SWITCHER,
  WIDGET_TYPE_TEXTBOX_TEXT,
} WidgetType;

typedef enum {
  WIDGET_TRIGGER_ACTION_RESULT_IGNORED,
  WIDGET_TRIGGER_ACTION_RESULT_HANDLED,
  WIDGET_TRIGGER_ACTION_RESULT_GRAB_MOTION_BEGIN,
  WIDGET_TRIGGER_ACTION_RESULT_GRAB_MOTION_END,
} WidgetTriggerActionResult;

typedef widget *(*widget_find_mouse_target_cb)(widget *wid, WidgetType type,
                                               gint x, gint y);

typedef WidgetTriggerActionResult (*widget_trigger_action_cb)(widget *wid,
                                                              guint action,
                                                              gint x, gint y,
                                                              void *user_data);

#define WIDGET(a) ((widget *)(a))

int widget_intersect(const widget *wid, int x, int y);

void widget_move(widget *wid, short x, short y);

void widget_set_type(widget *wid, WidgetType type);

gboolean widget_enabled(widget *wid);

void widget_set_enabled(widget *wid, gboolean enabled);

static inline void widget_disable(widget *wid) {
  widget_set_enabled(wid, FALSE);
}

static inline void widget_enable(widget *wid) { widget_set_enabled(wid, TRUE); }

void widget_draw(widget *wid, cairo_t *d);

void widget_free(widget *wid);

void widget_resize(widget *wid, short w, short h);

int widget_get_height(widget *wid);

int widget_get_width(widget *wid);

int widget_get_y_pos(widget *wid);

int widget_get_x_pos(widget *wid);

void widget_xy_to_relative(widget *wid, gint *x, gint *y);

void widget_update(widget *wid);
void widget_queue_redraw(widget *wid);
gboolean widget_need_redraw(widget *wid);

widget *widget_find_mouse_target(widget *wid, WidgetType type, gint x, gint y);

WidgetTriggerActionResult widget_check_action(widget *wid,
                                              G_GNUC_UNUSED guint action,
                                              G_GNUC_UNUSED gint x,
                                              G_GNUC_UNUSED gint y);

WidgetTriggerActionResult widget_trigger_action(widget *wid, guint action,
                                                gint x, gint y);

void widget_set_trigger_action_handler(widget *wid, widget_trigger_action_cb cb,
                                       void *cb_data);

gboolean widget_motion_notify(widget *wid, gint x, gint y);

int widget_get_desired_height(widget *wid, const int width);

int widget_get_desired_width(widget *wid, const int height);
int widget_get_absolute_xpos(widget *wid);
int widget_get_absolute_ypos(widget *wid);
#endif // ROFI_WIDGET_H