evince.document.FormField 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.FormField;
26 
27 private import evince.document.c.functions;
28 public  import evince.document.c.types;
29 private import glib.Str;
30 private import gobject.ObjectG;
31 
32 
33 /** */
34 public class FormField : ObjectG
35 {
36 	/** the main Gtk struct */
37 	protected EvFormField* evFormField;
38 
39 	/** Get the main Gtk struct */
40 	public EvFormField* getFormFieldStruct(bool transferOwnership = false)
41 	{
42 		if (transferOwnership)
43 			ownedRef = false;
44 		return evFormField;
45 	}
46 
47 	/** the main Gtk struct as a void* */
48 	protected override void* getStruct()
49 	{
50 		return cast(void*)evFormField;
51 	}
52 
53 	/**
54 	 * Sets our main struct and passes it to the parent class.
55 	 */
56 	public this (EvFormField* evFormField, bool ownedRef = false)
57 	{
58 		this.evFormField = evFormField;
59 		super(cast(GObject*)evFormField, ownedRef);
60 	}
61 
62 
63 	/** */
64 	public static GType getType()
65 	{
66 		return ev_form_field_get_type();
67 	}
68 
69 	/**
70 	 * Gets the alternate ui name of @field. This name is also commonly
71 	 * used by pdf producers/readers to show it as a tooltip when @field area
72 	 * is hovered by a pointing device (eg. mouse).
73 	 *
74 	 * Returns: a string.
75 	 *
76 	 * Since: 3.38
77 	 */
78 	public string getAlternateName()
79 	{
80 		auto retStr = ev_form_field_get_alternate_name(evFormField);
81 
82 		scope(exit) Str.freeString(retStr);
83 		return Str.toString(retStr);
84 	}
85 
86 	/**
87 	 * Sets the alternate ui name of @field. This name is also commonly
88 	 * used by pdf producers/readers to show it as a tooltip when @field area
89 	 * is hovered by a pointing device (eg. mouse).
90 	 *
91 	 * Params:
92 	 *     alternativeText = a string with the alternative name of a form field
93 	 *
94 	 * Since: 3.38
95 	 */
96 	public void setAlternateName(string alternativeText)
97 	{
98 		ev_form_field_set_alternate_name(evFormField, Str.toStringz(alternativeText));
99 	}
100 }