afb81b8278
Some checks failed
Docker. / Ubuntu (push) Has been cancelled
User-agent updater. / User-agent (push) Failing after 15s
Lock Threads / lock (push) Failing after 10s
Waiting for answer. / waiting-for-answer (push) Failing after 22s
Needs user action. / needs-user-action (push) Failing after 8s
Can't reproduce. / cant-reproduce (push) Failing after 8s
Close stale issues and PRs / stale (push) Has been cancelled
358 lines
8.9 KiB
C
358 lines
8.9 KiB
C
/* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 2; tab-width: 2 -*- */
|
|
/*
|
|
* nimf-candidatable.c
|
|
* This file is part of Nimf.
|
|
*
|
|
* Copyright (C) 2018,2019 Hodong Kim <cogniti@gmail.com>
|
|
*
|
|
* Nimf is free software: you can redistribute it and/or modify it
|
|
* under the terms of the GNU Lesser General Public License as published
|
|
* by the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Nimf is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "nimf-candidatable.h"
|
|
|
|
G_DEFINE_INTERFACE (NimfCandidatable, nimf_candidatable, G_TYPE_OBJECT)
|
|
|
|
static void
|
|
nimf_candidatable_default_init (NimfCandidatableInterface *iface)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_show:
|
|
* @candidatable: a #NimfCandidatable
|
|
* @target: a #NimfServiceIC
|
|
* @show_entry: %TRUE if the entry for auxiliary text should be shown
|
|
*/
|
|
void
|
|
nimf_candidatable_show (NimfCandidatable *candidatable,
|
|
NimfServiceIC *target,
|
|
gboolean show_entry)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->show)
|
|
iface->show (candidatable, target, show_entry);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_hide:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Hides the candidatable
|
|
*/
|
|
void
|
|
nimf_candidatable_hide (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->hide)
|
|
iface->hide (candidatable);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_is_visible:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Returns: %TRUE if the @candidatable is visible
|
|
*/
|
|
gboolean
|
|
nimf_candidatable_is_visible (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_val_if_fail (NIMF_IS_CANDIDATABLE (candidatable), FALSE);
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->is_visible)
|
|
return iface->is_visible (candidatable);
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_clear:
|
|
* @candidatable: a #NimfCandidatable
|
|
* @target: a #NimfServiceIC
|
|
*
|
|
* Clears the contents of the candidatable
|
|
*/
|
|
void
|
|
nimf_candidatable_clear (NimfCandidatable *candidatable,
|
|
NimfServiceIC *target)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->clear)
|
|
iface->clear (candidatable, target);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_set_page_values:
|
|
* @candidatable: a #NimfCandidatable
|
|
* @target: a #NimfServiceIC
|
|
* @page_index: page index
|
|
* @n_pages: the number of pages
|
|
* @page_size: page size
|
|
*
|
|
* Sets page values.
|
|
*/
|
|
void
|
|
nimf_candidatable_set_page_values (NimfCandidatable *candidatable,
|
|
NimfServiceIC *target,
|
|
gint page_index,
|
|
gint n_pages,
|
|
gint page_size)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->set_page_values)
|
|
iface->set_page_values (candidatable,
|
|
target,
|
|
page_index,
|
|
n_pages,
|
|
page_size);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_append:
|
|
* @candidatable: a #NimfCandidatable
|
|
* @text1: text for the first column; @text1 must be non-%NULL.
|
|
* @text2: (nullable): text for the second column; @text2 allows %NULL.
|
|
*
|
|
* After appending a row, adds @text1 to the first column and @text2 to the
|
|
* second column.
|
|
*/
|
|
void
|
|
nimf_candidatable_append (NimfCandidatable *candidatable,
|
|
const gchar *text1,
|
|
const gchar *text2)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->append)
|
|
iface->append (candidatable, text1, text2);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_get_selected_index:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Returns: index of the selected row
|
|
*/
|
|
gint
|
|
nimf_candidatable_get_selected_index (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_val_if_fail (NIMF_IS_CANDIDATABLE (candidatable), 0);
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->get_selected_index)
|
|
return iface->get_selected_index (candidatable);
|
|
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_get_selected_text:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Returns: text of the first column in the selected row
|
|
*/
|
|
gchar *
|
|
nimf_candidatable_get_selected_text (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_val_if_fail (NIMF_IS_CANDIDATABLE (candidatable), NULL);
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->get_selected_text)
|
|
return iface->get_selected_text (candidatable);
|
|
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_select_first_item_in_page:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Selects the first item in the page.
|
|
*/
|
|
void
|
|
nimf_candidatable_select_first_item_in_page (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->select_first_item_in_page)
|
|
iface->select_first_item_in_page (candidatable);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_select_last_item_in_page:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Selects the last item in the page.
|
|
*/
|
|
void
|
|
nimf_candidatable_select_last_item_in_page (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->select_last_item_in_page)
|
|
iface->select_last_item_in_page (candidatable);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_select_item_by_index_in_page:
|
|
* @candidatable: a #NimfCandidatable
|
|
* @index: a gint
|
|
*
|
|
* Selects an item by the index in the page.
|
|
*/
|
|
void
|
|
nimf_candidatable_select_item_by_index_in_page (NimfCandidatable *candidatable,
|
|
gint index)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->select_item_by_index_in_page)
|
|
iface->select_item_by_index_in_page (candidatable, index);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_select_previous_item:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Selects the previous item.
|
|
*/
|
|
void
|
|
nimf_candidatable_select_previous_item (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->select_previous_item)
|
|
iface->select_previous_item (candidatable);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_select_next_item:
|
|
* @candidatable: a #NimfCandidatable
|
|
*
|
|
* Selects the next item.
|
|
*/
|
|
void
|
|
nimf_candidatable_select_next_item (NimfCandidatable *candidatable)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->select_next_item)
|
|
iface->select_next_item (candidatable);
|
|
}
|
|
|
|
/**
|
|
* nimf_candidatable_set_auxiliary_text:
|
|
* @candidatable: a #NimfCandidatable
|
|
* @text: text
|
|
* @cursor_pos: cursor position within @text
|
|
*
|
|
* Sets auxiliary text.
|
|
*/
|
|
void
|
|
nimf_candidatable_set_auxiliary_text (NimfCandidatable *candidatable,
|
|
const gchar *text,
|
|
gint cursor_pos)
|
|
{
|
|
g_debug (G_STRLOC ": %s", G_STRFUNC);
|
|
|
|
NimfCandidatableInterface *iface;
|
|
|
|
g_return_if_fail (NIMF_IS_CANDIDATABLE (candidatable));
|
|
|
|
iface = NIMF_CANDIDATABLE_GET_IFACE (candidatable);
|
|
|
|
if (iface->set_auxiliary_text)
|
|
iface->set_auxiliary_text (candidatable, text, cursor_pos);
|
|
}
|