/usr/include/d/gtkd-3/gtk/Container.d is in libgtkd-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 | /*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gtk.Container;
private import cairo.Context;
private import glib.ListG;
private import glib.Str;
private import gobject.ObjectG;
private import gobject.ParamSpec;
private import gobject.Signals;
private import gobject.Value;
private import gtk.Adjustment;
private import gtk.Widget;
private import gtk.WidgetPath;
private import gtk.c.functions;
public import gtk.c.types;
public import gtkc.gtktypes;
private import std.algorithm;
/**
* A GTK+ user interface is constructed by nesting widgets inside widgets.
* Container widgets are the inner nodes in the resulting tree of widgets:
* they contain other widgets. So, for example, you might have a #GtkWindow
* containing a #GtkFrame containing a #GtkLabel. If you wanted an image instead
* of a textual label inside the frame, you might replace the #GtkLabel widget
* with a #GtkImage widget.
*
* There are two major kinds of container widgets in GTK+. Both are subclasses
* of the abstract GtkContainer base class.
*
* The first type of container widget has a single child widget and derives
* from #GtkBin. These containers are decorators, which
* add some kind of functionality to the child. For example, a #GtkButton makes
* its child into a clickable button; a #GtkFrame draws a frame around its child
* and a #GtkWindow places its child widget inside a top-level window.
*
* The second type of container can have more than one child; its purpose is to
* manage layout. This means that these containers assign
* sizes and positions to their children. For example, a #GtkHBox arranges its
* children in a horizontal row, and a #GtkGrid arranges the widgets it contains
* in a two-dimensional grid.
*
* For implementations of #GtkContainer the virtual method #GtkContainerClass.forall()
* is always required, since it's used for drawing and other internal operations
* on the children.
* If the #GtkContainer implementation expect to have non internal children
* it's needed to implement both #GtkContainerClass.add() and #GtkContainerClass.remove().
* If the GtkContainer implementation has internal children, they should be added
* with gtk_widget_set_parent() on init() and removed with gtk_widget_unparent()
* in the #GtkWidgetClass.destroy() implementation.
* See more about implementing custom widgets at https://wiki.gnome.org/HowDoI/CustomWidgets
*
* # Height for width geometry management
*
* GTK+ uses a height-for-width (and width-for-height) geometry management system.
* Height-for-width means that a widget can change how much vertical space it needs,
* depending on the amount of horizontal space that it is given (and similar for
* width-for-height).
*
* There are some things to keep in mind when implementing container widgets
* that make use of GTK+’s height for width geometry management system. First,
* it’s important to note that a container must prioritize one of its
* dimensions, that is to say that a widget or container can only have a
* #GtkSizeRequestMode that is %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
* %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. However, every widget and container
* must be able to respond to the APIs for both dimensions, i.e. even if a
* widget has a request mode that is height-for-width, it is possible that
* its parent will request its sizes using the width-for-height APIs.
*
* To ensure that everything works properly, here are some guidelines to follow
* when implementing height-for-width (or width-for-height) containers.
*
* Each request mode involves 2 virtual methods. Height-for-width apis run
* through gtk_widget_get_preferred_width() and then through gtk_widget_get_preferred_height_for_width().
* When handling requests in the opposite #GtkSizeRequestMode it is important that
* every widget request at least enough space to display all of its content at all times.
*
* When gtk_widget_get_preferred_height() is called on a container that is height-for-width,
* the container must return the height for its minimum width. This is easily achieved by
* simply calling the reverse apis implemented for itself as follows:
*
* |[<!-- language="C" -->
* static void
* foo_container_get_preferred_height (GtkWidget *widget,
* gint *min_height,
* gint *nat_height)
* {
* if (i_am_in_height_for_width_mode)
* {
* gint min_width;
*
* GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget,
* &min_width,
* NULL);
* GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width
* (widget,
* min_width,
* min_height,
* nat_height);
* }
* else
* {
* ... many containers support both request modes, execute the
* real width-for-height request here by returning the
* collective heights of all widgets that are stacked
* vertically (or whatever is appropriate for this container)
* ...
* }
* }
* ]|
*
* Similarly, when gtk_widget_get_preferred_width_for_height() is called for a container or widget
* that is height-for-width, it then only needs to return the base minimum width like so:
*
* |[<!-- language="C" -->
* static void
* foo_container_get_preferred_width_for_height (GtkWidget *widget,
* gint for_height,
* gint *min_width,
* gint *nat_width)
* {
* if (i_am_in_height_for_width_mode)
* {
* GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget,
* min_width,
* nat_width);
* }
* else
* {
* ... execute the real width-for-height request here based on
* the required width of the children collectively if the
* container were to be allocated the said height ...
* }
* }
* ]|
*
* Height for width requests are generally implemented in terms of a virtual allocation
* of widgets in the input orientation. Assuming an height-for-width request mode, a container
* would implement the get_preferred_height_for_width() virtual function by first calling
* gtk_widget_get_preferred_width() for each of its children.
*
* For each potential group of children that are lined up horizontally, the values returned by
* gtk_widget_get_preferred_width() should be collected in an array of #GtkRequestedSize structures.
* Any child spacing should be removed from the input @for_width and then the collective size should be
* allocated using the gtk_distribute_natural_allocation() convenience function.
*
* The container will then move on to request the preferred height for each child by using
* gtk_widget_get_preferred_height_for_width() and using the sizes stored in the #GtkRequestedSize array.
*
* To allocate a height-for-width container, it’s again important
* to consider that a container must prioritize one dimension over the other. So if
* a container is a height-for-width container it must first allocate all widgets horizontally
* using a #GtkRequestedSize array and gtk_distribute_natural_allocation() and then add any
* extra space (if and where appropriate) for the widget to expand.
*
* After adding all the expand space, the container assumes it was allocated sufficient
* height to fit all of its content. At this time, the container must use the total horizontal sizes
* of each widget to request the height-for-width of each of its children and store the requests in a
* #GtkRequestedSize array for any widgets that stack vertically (for tabular containers this can
* be generalized into the heights and widths of rows and columns).
* The vertical space must then again be distributed using gtk_distribute_natural_allocation()
* while this time considering the allocated height of the widget minus any vertical spacing
* that the container adds. Then vertical expand space should be added where appropriate and available
* and the container should go on to actually allocating the child widgets.
*
* See [GtkWidget’s geometry management section][geometry-management]
* to learn more about implementing height-for-width geometry management for widgets.
*
* # Child properties
*
* GtkContainer introduces child properties.
* These are object properties that are not specific
* to either the container or the contained widget, but rather to their relation.
* Typical examples of child properties are the position or pack-type of a widget
* which is contained in a #GtkBox.
*
* Use gtk_container_class_install_child_property() to install child properties
* for a container class and gtk_container_class_find_child_property() or
* gtk_container_class_list_child_properties() to get information about existing
* child properties.
*
* To set the value of a child property, use gtk_container_child_set_property(),
* gtk_container_child_set() or gtk_container_child_set_valist().
* To obtain the value of a child property, use
* gtk_container_child_get_property(), gtk_container_child_get() or
* gtk_container_child_get_valist(). To emit notification about child property
* changes, use gtk_widget_child_notify().
*
* # GtkContainer as GtkBuildable
*
* The GtkContainer implementation of the GtkBuildable interface supports
* a <packing> element for children, which can contain multiple <property>
* elements that specify child properties for the child.
*
* Since 2.16, child properties can also be marked as translatable using
* the same “translatable”, “comments” and “context” attributes that are used
* for regular properties.
*
* Since 3.16, containers can have a <focus-chain> element containing multiple
* <widget> elements, one for each child that should be added to the focus
* chain. The ”name” attribute gives the id of the widget.
*
* An example of these properties in UI definitions:
* |[
* <object class="GtkBox">
* <child>
* <object class="GtkEntry" id="entry1"/>
* <packing>
* <property name="pack-type">start</property>
* </packing>
* </child>
* <child>
* <object class="GtkEntry" id="entry2"/>
* </child>
* <focus-chain>
* <widget name="entry1"/>
* <widget name="entry2"/>
* </focus-chain>
* </object>
* ]|
*/
public class Container : Widget
{
/** the main Gtk struct */
protected GtkContainer* gtkContainer;
/** Get the main Gtk struct */
public GtkContainer* getContainerStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gtkContainer;
}
/** the main Gtk struct as a void* */
protected override void* getStruct()
{
return cast(void*)gtkContainer;
}
protected override void setStruct(GObject* obj)
{
gtkContainer = cast(GtkContainer*)obj;
super.setStruct(obj);
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GtkContainer* gtkContainer, bool ownedRef = false)
{
this.gtkContainer = gtkContainer;
super(cast(GtkWidget*)gtkContainer, ownedRef);
}
/**
* Removes all widgets from the container
*/
void removeAll()
{
GList* gList = gtk_container_get_children(getContainerStruct());
while ( gList !is null )
{
gtk_container_remove(getContainerStruct(), cast(GtkWidget*)gList.data);
gList = gList.next;
}
}
/**
*/
/** */
public static GType getType()
{
return gtk_container_get_type();
}
/**
* Adds @widget to @container. Typically used for simple containers
* such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
* layout containers such as #GtkBox or #GtkGrid, this function will
* pick default packing parameters that may not be correct. So
* consider functions such as gtk_box_pack_start() and
* gtk_grid_attach() as an alternative to gtk_container_add() in
* those cases. A widget may be added to only one container at a time;
* you can’t place the same widget inside two different containers.
*
* Note that some containers, such as #GtkScrolledWindow or #GtkListBox,
* may add intermediate children between the added widget and the
* container.
*
* Params:
* widget = a widget to be placed inside @container
*/
public void add(Widget widget)
{
gtk_container_add(gtkContainer, (widget is null) ? null : widget.getWidgetStruct());
}
/** */
public void checkResize()
{
gtk_container_check_resize(gtkContainer);
}
/**
* Gets the value of a child property for @child and @container.
*
* Params:
* child = a widget which is a child of @container
* propertyName = the name of the property to get
* value = a location to return the value
*/
public void childGetProperty(Widget child, string propertyName, Value value)
{
gtk_container_child_get_property(gtkContainer, (child is null) ? null : child.getWidgetStruct(), Str.toStringz(propertyName), (value is null) ? null : value.getValueStruct());
}
/**
* Gets the values of one or more child properties for @child and @container.
*
* Params:
* child = a widget which is a child of @container
* firstPropertyName = the name of the first property to get
* varArgs = return location for the first property, followed
* optionally by more name/return location pairs, followed by %NULL
*/
public void childGetValist(Widget child, string firstPropertyName, void* varArgs)
{
gtk_container_child_get_valist(gtkContainer, (child is null) ? null : child.getWidgetStruct(), Str.toStringz(firstPropertyName), varArgs);
}
/**
* Emits a #GtkWidget::child-notify signal for the
* [child property][child-properties]
* @child_property on the child.
*
* This is an analogue of g_object_notify() for child properties.
*
* Also see gtk_widget_child_notify().
*
* Params:
* child = the child widget
* childProperty = the name of a child property installed on
* the class of @container
*
* Since: 3.2
*/
public void childNotify(Widget child, string childProperty)
{
gtk_container_child_notify(gtkContainer, (child is null) ? null : child.getWidgetStruct(), Str.toStringz(childProperty));
}
/**
* Emits a #GtkWidget::child-notify signal for the
* [child property][child-properties] specified by
* @pspec on the child.
*
* This is an analogue of g_object_notify_by_pspec() for child properties.
*
* Params:
* child = the child widget
* pspec = the #GParamSpec of a child property instealled on
* the class of @container
*
* Since: 3.18
*/
public void childNotifyByPspec(Widget child, ParamSpec pspec)
{
gtk_container_child_notify_by_pspec(gtkContainer, (child is null) ? null : child.getWidgetStruct(), (pspec is null) ? null : pspec.getParamSpecStruct());
}
/**
* Sets a child property for @child and @container.
*
* Params:
* child = a widget which is a child of @container
* propertyName = the name of the property to set
* value = the value to set the property to
*/
public void childSetProperty(Widget child, string propertyName, Value value)
{
gtk_container_child_set_property(gtkContainer, (child is null) ? null : child.getWidgetStruct(), Str.toStringz(propertyName), (value is null) ? null : value.getValueStruct());
}
/**
* Sets one or more child properties for @child and @container.
*
* Params:
* child = a widget which is a child of @container
* firstPropertyName = the name of the first property to set
* varArgs = a %NULL-terminated list of property names and values, starting
* with @first_prop_name
*/
public void childSetValist(Widget child, string firstPropertyName, void* varArgs)
{
gtk_container_child_set_valist(gtkContainer, (child is null) ? null : child.getWidgetStruct(), Str.toStringz(firstPropertyName), varArgs);
}
/**
* Returns the type of the children supported by the container.
*
* Note that this may return %G_TYPE_NONE to indicate that no more
* children can be added, e.g. for a #GtkPaned which already has two
* children.
*
* Returns: a #GType.
*/
public GType childType()
{
return gtk_container_child_type(gtkContainer);
}
/**
* Invokes @callback on each direct child of @container, including
* children that are considered “internal” (implementation details
* of the container). “Internal” children generally weren’t added
* by the user of the container, but were added by the container
* implementation itself.
*
* Most applications should use gtk_container_foreach(), rather
* than gtk_container_forall().
*
* Params:
* callback = a callback
* callbackData = callback user data
*/
public void forall(GtkCallback callback, void* callbackData)
{
gtk_container_forall(gtkContainer, callback, callbackData);
}
/**
* Invokes @callback on each non-internal child of @container.
* See gtk_container_forall() for details on what constitutes
* an “internal” child. For all practical purposes, this function
* should iterate over precisely those child widgets that were
* added to the container by the application with explicit add()
* calls.
*
* Most applications should use gtk_container_foreach(),
* rather than gtk_container_forall().
*
* Params:
* callback = a callback
* callbackData = callback user data
*/
public void foreac(GtkCallback callback, void* callbackData)
{
gtk_container_foreach(gtkContainer, callback, callbackData);
}
/**
* Retrieves the border width of the container. See
* gtk_container_set_border_width().
*
* Returns: the current border width
*/
public uint getBorderWidth()
{
return gtk_container_get_border_width(gtkContainer);
}
/**
* Returns the container’s non-internal children. See
* gtk_container_forall() for details on what constitutes an "internal" child.
*
* Returns: a newly-allocated list of the container’s non-internal children.
*/
public ListG getChildren()
{
auto p = gtk_container_get_children(gtkContainer);
if(p is null)
{
return null;
}
return new ListG(cast(GList*) p);
}
/**
* Retrieves the focus chain of the container, if one has been
* set explicitly. If no focus chain has been explicitly
* set, GTK+ computes the focus chain based on the positions
* of the children. In that case, GTK+ stores %NULL in
* @focusable_widgets and returns %FALSE.
*
* Params:
* focusableWidgets = location
* to store the focus chain of the
* container, or %NULL. You should free this list
* using g_list_free() when you are done with it, however
* no additional reference count is added to the
* individual widgets in the focus chain.
*
* Returns: %TRUE if the focus chain of the container
* has been set explicitly.
*/
public bool getFocusChain(out ListG focusableWidgets)
{
GList* outfocusableWidgets = null;
auto p = gtk_container_get_focus_chain(gtkContainer, &outfocusableWidgets) != 0;
focusableWidgets = new ListG(outfocusableWidgets);
return p;
}
/**
* Returns the current focus child widget inside @container. This is not the
* currently focused widget. That can be obtained by calling
* gtk_window_get_focus().
*
* Returns: The child widget which will receive the
* focus inside @container when the @container is focused,
* or %NULL if none is set.
*
* Since: 2.14
*/
public Widget getFocusChild()
{
auto p = gtk_container_get_focus_child(gtkContainer);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Widget)(cast(GtkWidget*) p);
}
/**
* Retrieves the horizontal focus adjustment for the container. See
* gtk_container_set_focus_hadjustment ().
*
* Returns: the horizontal focus adjustment, or %NULL if
* none has been set.
*/
public Adjustment getFocusHadjustment()
{
auto p = gtk_container_get_focus_hadjustment(gtkContainer);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Adjustment)(cast(GtkAdjustment*) p);
}
/**
* Retrieves the vertical focus adjustment for the container. See
* gtk_container_set_focus_vadjustment().
*
* Returns: the vertical focus adjustment, or
* %NULL if none has been set.
*/
public Adjustment getFocusVadjustment()
{
auto p = gtk_container_get_focus_vadjustment(gtkContainer);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Adjustment)(cast(GtkAdjustment*) p);
}
/**
* Returns a newly created widget path representing all the widget hierarchy
* from the toplevel down to and including @child.
*
* Params:
* child = a child of @container
*
* Returns: A newly created #GtkWidgetPath
*/
public WidgetPath getPathForChild(Widget child)
{
auto p = gtk_container_get_path_for_child(gtkContainer, (child is null) ? null : child.getWidgetStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(WidgetPath)(cast(GtkWidgetPath*) p, true);
}
/**
* Returns the resize mode for the container. See
* gtk_container_set_resize_mode ().
*
* Deprecated: Resize modes are deprecated. They aren’t necessary
* anymore since frame clocks and might introduce obscure bugs if
* used.
*
* Returns: the current resize mode
*/
public GtkResizeMode getResizeMode()
{
return gtk_container_get_resize_mode(gtkContainer);
}
/**
* When a container receives a call to the draw function, it must send
* synthetic #GtkWidget::draw calls to all children that don’t have their
* own #GdkWindows. This function provides a convenient way of doing this.
* A container, when it receives a call to its #GtkWidget::draw function,
* calls gtk_container_propagate_draw() once for each child, passing in
* the @cr the container received.
*
* gtk_container_propagate_draw() takes care of translating the origin of @cr,
* and deciding whether the draw needs to be sent to the child. It is a
* convenient and optimized way of getting the same effect as calling
* gtk_widget_draw() on the child directly.
*
* In most cases, a container can simply either inherit the
* #GtkWidget::draw implementation from #GtkContainer, or do some drawing
* and then chain to the ::draw implementation from #GtkContainer.
*
* Params:
* child = a child of @container
* cr = Cairo context as passed to the container. If you want to use @cr
* in container’s draw function, consider using cairo_save() and
* cairo_restore() before calling this function.
*/
public void propagateDraw(Widget child, Context cr)
{
gtk_container_propagate_draw(gtkContainer, (child is null) ? null : child.getWidgetStruct(), (cr is null) ? null : cr.getContextStruct());
}
/**
* Removes @widget from @container. @widget must be inside @container.
* Note that @container will own a reference to @widget, and that this
* may be the last reference held; so removing a widget from its
* container can destroy that widget. If you want to use @widget
* again, you need to add a reference to it before removing it from
* a container, using g_object_ref(). If you don’t want to use @widget
* again it’s usually more efficient to simply destroy it directly
* using gtk_widget_destroy() since this will remove it from the
* container and help break any circular reference count cycles.
*
* Params:
* widget = a current child of @container
*/
public void remove(Widget widget)
{
gtk_container_remove(gtkContainer, (widget is null) ? null : widget.getWidgetStruct());
}
/** */
public void resizeChildren()
{
gtk_container_resize_children(gtkContainer);
}
/**
* Sets the border width of the container.
*
* The border width of a container is the amount of space to leave
* around the outside of the container. The only exception to this is
* #GtkWindow; because toplevel windows can’t leave space outside,
* they leave the space inside. The border is added on all sides of
* the container. To add space to only one side, use a specific
* #GtkWidget:margin property on the child widget, for example
* #GtkWidget:margin-top.
*
* Params:
* borderWidth = amount of blank space to leave outside
* the container. Valid values are in the range 0-65535 pixels.
*/
public void setBorderWidth(uint borderWidth)
{
gtk_container_set_border_width(gtkContainer, borderWidth);
}
/**
* Sets a focus chain, overriding the one computed automatically by GTK+.
*
* In principle each widget in the chain should be a descendant of the
* container, but this is not enforced by this method, since it’s allowed
* to set the focus chain before you pack the widgets, or have a widget
* in the chain that isn’t always packed. The necessary checks are done
* when the focus chain is actually traversed.
*
* Params:
* focusableWidgets = the new focus chain
*/
public void setFocusChain(ListG focusableWidgets)
{
gtk_container_set_focus_chain(gtkContainer, (focusableWidgets is null) ? null : focusableWidgets.getListGStruct());
}
/**
* Sets, or unsets if @child is %NULL, the focused child of @container.
*
* This function emits the GtkContainer::set_focus_child signal of
* @container. Implementations of #GtkContainer can override the
* default behaviour by overriding the class closure of this signal.
*
* This is function is mostly meant to be used by widgets. Applications can use
* gtk_widget_grab_focus() to manually set the focus to a specific widget.
*
* Params:
* child = a #GtkWidget, or %NULL
*/
public void setFocusChild(Widget child)
{
gtk_container_set_focus_child(gtkContainer, (child is null) ? null : child.getWidgetStruct());
}
/**
* Hooks up an adjustment to focus handling in a container, so when a child
* of the container is focused, the adjustment is scrolled to show that
* widget. This function sets the horizontal alignment.
* See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
* the adjustment and gtk_container_set_focus_vadjustment() for setting
* the vertical adjustment.
*
* The adjustments have to be in pixel units and in the same coordinate
* system as the allocation for immediate children of the container.
*
* Params:
* adjustment = an adjustment which should be adjusted when the focus is
* moved among the descendents of @container
*/
public void setFocusHadjustment(Adjustment adjustment)
{
gtk_container_set_focus_hadjustment(gtkContainer, (adjustment is null) ? null : adjustment.getAdjustmentStruct());
}
/**
* Hooks up an adjustment to focus handling in a container, so when a
* child of the container is focused, the adjustment is scrolled to
* show that widget. This function sets the vertical alignment. See
* gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
* the adjustment and gtk_container_set_focus_hadjustment() for setting
* the horizontal adjustment.
*
* The adjustments have to be in pixel units and in the same coordinate
* system as the allocation for immediate children of the container.
*
* Params:
* adjustment = an adjustment which should be adjusted when the focus
* is moved among the descendents of @container
*/
public void setFocusVadjustment(Adjustment adjustment)
{
gtk_container_set_focus_vadjustment(gtkContainer, (adjustment is null) ? null : adjustment.getAdjustmentStruct());
}
/**
* Sets the @reallocate_redraws flag of the container to the given value.
*
* Containers requesting reallocation redraws get automatically
* redrawn if any of their children changed allocation.
*
* Deprecated: Call gtk_widget_queue_draw() in your size_allocate handler.
*
* Params:
* needsRedraws = the new value for the container’s @reallocate_redraws flag
*/
public void setReallocateRedraws(bool needsRedraws)
{
gtk_container_set_reallocate_redraws(gtkContainer, needsRedraws);
}
/**
* Sets the resize mode for the container.
*
* The resize mode of a container determines whether a resize request
* will be passed to the container’s parent, queued for later execution
* or executed immediately.
*
* Deprecated: Resize modes are deprecated. They aren’t necessary
* anymore since frame clocks and might introduce obscure bugs if
* used.
*
* Params:
* resizeMode = the new resize mode
*/
public void setResizeMode(GtkResizeMode resizeMode)
{
gtk_container_set_resize_mode(gtkContainer, resizeMode);
}
/**
* Removes a focus chain explicitly set with gtk_container_set_focus_chain().
*/
public void unsetFocusChain()
{
gtk_container_unset_focus_chain(gtkContainer);
}
protected class OnAddDelegateWrapper
{
void delegate(Widget, Container) dlg;
gulong handlerId;
this(void delegate(Widget, Container) dlg)
{
this.dlg = dlg;
onAddListeners ~= this;
}
void remove(OnAddDelegateWrapper source)
{
foreach(index, wrapper; onAddListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onAddListeners[index] = null;
onAddListeners = std.algorithm.remove(onAddListeners, index);
break;
}
}
}
}
OnAddDelegateWrapper[] onAddListeners;
/** */
gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnAddDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"add",
cast(GCallback)&callBackAdd,
cast(void*)wrapper,
cast(GClosureNotify)&callBackAddDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackAdd(GtkContainer* containerStruct, GtkWidget* object, OnAddDelegateWrapper wrapper)
{
wrapper.dlg(ObjectG.getDObject!(Widget)(object), wrapper.outer);
}
extern(C) static void callBackAddDestroy(OnAddDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnCheckResizeDelegateWrapper
{
void delegate(Container) dlg;
gulong handlerId;
this(void delegate(Container) dlg)
{
this.dlg = dlg;
onCheckResizeListeners ~= this;
}
void remove(OnCheckResizeDelegateWrapper source)
{
foreach(index, wrapper; onCheckResizeListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onCheckResizeListeners[index] = null;
onCheckResizeListeners = std.algorithm.remove(onCheckResizeListeners, index);
break;
}
}
}
}
OnCheckResizeDelegateWrapper[] onCheckResizeListeners;
/** */
gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnCheckResizeDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"check-resize",
cast(GCallback)&callBackCheckResize,
cast(void*)wrapper,
cast(GClosureNotify)&callBackCheckResizeDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackCheckResize(GtkContainer* containerStruct, OnCheckResizeDelegateWrapper wrapper)
{
wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackCheckResizeDestroy(OnCheckResizeDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnRemoveDelegateWrapper
{
void delegate(Widget, Container) dlg;
gulong handlerId;
this(void delegate(Widget, Container) dlg)
{
this.dlg = dlg;
onRemoveListeners ~= this;
}
void remove(OnRemoveDelegateWrapper source)
{
foreach(index, wrapper; onRemoveListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onRemoveListeners[index] = null;
onRemoveListeners = std.algorithm.remove(onRemoveListeners, index);
break;
}
}
}
}
OnRemoveDelegateWrapper[] onRemoveListeners;
/** */
gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnRemoveDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"remove",
cast(GCallback)&callBackRemove,
cast(void*)wrapper,
cast(GClosureNotify)&callBackRemoveDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackRemove(GtkContainer* containerStruct, GtkWidget* object, OnRemoveDelegateWrapper wrapper)
{
wrapper.dlg(ObjectG.getDObject!(Widget)(object), wrapper.outer);
}
extern(C) static void callBackRemoveDestroy(OnRemoveDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnSetFocusChildDelegateWrapper
{
void delegate(Widget, Container) dlg;
gulong handlerId;
this(void delegate(Widget, Container) dlg)
{
this.dlg = dlg;
onSetFocusChildListeners ~= this;
}
void remove(OnSetFocusChildDelegateWrapper source)
{
foreach(index, wrapper; onSetFocusChildListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onSetFocusChildListeners[index] = null;
onSetFocusChildListeners = std.algorithm.remove(onSetFocusChildListeners, index);
break;
}
}
}
}
OnSetFocusChildDelegateWrapper[] onSetFocusChildListeners;
/** */
gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnSetFocusChildDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"set-focus-child",
cast(GCallback)&callBackSetFocusChild,
cast(void*)wrapper,
cast(GClosureNotify)&callBackSetFocusChildDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* object, OnSetFocusChildDelegateWrapper wrapper)
{
wrapper.dlg(ObjectG.getDObject!(Widget)(object), wrapper.outer);
}
extern(C) static void callBackSetFocusChildDestroy(OnSetFocusChildDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
}
|