handy.Column source code

1 /*
2  * This file is part of d-handy.
3  *
4  * d-handy is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * d-handy is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with d-handy; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 module handy.Column;
20 
21 private import glib.ConstructionException;
22 private import gobject.ObjectG;
23 private import gtk.Bin;
24 private import gtk.BuildableIF;
25 private import gtk.BuildableT;
26 private import handy.c.functions;
27 public  import handy.c.types;
28 
29 
30 /** */
31 public class Column : Bin
32 {
33 	/** the main Gtk struct */
34 	protected HdyColumn* hdyColumn;
35 
36 	/** Get the main Gtk struct */
37 	public HdyColumn* getColumnStruct(bool transferOwnership = false)
38 	{
39 		if (transferOwnership)
40 			ownedRef = false;
41 		return hdyColumn;
42 	}
43 
44 	/** the main Gtk struct as a void* */
45 	protected override void* getStruct()
46 	{
47 		return cast(void*)hdyColumn;
48 	}
49 
50 	/**
51 	 * Sets our main struct and passes it to the parent class.
52 	 */
53 	public this (HdyColumn* hdyColumn, bool ownedRef = false)
54 	{
55 		this.hdyColumn = hdyColumn;
56 		super(cast(GtkBin*)hdyColumn, ownedRef);
57 	}
58 
59 
60 	/** */
61 	public static GType getType()
62 	{
63 		return hdy_column_get_type();
64 	}
65 
66 	/**
67 	 * Creates a new #HdyColumn.
68 	 *
69 	 * Returns: a new #HdyColumn
70 	 *
71 	 * Throws: ConstructionException GTK+ fails to create the object.
72 	 */
73 	public this()
74 	{
75 		auto p = hdy_column_new();
76 
77 		if(p is null)
78 		{
79 			throw new ConstructionException("null returned by new");
80 		}
81 
82 		this(cast(HdyColumn*) p);
83 	}
84 
85 	/**
86 	 * Gets the width up to which the child will be allocated all the available
87 	 * width and starting from which it will be allocated a portion of the available
88 	 * width. In bith cases the allocated width won't exceed the declared maximum.
89 	 *
90 	 * Returns: the width up to which the child will be allocated all the available
91 	 *     width.
92 	 */
93 	public int getLinearGrowthWidth()
94 	{
95 		return hdy_column_get_linear_growth_width(hdyColumn);
96 	}
97 
98 	/**
99 	 * Gets the maximum width to allocate to the contained child.
100 	 *
101 	 * Returns: the maximum width to allocate to the contained child.
102 	 */
103 	public int getMaximumWidth()
104 	{
105 		return hdy_column_get_maximum_width(hdyColumn);
106 	}
107 
108 	/**
109 	 * Sets the width up to which the child will be allocated all the available
110 	 * width and starting from which it will be allocated a portion of the available
111 	 * width. In bith cases the allocated width won't exceed the declared maximum.
112 	 *
113 	 * Params:
114 	 *     linearGrowthWidth = the linear growth width
115 	 */
116 	public void setLinearGrowthWidth(int linearGrowthWidth)
117 	{
118 		hdy_column_set_linear_growth_width(hdyColumn, linearGrowthWidth);
119 	}
120 
121 	/**
122 	 * Sets the maximum width to allocate to the contained child.
123 	 *
124 	 * Params:
125 	 *     maximumWidth = the maximum width
126 	 */
127 	public void setMaximumWidth(int maximumWidth)
128 	{
129 		hdy_column_set_maximum_width(hdyColumn, maximumWidth);
130 	}
131 }