view.h

Go to the documentation of this file.

/*
 * rofi
 *
 * MIT/X11 License
 * Copyright © 2013-2023 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_VIEW_H
#define ROFI_VIEW_H
 
#include "mode.h"
#include "widgets/textbox.h"
#include "widgets/widget.h"
#include <pango/pango.h>
#ifdef ENABLE_XCB
#include <xcb/xcb.h>
#else
#include "xcb-dummy.h"
#endif

typedef struct RofiViewState RofiViewState;
typedef enum {
  MENU_NORMAL = 0,
  MENU_PASSWORD = 1,
  MENU_NORMAL_WINDOW = 2,
  MENU_ERROR_DIALOG = 4,
  MENU_TRANSIENT_WINDOW = 8,
} MenuFlags;

RofiViewState *rofi_view_create(Mode *sw, const char *input,
                                MenuFlags menu_flags,
                                void (*finalize)(RofiViewState *));

void rofi_view_finalize(RofiViewState *state);

MenuReturn rofi_view_get_return_value(const RofiViewState *state);
unsigned int rofi_view_get_next_position(const RofiViewState *state);
void rofi_view_handle_text(RofiViewState *state, const char *text);
void rofi_view_handle_mouse_motion(RofiViewState *state, gint x, gint y,
                                   gboolean find_mouse_target);
void rofi_view_maybe_update(RofiViewState *state);
void rofi_view_temp_configure_notify(RofiViewState *state,
                                     xcb_configure_notify_event_t *xce);
void rofi_view_temp_click_to_exit(RofiViewState *state, xcb_window_t target);
void rofi_view_frame_callback(void);
unsigned int rofi_view_get_completed(const RofiViewState *state);
const char *rofi_view_get_user_input(const RofiViewState *state);

void rofi_view_set_selected_line(RofiViewState *state,
                                 unsigned int selected_line);

unsigned int rofi_view_get_selected_line(const RofiViewState *state);

unsigned int rofi_view_get_element_pitch(const RofiViewState *state,
                                         RofiOrientation orientation);
void rofi_view_restart(RofiViewState *state);

gboolean rofi_view_check_action(RofiViewState *state, BindingsScope scope,
                                guint action);

void rofi_view_trigger_action(RofiViewState *state, BindingsScope scope,
                              guint action);

void rofi_view_free(RofiViewState *state);

RofiViewState *rofi_view_get_active(void);

textbox *rofi_view_get_active_text(void);

 
void rofi_view_set_active(RofiViewState *state);

void rofi_view_remove_active(RofiViewState *state);
int rofi_view_error_dialog(const char *msg, int markup);

void rofi_view_queue_redraw(void);
 
void rofi_view_calculate_window_position(RofiViewState *state);

void rofi_view_cleanup(void);

Mode *rofi_view_get_mode(RofiViewState *state);

void rofi_view_hide(void);

void rofi_view_reload(void);

void rofi_view_switch_mode(RofiViewState *state, Mode *mode);

void rofi_view_set_overlay(RofiViewState *state, const char *text);
void rofi_view_set_overlay_timeout(RofiViewState *state, const char *text);

void rofi_view_clear_input(RofiViewState *state);

void __create_window(MenuFlags menu_flags);

xcb_window_t rofi_view_get_window(void);

void rofi_view_workers_initialize(void);
void rofi_view_workers_finalize(void);

void rofi_view_get_current_monitor(int *width, int *height);

void rofi_capture_screenshot(void);
void rofi_view_set_window_title(const char *title);
 
void rofi_view_set_size(RofiViewState *state, gint width, gint height);
 
void rofi_view_get_size(RofiViewState *state, gint *width, gint *height);
 
void rofi_view_ping_mouse(RofiViewState *state);
 
void rofi_view_set_window_title(const char *title);
void rofi_view_pool_refresh(void);
 
void rofi_view_get_menu_rect(int *x, int *y, int *w, int *h);
 
void rofi_view_set_cursor(RofiCursorType type);
 

 
void input_history_save(void);
void input_history_initialize(void);
 
struct _view_proxy;
 
/* Implementations */
extern const struct _view_proxy *xcb_view_proxy;
#ifdef ENABLE_WAYLAND
extern const struct _view_proxy *wayland_view_proxy;
#endif
 
void view_init(const struct _view_proxy *view_in);

void rofi_view_ellipsize_listview(RofiViewState *state,
                                  PangoEllipsizeMode mode);

gboolean rofi_set_im_window_pos(int new_x, int new_y);
 
// Cancel the current view
void rofi_view_cancel(RofiViewState *state);

WidgetTriggerActionResult textbox_button_trigger_action(
    widget *wid, MouseBindingMouseDefaultAction action, G_GNUC_UNUSED gint x,
    G_GNUC_UNUSED gint y, G_GNUC_UNUSED void *user_data);

#endif