evince.document.DocumentLinksIF source code

1 /*
2  * This file is part of EvinceD.
3  * EvinceD is based on GtkD.
4  *
5  * EvinceD is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License
7  * as published by the Free Software Foundation; either version 3
8  * of the License, or (at your option) any later version, with
9  * some exceptions, please read the COPYING file.
10  *
11  * EvinceD is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with EvinceD; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
19  */
20 
21 // generated automatically - do not change
22 // find conversion definition on APILookup.txt
23 
24 
25 module evince.document.DocumentLinksIF;
26 
27 private import evince.document.Link;
28 private import evince.document.LinkDest;
29 private import evince.document.MappingList;
30 private import evince.document.Page;
31 private import evince.document.c.functions;
32 public  import evince.document.c.types;
33 private import glib.Str;
34 private import gobject.ObjectG;
35 private import gtk.TreeModelIF;
36 
37 
38 /** */
39 public interface DocumentLinksIF{
40 	/** Get the main Gtk struct */
41 	public EvDocumentLinks* getDocumentLinksStruct(bool transferOwnership = false);
42 
43 	/** the main Gtk struct as a void* */
44 	protected void* getStruct();
45 
46 
47 	/** */
48 	public static GType getType()
49 	{
50 		return ev_document_links_get_type();
51 	}
52 
53 	/**
54 	 *
55 	 * Params:
56 	 *     linkName = the link name
57 	 * Returns: an #EvLinkDest
58 	 */
59 	public LinkDest findLinkDest(string linkName);
60 
61 	/** */
62 	public int findLinkPage(string linkName);
63 
64 	/** */
65 	public int getDestPage(LinkDest dest);
66 
67 	/** */
68 	public string getDestPageLabel(LinkDest dest);
69 
70 	/** */
71 	public int getLinkPage(Link link);
72 
73 	/** */
74 	public string getLinkPageLabel(Link link);
75 
76 	/** */
77 	public MappingList getLinks(Page page);
78 
79 	/**
80 	 * Returns: a #GtkTreeModel
81 	 */
82 	public TreeModelIF getLinksModel();
83 
84 	/** */
85 	public bool hasDocumentLinks();
86 }