1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD 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 * gtkD 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 gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gtk.Scale; 26 27 private import glib.ConstructionException; 28 private import glib.Str; 29 private import gobject.ObjectG; 30 private import gobject.Signals; 31 private import gtk.Adjustment; 32 private import gtk.Range; 33 private import gtk.Widget; 34 public import gtkc.gdktypes; 35 private import gtkc.gtk; 36 public import gtkc.gtktypes; 37 private import pango.PgLayout; 38 39 40 /** 41 * A GtkScale is a slider control used to select a numeric value. 42 * To use it, you’ll probably want to investigate the methods on 43 * its base class, #GtkRange, in addition to the methods for GtkScale itself. 44 * To set the value of a scale, you would normally use gtk_range_set_value(). 45 * To detect changes to the value, you would normally use the 46 * #GtkRange::value-changed signal. 47 * 48 * Note that using the same upper and lower bounds for the #GtkScale (through 49 * the #GtkRange methods) will hide the slider itself. This is useful for 50 * applications that want to show an undeterminate value on the scale, without 51 * changing the layout of the application (such as movie or music players). 52 * 53 * # GtkScale as GtkBuildable 54 * 55 * GtkScale supports a custom <marks> element, which can contain multiple 56 * <mark> elements. The “value” and “position” attributes have the same 57 * meaning as gtk_scale_add_mark() parameters of the same name. If the 58 * element is not empty, its content is taken as the markup to show at 59 * the mark. It can be translated with the usual ”translatable” and 60 * “context” attributes. 61 * 62 * # CSS nodes 63 * 64 * |[<!-- language="plain" --> 65 * scale[.fine-tune][.marks-before][.marks-after] 66 * ├── marks.top 67 * │ ├── mark 68 * │ ┊ ├── [label] 69 * │ ┊ ╰── indicator 70 * ┊ ┊ 71 * │ ╰── mark 72 * ├── [value] 73 * ├── contents 74 * │ ╰── trough 75 * │ ├── slider 76 * │ ├── [highlight] 77 * │ ╰── [fill] 78 * ╰── marks.bottom 79 * ├── mark 80 * ┊ ├── indicator 81 * ┊ ╰── [label] 82 * ╰── mark 83 * ]| 84 * 85 * GtkScale has a main CSS node with name scale and a subnode for its contents, 86 * with subnodes named trough and slider. 87 * 88 * The main node gets the style class .fine-tune added when the scale is in 89 * 'fine-tuning' mode. 90 * 91 * If the scale has an origin (see gtk_scale_set_has_origin()), there is a 92 * subnode with name highlight below the trough node that is used for rendering 93 * the highlighted part of the trough. 94 * 95 * If the scale is showing a fill level (see gtk_range_set_show_fill_level()), 96 * there is a subnode with name fill below the trough node that is used for 97 * rendering the filled in part of the trough. 98 * 99 * If marks are present, there is a marks subnode before or after the contents 100 * node, below which each mark gets a node with name mark. The marks nodes get 101 * either the .top or .bottom style class. 102 * 103 * The mark node has a subnode named indicator. If the mark has text, it also 104 * has a subnode named label. When the mark is either above or left of the 105 * scale, the label subnode is the first when present. Otherwise, the indicator 106 * subnode is the first. 107 * 108 * The main CSS node gets the 'marks-before' and/or 'marks-after' style classes 109 * added depending on what marks are present. 110 * 111 * If the scale is displaying the value (see #GtkScale:draw-value), there is 112 * subnode with name value. 113 */ 114 public class Scale : Range 115 { 116 /** the main Gtk struct */ 117 protected GtkScale* gtkScale; 118 119 /** Get the main Gtk struct */ 120 public GtkScale* getScaleStruct() 121 { 122 return gtkScale; 123 } 124 125 /** the main Gtk struct as a void* */ 126 protected override void* getStruct() 127 { 128 return cast(void*)gtkScale; 129 } 130 131 protected override void setStruct(GObject* obj) 132 { 133 gtkScale = cast(GtkScale*)obj; 134 super.setStruct(obj); 135 } 136 137 /** 138 * Sets our main struct and passes it to the parent class. 139 */ 140 public this (GtkScale* gtkScale, bool ownedRef = false) 141 { 142 this.gtkScale = gtkScale; 143 super(cast(GtkRange*)gtkScale, ownedRef); 144 } 145 146 147 /** */ 148 public static GType getType() 149 { 150 return gtk_scale_get_type(); 151 } 152 153 /** 154 * Creates a new #GtkScale. 155 * 156 * Params: 157 * orientation = the scale’s orientation. 158 * adjustment = the #GtkAdjustment which sets the range 159 * of the scale, or %NULL to create a new adjustment. 160 * 161 * Return: a new #GtkScale 162 * 163 * Since: 3.0 164 * 165 * Throws: ConstructionException GTK+ fails to create the object. 166 */ 167 public this(GtkOrientation orientation, Adjustment adjustment) 168 { 169 auto p = gtk_scale_new(orientation, (adjustment is null) ? null : adjustment.getAdjustmentStruct()); 170 171 if(p is null) 172 { 173 throw new ConstructionException("null returned by new"); 174 } 175 176 this(cast(GtkScale*) p); 177 } 178 179 /** 180 * Creates a new scale widget with the given orientation that lets the 181 * user input a number between @min and @max (including @min and @max) 182 * with the increment @step. @step must be nonzero; it’s the distance 183 * the slider moves when using the arrow keys to adjust the scale 184 * value. 185 * 186 * Note that the way in which the precision is derived works best if @step 187 * is a power of ten. If the resulting precision is not suitable for your 188 * needs, use gtk_scale_set_digits() to correct it. 189 * 190 * Params: 191 * orientation = the scale’s orientation. 192 * min = minimum value 193 * max = maximum value 194 * step = step increment (tick size) used with keyboard shortcuts 195 * 196 * Return: a new #GtkScale 197 * 198 * Since: 3.0 199 * 200 * Throws: ConstructionException GTK+ fails to create the object. 201 */ 202 public this(GtkOrientation orientation, double min, double max, double step) 203 { 204 auto p = gtk_scale_new_with_range(orientation, min, max, step); 205 206 if(p is null) 207 { 208 throw new ConstructionException("null returned by new_with_range"); 209 } 210 211 this(cast(GtkScale*) p); 212 } 213 214 /** 215 * Adds a mark at @value. 216 * 217 * A mark is indicated visually by drawing a tick mark next to the scale, 218 * and GTK+ makes it easy for the user to position the scale exactly at the 219 * marks value. 220 * 221 * If @markup is not %NULL, text is shown next to the tick mark. 222 * 223 * To remove marks from a scale, use gtk_scale_clear_marks(). 224 * 225 * Params: 226 * value = the value at which the mark is placed, must be between 227 * the lower and upper limits of the scales’ adjustment 228 * position = where to draw the mark. For a horizontal scale, #GTK_POS_TOP 229 * and %GTK_POS_LEFT are drawn above the scale, anything else below. 230 * For a vertical scale, #GTK_POS_LEFT and %GTK_POS_TOP are drawn to 231 * the left of the scale, anything else to the right. 232 * markup = Text to be shown at the mark, using [Pango markup][PangoMarkupFormat], or %NULL 233 * 234 * Since: 2.16 235 */ 236 public void addMark(double value, GtkPositionType position, string markup) 237 { 238 gtk_scale_add_mark(gtkScale, value, position, Str.toStringz(markup)); 239 } 240 241 /** 242 * Removes any marks that have been added with gtk_scale_add_mark(). 243 * 244 * Since: 2.16 245 */ 246 public void clearMarks() 247 { 248 gtk_scale_clear_marks(gtkScale); 249 } 250 251 /** 252 * Gets the number of decimal places that are displayed in the value. 253 * 254 * Return: the number of decimal places that are displayed 255 */ 256 public int getDigits() 257 { 258 return gtk_scale_get_digits(gtkScale); 259 } 260 261 /** 262 * Returns whether the current value is displayed as a string 263 * next to the slider. 264 * 265 * Return: whether the current value is displayed as a string 266 */ 267 public bool getDrawValue() 268 { 269 return gtk_scale_get_draw_value(gtkScale) != 0; 270 } 271 272 /** 273 * Returns whether the scale has an origin. 274 * 275 * Return: %TRUE if the scale has an origin. 276 * 277 * Since: 3.4 278 */ 279 public bool getHasOrigin() 280 { 281 return gtk_scale_get_has_origin(gtkScale) != 0; 282 } 283 284 /** 285 * Gets the #PangoLayout used to display the scale. The returned 286 * object is owned by the scale so does not need to be freed by 287 * the caller. 288 * 289 * Return: the #PangoLayout for this scale, 290 * or %NULL if the #GtkScale:draw-value property is %FALSE. 291 * 292 * Since: 2.4 293 */ 294 public PgLayout getLayout() 295 { 296 auto p = gtk_scale_get_layout(gtkScale); 297 298 if(p is null) 299 { 300 return null; 301 } 302 303 return ObjectG.getDObject!(PgLayout)(cast(PangoLayout*) p); 304 } 305 306 /** 307 * Obtains the coordinates where the scale will draw the 308 * #PangoLayout representing the text in the scale. Remember 309 * when using the #PangoLayout function you need to convert to 310 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE. 311 * 312 * If the #GtkScale:draw-value property is %FALSE, the return 313 * values are undefined. 314 * 315 * Params: 316 * x = location to store X offset of layout, or %NULL 317 * y = location to store Y offset of layout, or %NULL 318 * 319 * Since: 2.4 320 */ 321 public void getLayoutOffsets(out int x, out int y) 322 { 323 gtk_scale_get_layout_offsets(gtkScale, &x, &y); 324 } 325 326 /** 327 * Gets the position in which the current value is displayed. 328 * 329 * Return: the position in which the current value is displayed 330 */ 331 public GtkPositionType getValuePos() 332 { 333 return gtk_scale_get_value_pos(gtkScale); 334 } 335 336 /** 337 * Sets the number of decimal places that are displayed in the value. 338 * Also causes the value of the adjustment to be rounded off to this 339 * number of digits, so the retrieved value matches the value the user saw. 340 * 341 * Note that rounding to a small number of digits can interfere with 342 * the smooth autoscrolling that is built into #GtkScale. As an alternative, 343 * you can use the #GtkScale::format-value signal to format the displayed 344 * value yourself. 345 * 346 * Params: 347 * digits = the number of decimal places to display, 348 * e.g. use 1 to display 1.0, 2 to display 1.00, etc 349 */ 350 public void setDigits(int digits) 351 { 352 gtk_scale_set_digits(gtkScale, digits); 353 } 354 355 /** 356 * Specifies whether the current value is displayed as a string next 357 * to the slider. 358 * 359 * Params: 360 * drawValue = %TRUE to draw the value 361 */ 362 public void setDrawValue(bool drawValue) 363 { 364 gtk_scale_set_draw_value(gtkScale, drawValue); 365 } 366 367 /** 368 * If @has_origin is set to %TRUE (the default), 369 * the scale will highlight the part of the scale 370 * between the origin (bottom or left side) of the scale 371 * and the current value. 372 * 373 * Params: 374 * hasOrigin = %TRUE if the scale has an origin 375 * 376 * Since: 3.4 377 */ 378 public void setHasOrigin(bool hasOrigin) 379 { 380 gtk_scale_set_has_origin(gtkScale, hasOrigin); 381 } 382 383 /** 384 * Sets the position in which the current value is displayed. 385 * 386 * Params: 387 * pos = the position in which the current value is displayed 388 */ 389 public void setValuePos(GtkPositionType pos) 390 { 391 gtk_scale_set_value_pos(gtkScale, pos); 392 } 393 394 int[string] connectedSignals; 395 396 string delegate(double, Scale)[] onFormatValueListeners; 397 /** 398 * Signal which allows you to change how the scale value is displayed. 399 * Connect a signal handler which returns an allocated string representing 400 * @value. That string will then be used to display the scale's value. 401 * 402 * Here's an example signal handler which displays a value 1.0 as 403 * with "-->1.0<--". 404 * |[<!-- language="C" --> 405 * static gchar* 406 * format_value_callback (GtkScale *scale, 407 * gdouble value) 408 * { 409 * return g_strdup_printf ("-->\%0.*g<--", 410 * gtk_scale_get_digits (scale), value); 411 * } 412 * ]| 413 * 414 * Params: 415 * value = the value to format 416 * 417 * Return: allocated string representing @value 418 */ 419 void addOnFormatValue(string delegate(double, Scale) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 420 { 421 if ( "format-value" !in connectedSignals ) 422 { 423 Signals.connectData( 424 this, 425 "format-value", 426 cast(GCallback)&callBackFormatValue, 427 cast(void*)this, 428 null, 429 connectFlags); 430 connectedSignals["format-value"] = 1; 431 } 432 onFormatValueListeners ~= dlg; 433 } 434 extern(C) static string callBackFormatValue(GtkScale* scaleStruct, double value, Scale _scale) 435 { 436 return _scale.onFormatValueListeners[0](value, _scale); 437 } 438 }