Back to index

indicator-appmenu  12.10.0
hudresult.h
Go to the documentation of this file.
00001 /*
00002  * Copyright © 2012 Canonical Ltd.
00003  *
00004  * This program is free software: you can redistribute it and/or modify it
00005  * under the terms of the GNU General Public License version 3, as
00006  * published by the Free Software Foundation.
00007  *
00008  * This program is distributed in the hope that it will be useful, but
00009  * WITHOUT ANY WARRANTY; without even the implied warranties of
00010  * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
00011  * PURPOSE.  See the GNU General Public License for more details.
00012  *
00013  * You should have received a copy of the GNU General Public License along
00014  * with this program.  If not, see <http://www.gnu.org/licenses/>.
00015  *
00016  * Author: Ryan Lortie <desrt@desrt.ca>
00017  */
00018 
00019 #ifndef __HUD_RESULT_H__
00020 #define __HUD_RESULT_H__
00021 
00022 #include "huditem.h"
00023 
00024 #define HUD_TYPE_RESULT                                     (hud_result_get_type ())
00025 #define HUD_RESULT(inst)                                    (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
00026                                                              HUD_TYPE_RESULT, HudResult))
00027 #define HUD_IS_RESULT(inst)                                 (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
00028                                                              HUD_TYPE_RESULT))
00029 
00030 typedef struct _HudResult                                   HudResult;
00031 
00032 GType                   hud_result_get_type                             (void);
00033 
00034 HudResult *             hud_result_new                                  (HudItem      *item,
00035                                                                          HudTokenList *search_tokens,
00036                                                                          guint         penalty);
00037 
00038 HudResult *             hud_result_get_if_matched                       (HudItem      *item,
00039                                                                          HudTokenList *search_tokens,
00040                                                                          guint         penalty);
00041 
00042 HudItem *               hud_result_get_item                             (HudResult    *result);
00043 guint                   hud_result_get_distance                         (HudResult    *result,
00044                                                                          guint         max_usage);
00045 const gchar *           hud_result_get_html_description                 (HudResult    *result);
00046 
00047 
00048 #endif /* __HUD_RESULT_H__ */