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 atk.c.types; 26 27 public import glib.c.types; 28 public import gobject.c.types; 29 30 31 /** 32 * This is a singly-linked list (a #GSList) of #AtkAttribute. It is 33 * used by atk_text_get_run_attributes(), 34 * atk_text_get_default_attributes(), 35 * atk_editable_text_set_run_attributes(), 36 * atk_document_get_attributes() and atk_object_get_attributes() 37 */ 38 public alias GSList AtkAttributeSet; 39 40 public alias ulong AtkState; 41 42 /** 43 * Specifies how xy coordinates are to be interpreted. Used by functions such 44 * as atk_component_get_position() and atk_text_get_character_extents() 45 */ 46 public enum AtkCoordType 47 { 48 /** 49 * specifies xy coordinates relative to the screen 50 */ 51 SCREEN = 0, 52 /** 53 * specifies xy coordinates relative to the widget's 54 * top-level window 55 */ 56 WINDOW = 1, 57 /** 58 * specifies xy coordinates relative to the widget's 59 * immediate parent. Since: 2.30 60 */ 61 PARENT = 2, 62 } 63 alias AtkCoordType CoordType; 64 65 /** 66 * Describes the type of link 67 */ 68 public enum AtkHyperlinkStateFlags 69 { 70 /** 71 * Link is inline 72 */ 73 INLINE = 1, 74 } 75 alias AtkHyperlinkStateFlags HyperlinkStateFlags; 76 77 /** 78 * Specifies the type of a keyboard evemt. 79 */ 80 public enum AtkKeyEventType 81 { 82 /** 83 * specifies a key press event 84 */ 85 PRESS = 0, 86 /** 87 * specifies a key release event 88 */ 89 RELEASE = 1, 90 /** 91 * Not a valid value; specifies end of enumeration 92 */ 93 LAST_DEFINED = 2, 94 } 95 alias AtkKeyEventType KeyEventType; 96 97 /** 98 * Describes the layer of a component 99 * 100 * These enumerated "layer values" are used when determining which UI 101 * rendering layer a component is drawn into, which can help in making 102 * determinations of when components occlude one another. 103 */ 104 public enum AtkLayer 105 { 106 /** 107 * The object does not have a layer 108 */ 109 INVALID = 0, 110 /** 111 * This layer is reserved for the desktop background 112 */ 113 BACKGROUND = 1, 114 /** 115 * This layer is used for Canvas components 116 */ 117 CANVAS = 2, 118 /** 119 * This layer is normally used for components 120 */ 121 WIDGET = 3, 122 /** 123 * This layer is used for layered components 124 */ 125 MDI = 4, 126 /** 127 * This layer is used for popup components, such as menus 128 */ 129 POPUP = 5, 130 /** 131 * This layer is reserved for future use. 132 */ 133 OVERLAY = 6, 134 /** 135 * This layer is used for toplevel windows. 136 */ 137 WINDOW = 7, 138 } 139 alias AtkLayer Layer; 140 141 /** 142 * Describes the type of the relation 143 */ 144 public enum AtkRelationType 145 { 146 /** 147 * Not used, represens "no relationship" or an error condition. 148 */ 149 NULL = 0, 150 /** 151 * Indicates an object controlled by one or more target objects. 152 */ 153 CONTROLLED_BY = 1, 154 /** 155 * Indicates an object is an controller for one or more target objects. 156 */ 157 CONTROLLER_FOR = 2, 158 /** 159 * Indicates an object is a label for one or more target objects. 160 */ 161 LABEL_FOR = 3, 162 /** 163 * Indicates an object is labelled by one or more target objects. 164 */ 165 LABELLED_BY = 4, 166 /** 167 * Indicates an object is a member of a group of one or more target objects. 168 */ 169 MEMBER_OF = 5, 170 /** 171 * Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell. 172 */ 173 NODE_CHILD_OF = 6, 174 /** 175 * Indicates that the object has content that flows logically to another 176 * AtkObject in a sequential way, (for instance text-flow). 177 */ 178 FLOWS_TO = 7, 179 /** 180 * Indicates that the object has content that flows logically from 181 * another AtkObject in a sequential way, (for instance text-flow). 182 */ 183 FLOWS_FROM = 8, 184 /** 185 * Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component. 186 */ 187 SUBWINDOW_OF = 9, 188 /** 189 * Indicates that the object visually embeds 190 * another object's content, i.e. this object's content flows around 191 * another's content. 192 */ 193 EMBEDS = 10, 194 /** 195 * Reciprocal of %ATK_RELATION_EMBEDS, indicates that 196 * this object's content is visualy embedded in another object. 197 */ 198 EMBEDDED_BY = 11, 199 /** 200 * Indicates that an object is a popup for another object. 201 */ 202 POPUP_FOR = 12, 203 /** 204 * Indicates that an object is a parent window of another object. 205 */ 206 PARENT_WINDOW_OF = 13, 207 /** 208 * Reciprocal of %ATK_RELATION_DESCRIPTION_FOR. Indicates that one 209 * or more target objects provide descriptive information about this object. This relation 210 * type is most appropriate for information that is not essential as its presentation may 211 * be user-configurable and/or limited to an on-demand mechanism such as an assistive 212 * technology command. For brief, essential information such as can be found in a widget's 213 * on-screen label, use %ATK_RELATION_LABELLED_BY. For an on-screen error message, use 214 * %ATK_RELATION_ERROR_MESSAGE. For lengthy extended descriptive information contained in 215 * an on-screen object, consider using %ATK_RELATION_DETAILS as assistive technologies may 216 * provide a means for the user to navigate to objects containing detailed descriptions so 217 * that their content can be more closely reviewed. 218 */ 219 DESCRIBED_BY = 14, 220 /** 221 * Reciprocal of %ATK_RELATION_DESCRIBED_BY. Indicates that this 222 * object provides descriptive information about the target object(s). See also 223 * %ATK_RELATION_DETAILS_FOR and %ATK_RELATION_ERROR_FOR. 224 */ 225 DESCRIPTION_FOR = 15, 226 /** 227 * Indicates an object is a cell in a treetable and is expanded to display other cells in the same column. 228 */ 229 NODE_PARENT_OF = 16, 230 /** 231 * Reciprocal of %ATK_RELATION_DETAILS_FOR. Indicates that this object 232 * has a detailed or extended description, the contents of which can be found in the target 233 * object(s). This relation type is most appropriate for information that is sufficiently 234 * lengthy as to make navigation to the container of that information desirable. For less 235 * verbose information suitable for announcement only, see %ATK_RELATION_DESCRIBED_BY. If 236 * the detailed information describes an error condition, %ATK_RELATION_ERROR_FOR should be 237 * used instead. @Since: ATK-2.26. 238 */ 239 DETAILS = 17, 240 /** 241 * Reciprocal of %ATK_RELATION_DETAILS. Indicates that this object 242 * provides a detailed or extended description about the target object(s). See also 243 * %ATK_RELATION_DESCRIPTION_FOR and %ATK_RELATION_ERROR_FOR. @Since: ATK-2.26. 244 */ 245 DETAILS_FOR = 18, 246 /** 247 * Reciprocal of %ATK_RELATION_ERROR_FOR. Indicates that this object 248 * has one or more errors, the nature of which is described in the contents of the target 249 * object(s). Objects that have this relation type should also contain %ATK_STATE_INVALID_ENTRY 250 * in their #AtkStateSet. @Since: ATK-2.26. 251 */ 252 ERROR_MESSAGE = 19, 253 /** 254 * Reciprocal of %ATK_RELATION_ERROR_MESSAGE. Indicates that this object 255 * contains an error message describing an invalid condition in the target object(s). @Since: 256 * ATK_2.26. 257 */ 258 ERROR_FOR = 20, 259 /** 260 * Not used, this value indicates the end of the enumeration. 261 */ 262 LAST_DEFINED = 21, 263 } 264 alias AtkRelationType RelationType; 265 266 /** 267 * Describes the role of an object 268 * 269 * These are the built-in enumerated roles that UI components can have in 270 * ATK. Other roles may be added at runtime, so an AtkRole >= 271 * ATK_ROLE_LAST_DEFINED is not necessarily an error. 272 */ 273 public enum AtkRole 274 { 275 /** 276 * Invalid role 277 */ 278 INVALID = 0, 279 /** 280 * A label which represents an accelerator 281 */ 282 ACCELERATOR_LABEL = 1, 283 /** 284 * An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc. 285 */ 286 ALERT = 2, 287 /** 288 * An object which is an animated image 289 */ 290 ANIMATION = 3, 291 /** 292 * An arrow in one of the four cardinal directions 293 */ 294 ARROW = 4, 295 /** 296 * An object that displays a calendar and allows the user to select a date 297 */ 298 CALENDAR = 5, 299 /** 300 * An object that can be drawn into and is used to trap events 301 */ 302 CANVAS = 6, 303 /** 304 * A choice that can be checked or unchecked and provides a separate indicator for the current state 305 */ 306 CHECK_BOX = 7, 307 /** 308 * A menu item with a check box 309 */ 310 CHECK_MENU_ITEM = 8, 311 /** 312 * A specialized dialog that lets the user choose a color 313 */ 314 COLOR_CHOOSER = 9, 315 /** 316 * The header for a column of data 317 */ 318 COLUMN_HEADER = 10, 319 /** 320 * A collapsible list of choices the user can select from 321 */ 322 COMBO_BOX = 11, 323 /** 324 * An object whose purpose is to allow a user to edit a date 325 */ 326 DATE_EDITOR = 12, 327 /** 328 * An inconifed internal frame within a DESKTOP_PANE 329 */ 330 DESKTOP_ICON = 13, 331 /** 332 * A pane that supports internal frames and iconified versions of those internal frames 333 */ 334 DESKTOP_FRAME = 14, 335 /** 336 * An object whose purpose is to allow a user to set a value 337 */ 338 DIAL = 15, 339 /** 340 * A top level window with title bar and a border 341 */ 342 DIALOG = 16, 343 /** 344 * A pane that allows the user to navigate through and select the contents of a directory 345 */ 346 DIRECTORY_PANE = 17, 347 /** 348 * An object used for drawing custom user interface elements 349 */ 350 DRAWING_AREA = 18, 351 /** 352 * A specialized dialog that lets the user choose a file 353 */ 354 FILE_CHOOSER = 19, 355 /** 356 * A object that fills up space in a user interface 357 */ 358 FILLER = 20, 359 /** 360 * A specialized dialog that lets the user choose a font 361 */ 362 FONT_CHOOSER = 21, 363 /** 364 * A top level window with a title bar, border, menubar, etc. 365 */ 366 FRAME = 22, 367 /** 368 * A pane that is guaranteed to be painted on top of all panes beneath it 369 */ 370 GLASS_PANE = 23, 371 /** 372 * A document container for HTML, whose children represent the document content 373 */ 374 HTML_CONTAINER = 24, 375 /** 376 * A small fixed size picture, typically used to decorate components 377 */ 378 ICON = 25, 379 /** 380 * An object whose primary purpose is to display an image 381 */ 382 IMAGE = 26, 383 /** 384 * A frame-like object that is clipped by a desktop pane 385 */ 386 INTERNAL_FRAME = 27, 387 /** 388 * An object used to present an icon or short string in an interface 389 */ 390 LABEL = 28, 391 /** 392 * A specialized pane that allows its children to be drawn in layers, providing a form of stacking order 393 */ 394 LAYERED_PANE = 29, 395 /** 396 * An object that presents a list of objects to the user and allows the user to select one or more of them 397 */ 398 LIST = 30, 399 /** 400 * An object that represents an element of a list 401 */ 402 LIST_ITEM = 31, 403 /** 404 * An object usually found inside a menu bar that contains a list of actions the user can choose from 405 */ 406 MENU = 32, 407 /** 408 * An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from 409 */ 410 MENU_BAR = 33, 411 /** 412 * An object usually contained in a menu that presents an action the user can choose 413 */ 414 MENU_ITEM = 34, 415 /** 416 * A specialized pane whose primary use is inside a DIALOG 417 */ 418 OPTION_PANE = 35, 419 /** 420 * An object that is a child of a page tab list 421 */ 422 PAGE_TAB = 36, 423 /** 424 * An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object 425 */ 426 PAGE_TAB_LIST = 37, 427 /** 428 * A generic container that is often used to group objects 429 */ 430 PANEL = 38, 431 /** 432 * A text object uses for passwords, or other places where the text content is not shown visibly to the user 433 */ 434 PASSWORD_TEXT = 39, 435 /** 436 * A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices 437 */ 438 POPUP_MENU = 40, 439 /** 440 * An object used to indicate how much of a task has been completed 441 */ 442 PROGRESS_BAR = 41, 443 /** 444 * An object the user can manipulate to tell the application to do something 445 */ 446 PUSH_BUTTON = 42, 447 /** 448 * A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked 449 */ 450 RADIO_BUTTON = 43, 451 /** 452 * A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected 453 */ 454 RADIO_MENU_ITEM = 44, 455 /** 456 * A specialized pane that has a glass pane and a layered pane as its children 457 */ 458 ROOT_PANE = 45, 459 /** 460 * The header for a row of data 461 */ 462 ROW_HEADER = 46, 463 /** 464 * An object usually used to allow a user to incrementally view a large amount of data. 465 */ 466 SCROLL_BAR = 47, 467 /** 468 * An object that allows a user to incrementally view a large amount of information 469 */ 470 SCROLL_PANE = 48, 471 /** 472 * An object usually contained in a menu to provide a visible and logical separation of the contents in a menu 473 */ 474 SEPARATOR = 49, 475 /** 476 * An object that allows the user to select from a bounded range 477 */ 478 SLIDER = 50, 479 /** 480 * A specialized panel that presents two other panels at the same time 481 */ 482 SPLIT_PANE = 51, 483 /** 484 * An object used to get an integer or floating point number from the user 485 */ 486 SPIN_BUTTON = 52, 487 /** 488 * An object which reports messages of minor importance to the user 489 */ 490 STATUSBAR = 53, 491 /** 492 * An object used to represent information in terms of rows and columns 493 */ 494 TABLE = 54, 495 /** 496 * A cell in a table 497 */ 498 TABLE_CELL = 55, 499 /** 500 * The header for a column of a table 501 */ 502 TABLE_COLUMN_HEADER = 56, 503 /** 504 * The header for a row of a table 505 */ 506 TABLE_ROW_HEADER = 57, 507 /** 508 * A menu item used to tear off and reattach its menu 509 */ 510 TEAR_OFF_MENU_ITEM = 58, 511 /** 512 * An object that represents an accessible terminal. @Since: ATK-0.6 513 */ 514 TERMINAL = 59, 515 /** 516 * An interactive widget that supports multiple lines of text and 517 * optionally accepts user input, but whose purpose is not to solicit user input. 518 * Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor 519 * but inappropriate for an input field in a dialog box or web form. For widgets 520 * whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and 521 * ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of 522 * textual information, see ATK_ROLE_STATIC. 523 */ 524 TEXT = 60, 525 /** 526 * A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state 527 */ 528 TOGGLE_BUTTON = 61, 529 /** 530 * A bar or palette usually composed of push buttons or toggle buttons 531 */ 532 TOOL_BAR = 62, 533 /** 534 * An object that provides information about another object 535 */ 536 TOOL_TIP = 63, 537 /** 538 * An object used to represent hierarchical information to the user 539 */ 540 TREE = 64, 541 /** 542 * An object capable of expanding and collapsing rows as well as showing multiple columns of data. @Since: ATK-0.7 543 */ 544 TREE_TABLE = 65, 545 /** 546 * The object contains some Accessible information, but its role is not known 547 */ 548 UNKNOWN = 66, 549 /** 550 * An object usually used in a scroll pane 551 */ 552 VIEWPORT = 67, 553 /** 554 * A top level window with no title or border. 555 */ 556 WINDOW = 68, 557 /** 558 * An object that serves as a document header. @Since: ATK-1.1.1 559 */ 560 HEADER = 69, 561 /** 562 * An object that serves as a document footer. @Since: ATK-1.1.1 563 */ 564 FOOTER = 70, 565 /** 566 * An object which is contains a paragraph of text content. @Since: ATK-1.1.1 567 */ 568 PARAGRAPH = 71, 569 /** 570 * An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). @Since: ATK-1.1.1 571 */ 572 RULER = 72, 573 /** 574 * The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. @Since: ATK-1.1.4 575 */ 576 APPLICATION = 73, 577 /** 578 * The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. @Since: ATK-1.3 579 */ 580 AUTOCOMPLETE = 74, 581 /** 582 * The object is an editable text object in a toolbar. @Since: ATK-1.5 583 */ 584 EDIT_BAR = 75, 585 /** 586 * The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. @Since: ATK-1.7.2 587 */ 588 EMBEDDED = 76, 589 /** 590 * The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present. @Since: ATK-1.11 591 */ 592 ENTRY = 77, 593 /** 594 * The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. @Since: ATK-1.11 595 */ 596 CHART = 78, 597 /** 598 * The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. @Since: ATK-1.11 599 */ 600 CAPTION = 79, 601 /** 602 * The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. @Since: ATK-1.11 603 */ 604 DOCUMENT_FRAME = 80, 605 /** 606 * The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes. 607 */ 608 HEADING = 81, 609 /** 610 * The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. @Since: ATK-1.11 611 */ 612 PAGE = 82, 613 /** 614 * The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. @Since: ATK-1.11 615 */ 616 SECTION = 83, 617 /** 618 * The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. @Since: ATK-1.11 619 */ 620 REDUNDANT_OBJECT = 84, 621 /** 622 * The object is a container for form controls, for instance as part of a 623 * web form or user-input form within a document. This role is primarily a tag/convenience for 624 * clients when navigating complex documents, it is not expected that ordinary GUI containers will 625 * always have ATK_ROLE_FORM. @Since: ATK-1.12.0 626 */ 627 FORM = 85, 628 /** 629 * The object is a hypertext anchor, i.e. a "link" in a 630 * hypertext document. Such objects are distinct from 'inline' 631 * content which may also use the Hypertext/Hyperlink interfaces 632 * to indicate the range/location within a text object where 633 * an inline or embedded object lies. @Since: ATK-1.12.1 634 */ 635 LINK = 86, 636 /** 637 * The object is a window or similar viewport 638 * which is used to allow composition or input of a 'complex character', 639 * in other words it is an "input method window." @Since: ATK-1.12.1 640 */ 641 INPUT_METHOD_WINDOW = 87, 642 /** 643 * A row in a table. @Since: ATK-2.1.0 644 */ 645 TABLE_ROW = 88, 646 /** 647 * An object that represents an element of a tree. @Since: ATK-2.1.0 648 */ 649 TREE_ITEM = 89, 650 /** 651 * A document frame which contains a spreadsheet. @Since: ATK-2.1.0 652 */ 653 DOCUMENT_SPREADSHEET = 90, 654 /** 655 * A document frame which contains a presentation or slide content. @Since: ATK-2.1.0 656 */ 657 DOCUMENT_PRESENTATION = 91, 658 /** 659 * A document frame which contains textual content, such as found in a word processing application. @Since: ATK-2.1.0 660 */ 661 DOCUMENT_TEXT = 92, 662 /** 663 * A document frame which contains HTML or other markup suitable for display in a web browser. @Since: ATK-2.1.0 664 */ 665 DOCUMENT_WEB = 93, 666 /** 667 * A document frame which contains email content to be displayed or composed either in plain text or HTML. @Since: ATK-2.1.0 668 */ 669 DOCUMENT_EMAIL = 94, 670 /** 671 * An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. @Since: ATK-2.1.0 672 */ 673 COMMENT = 95, 674 /** 675 * A non-collapsible list of choices the user can select from. @Since: ATK-2.1.0 676 */ 677 LIST_BOX = 96, 678 /** 679 * A group of related widgets. This group typically has a label. @Since: ATK-2.1.0 680 */ 681 GROUPING = 97, 682 /** 683 * An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. @Since: ATK-2.1.0 684 */ 685 IMAGE_MAP = 98, 686 /** 687 * A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. @Since: ATK-2.1.0 688 */ 689 NOTIFICATION = 99, 690 /** 691 * An object designed to present a message to the user within an existing window. @Since: ATK-2.1.0 692 */ 693 INFO_BAR = 100, 694 /** 695 * A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. @Since: ATK-2.7.3 696 */ 697 LEVEL_BAR = 101, 698 /** 699 * A bar that serves as the title of a window or a 700 * dialog. @Since: ATK-2.12 701 */ 702 TITLE_BAR = 102, 703 /** 704 * An object which contains a text section 705 * that is quoted from another source. @Since: ATK-2.12 706 */ 707 BLOCK_QUOTE = 103, 708 /** 709 * An object which represents an audio element. @Since: ATK-2.12 710 */ 711 AUDIO = 104, 712 /** 713 * An object which represents a video element. @Since: ATK-2.12 714 */ 715 VIDEO = 105, 716 /** 717 * A definition of a term or concept. @Since: ATK-2.12 718 */ 719 DEFINITION = 106, 720 /** 721 * A section of a page that consists of a 722 * composition that forms an independent part of a document, page, or 723 * site. Examples: A blog entry, a news story, a forum post. @Since: 724 * ATK-2.12 725 */ 726 ARTICLE = 107, 727 /** 728 * A region of a web page intended as a 729 * navigational landmark. This is designed to allow Assistive 730 * Technologies to provide quick navigation among key regions within a 731 * document. @Since: ATK-2.12 732 */ 733 LANDMARK = 108, 734 /** 735 * A text widget or container holding log content, such 736 * as chat history and error logs. In this role there is a 737 * relationship between the arrival of new items in the log and the 738 * reading order. The log contains a meaningful sequence and new 739 * information is added only to the end of the log, not at arbitrary 740 * points. @Since: ATK-2.12 741 */ 742 LOG = 109, 743 /** 744 * A container where non-essential information 745 * changes frequently. Common usages of marquee include stock tickers 746 * and ad banners. The primary difference between a marquee and a log 747 * is that logs usually have a meaningful order or sequence of 748 * important content changes. @Since: ATK-2.12 749 */ 750 MARQUEE = 110, 751 /** 752 * A text widget or container that holds a mathematical 753 * expression. @Since: ATK-2.12 754 */ 755 MATH = 111, 756 /** 757 * A widget whose purpose is to display a rating, 758 * such as the number of stars associated with a song in a media 759 * player. Objects of this role should also implement 760 * AtkValue. @Since: ATK-2.12 761 */ 762 RATING = 112, 763 /** 764 * An object containing a numerical counter which 765 * indicates an amount of elapsed time from a start point, or the time 766 * remaining until an end point. @Since: ATK-2.12 767 */ 768 TIMER = 113, 769 /** 770 * An object that represents a list of 771 * term-value groups. A term-value group represents a individual 772 * description and consist of one or more names 773 * (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values 774 * (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be 775 * more than one group with the same term name. @Since: ATK-2.12 776 */ 777 DESCRIPTION_LIST = 114, 778 /** 779 * An object that represents a term or phrase 780 * with a corresponding definition. @Since: ATK-2.12 781 */ 782 DESCRIPTION_TERM = 115, 783 /** 784 * An object that represents the 785 * description, definition or value of a term. @Since: ATK-2.12 786 */ 787 DESCRIPTION_VALUE = 116, 788 /** 789 * A generic non-container object whose purpose is to display a 790 * brief amount of information to the user and whose role is known by the 791 * implementor but lacks semantic value for the user. Examples in which 792 * ATK_ROLE_STATIC is appropriate include the message displayed in a message box 793 * and an image used as an alternative means to display text. ATK_ROLE_STATIC 794 * should not be applied to widgets which are traditionally interactive, objects 795 * which display a significant amount of content, or any object which has an 796 * accessible relation pointing to another object. Implementors should expose the 797 * displayed information through the accessible name of the object. If doing so seems 798 * inappropriate, it may indicate that a different role should be used. For 799 * labels which describe another widget, see ATK_ROLE_LABEL. For text views, see 800 * ATK_ROLE_TEXT. For generic containers, see ATK_ROLE_PANEL. For objects whose 801 * role is not known by the implementor, see ATK_ROLE_UNKNOWN. @Since: ATK-2.16. 802 */ 803 STATIC = 117, 804 /** 805 * An object that represents a mathematical fraction. 806 */ 807 MATH_FRACTION = 118, 808 /** 809 * An object that represents a mathematical expression 810 * displayed with a radical. @Since: ATK-2.16. 811 */ 812 MATH_ROOT = 119, 813 /** 814 * An object that contains text that is displayed as a 815 * subscript. @Since: ATK-2.16. 816 */ 817 SUBSCRIPT = 120, 818 /** 819 * An object that contains text that is displayed as a 820 * superscript. @Since: ATK-2.16. 821 */ 822 SUPERSCRIPT = 121, 823 /** 824 * An object that contains the text of a footnote. @Since: ATK-2.26. 825 */ 826 FOOTNOTE = 122, 827 /** 828 * not a valid role, used for finding end of the enumeration 829 */ 830 LAST_DEFINED = 123, 831 } 832 alias AtkRole Role; 833 834 /** 835 * Specifies where an object should be placed on the screen when using scroll_to. 836 * 837 * Since: 2.30 838 */ 839 public enum AtkScrollType 840 { 841 /** 842 * Scroll the object vertically and horizontally to the top 843 * left corner of the window. 844 */ 845 TOP_LEFT = 0, 846 /** 847 * Scroll the object vertically and horizontally to the 848 * bottom right corner of the window. 849 */ 850 BOTTOM_RIGHT = 1, 851 /** 852 * Scroll the object vertically to the top edge of the 853 * window. 854 */ 855 TOP_EDGE = 2, 856 /** 857 * Scroll the object vertically to the bottom edge of 858 * the window. 859 */ 860 BOTTOM_EDGE = 3, 861 /** 862 * Scroll the object vertically and horizontally to the 863 * left edge of the window. 864 */ 865 LEFT_EDGE = 4, 866 /** 867 * Scroll the object vertically and horizontally to the 868 * right edge of the window. 869 */ 870 RIGHT_EDGE = 5, 871 /** 872 * Scroll the object vertically and horizontally so that 873 * as much as possible of the object becomes visible. The exact placement is 874 * determined by the application. 875 */ 876 ANYWHERE = 6, 877 } 878 alias AtkScrollType ScrollType; 879 880 /** 881 * The possible types of states of an object 882 */ 883 public enum AtkStateType 884 { 885 /** 886 * Indicates an invalid state - probably an error condition. 887 */ 888 INVALID = 0, 889 /** 890 * Indicates a window is currently the active window, or an object is the active subelement within a container or table. ATK_STATE_ACTIVE should not be used for objects which have ATK_STATE_FOCUSABLE or ATK_STATE_SELECTABLE: Those objects should use ATK_STATE_FOCUSED and ATK_STATE_SELECTED respectively. ATK_STATE_ACTIVE is a means to indicate that an object which is not focusable and not selectable is the currently-active item within its parent container. 891 */ 892 ACTIVE = 1, 893 /** 894 * Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation. ATK_STATE_ARMED has been deprecated since ATK-2.16 and should not be used in newly-written code. 895 */ 896 ARMED = 2, 897 /** 898 * Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed. 899 */ 900 BUSY = 3, 901 /** 902 * Indicates this object is currently checked, for instance a checkbox is 'non-empty'. 903 */ 904 CHECKED = 4, 905 /** 906 * Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed) 907 */ 908 DEFUNCT = 5, 909 /** 910 * Indicates that this object can contain text, and that the 911 * user can change the textual contents of this object by editing those contents 912 * directly. For an object which is expected to be editable due to its type, but 913 * which cannot be edited due to the application or platform preventing the user 914 * from doing so, that object's #AtkStateSet should lack ATK_STATE_EDITABLE and 915 * should contain ATK_STATE_READ_ONLY. 916 */ 917 EDITABLE = 6, 918 /** 919 * Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE 920 */ 921 ENABLED = 7, 922 /** 923 * Indicates this object allows progressive disclosure of its children 924 */ 925 EXPANDABLE = 8, 926 /** 927 * Indicates this object its expanded - see ATK_STATE_EXPANDABLE above 928 */ 929 EXPANDED = 9, 930 /** 931 * Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus 932 */ 933 FOCUSABLE = 10, 934 /** 935 * Indicates this object currently has the keyboard focus 936 */ 937 FOCUSED = 11, 938 /** 939 * Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful. 940 */ 941 HORIZONTAL = 12, 942 /** 943 * Indicates this object is minimized and is represented only by an icon 944 */ 945 ICONIFIED = 13, 946 /** 947 * Indicates something must be done with this object before the user can interact with an object in a different window 948 */ 949 MODAL = 14, 950 /** 951 * Indicates this (text) object can contain multiple lines of text 952 */ 953 MULTI_LINE = 15, 954 /** 955 * Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections. 956 */ 957 MULTISELECTABLE = 16, 958 /** 959 * Indicates this object paints every pixel within its rectangular region. 960 */ 961 OPAQUE = 17, 962 /** 963 * Indicates this object is currently pressed. 964 */ 965 PRESSED = 18, 966 /** 967 * Indicates the size of this object is not fixed 968 */ 969 RESIZABLE = 19, 970 /** 971 * Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected 972 */ 973 SELECTABLE = 20, 974 /** 975 * Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected 976 */ 977 SELECTED = 21, 978 /** 979 * Indicates this object is sensitive, e.g. to user interaction. 980 * STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, 981 * but may be found in the absence of STATE_ENABLED if the current visible state of the 982 * control is "disconnected" from the application state. In such cases, direct user interaction 983 * can often result in the object gaining STATE_SENSITIVE, for instance if a user makes 984 * an explicit selection using an object whose current state is ambiguous or undefined. 985 * @see STATE_ENABLED, STATE_INDETERMINATE. 986 */ 987 SENSITIVE = 22, 988 /** 989 * Indicates this object, the object's parent, the object's parent's parent, and so on, 990 * are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose 991 * between this object and the top of the window stack. 992 */ 993 SHOWING = 23, 994 /** 995 * Indicates this (text) object can contain only a single line of text 996 */ 997 SINGLE_LINE = 24, 998 /** 999 * Indicates that the information returned for this object may no longer be 1000 * synchronized with the application state. This is implied if the object has STATE_TRANSIENT, 1001 * and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that 1002 * the index associated with this object has changed since the user accessed the object (in lieu of 1003 * "index-in-parent-changed" events). 1004 */ 1005 STALE = 25, 1006 /** 1007 * Indicates this object is transient, i.e. a snapshot which may not emit events when its 1008 * state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no 1009 * notification given when the cached data becomes obsolete. 1010 */ 1011 TRANSIENT = 26, 1012 /** 1013 * Indicates the orientation of this object is vertical 1014 */ 1015 VERTICAL = 27, 1016 /** 1017 * Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. 1018 */ 1019 VISIBLE = 28, 1020 /** 1021 * Indicates that "active-descendant-changed" event 1022 * is sent when children become 'active' (i.e. are selected or navigated to onscreen). 1023 * Used to prevent need to enumerate all children in very large containers, like tables. 1024 * The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. 1025 * that the children should not, and need not, be enumerated by the client. 1026 * Objects implementing this state are expected to provide relevant state 1027 * notifications to listening clients, for instance notifications of visibility 1028 * changes and activation of their contained child objects, without the client 1029 * having previously requested references to those children. 1030 */ 1031 MANAGES_DESCENDANTS = 29, 1032 /** 1033 * Indicates that the value, or some other quantifiable 1034 * property, of this AtkObject cannot be fully determined. In the case of a large 1035 * data set in which the total number of items in that set is unknown (e.g. 1 of 1036 * 999+), implementors should expose the currently-known set size (999) along 1037 * with this state. In the case of a check box, this state should be used to 1038 * indicate that the check box is a tri-state check box which is currently 1039 * neither checked nor unchecked. 1040 */ 1041 INDETERMINATE = 30, 1042 /** 1043 * Indicates that an object is truncated, e.g. a text value in a speradsheet cell. 1044 */ 1045 TRUNCATED = 31, 1046 /** 1047 * Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface. 1048 */ 1049 REQUIRED = 32, 1050 /** 1051 * Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input. 1052 */ 1053 INVALID_ENTRY = 33, 1054 /** 1055 * Indicates that the object in question implements some form of ¨typeahead¨ or 1056 * pre-selection behavior whereby entering the first character of one or more sub-elements 1057 * causes those elements to scroll into view or become selected. Subsequent character input 1058 * may narrow the selection further as long as one or more sub-elements match the string. 1059 * This state is normally only useful and encountered on objects that implement Selection. 1060 * In some cases the typeahead behavior may result in full or partial ¨completion¨ of 1061 * the data in the input field, in which case these input events may trigger text-changed 1062 * events from the AtkText interface. This state supplants @ATK_ROLE_AUTOCOMPLETE. 1063 */ 1064 SUPPORTS_AUTOCOMPLETION = 34, 1065 /** 1066 * Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from @ATK_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations. 1067 */ 1068 SELECTABLE_TEXT = 35, 1069 /** 1070 * Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button. 1071 */ 1072 DEFAULT = 36, 1073 /** 1074 * Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation. 1075 * @note some applications, notably content viewers, may not be able to detect 1076 * all kinds of animated content. Therefore the absence of this state should not 1077 * be taken as definitive evidence that the object's visual representation is 1078 * static; this state is advisory. 1079 */ 1080 ANIMATED = 37, 1081 /** 1082 * Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited". 1083 */ 1084 VISITED = 38, 1085 /** 1086 * Indicates this object has the potential to be 1087 * checked, such as a checkbox or toggle-able table cell. @Since: 1088 * ATK-2.12 1089 */ 1090 CHECKABLE = 39, 1091 /** 1092 * Indicates that the object has a popup context 1093 * menu or sub-level menu which may or may not be showing. This means 1094 * that activation renders conditional content. Note that ordinary 1095 * tooltips are not considered popups in this context. @Since: ATK-2.12 1096 */ 1097 HAS_POPUP = 40, 1098 /** 1099 * Indicates this object has a tooltip. @Since: ATK-2.16 1100 */ 1101 HAS_TOOLTIP = 41, 1102 /** 1103 * Indicates that a widget which is ENABLED and SENSITIVE 1104 * has a value which can be read, but not modified, by the user. Note that this 1105 * state should only be applied to widget types whose value is normally directly 1106 * user modifiable, such as check boxes, radio buttons, spin buttons, text input 1107 * fields, and combo boxes, as a means to convey that the expected interaction 1108 * with that widget is not possible. When the expected interaction with a 1109 * widget does not include modification by the user, as is the case with 1110 * labels and containers, ATK_STATE_READ_ONLY should not be applied. See also 1111 * ATK_STATE_EDITABLE. @Since: ATK-2-16 1112 */ 1113 READ_ONLY = 42, 1114 /** 1115 * Not a valid state, used for finding end of enumeration 1116 */ 1117 LAST_DEFINED = 43, 1118 } 1119 alias AtkStateType StateType; 1120 1121 /** 1122 * Describes the text attributes supported 1123 */ 1124 public enum AtkTextAttribute 1125 { 1126 /** 1127 * Invalid attribute, like bad spelling or grammar. 1128 */ 1129 INVALID = 0, 1130 /** 1131 * The pixel width of the left margin 1132 */ 1133 LEFT_MARGIN = 1, 1134 /** 1135 * The pixel width of the right margin 1136 */ 1137 RIGHT_MARGIN = 2, 1138 /** 1139 * The number of pixels that the text is indented 1140 */ 1141 INDENT = 3, 1142 /** 1143 * Either "true" or "false" indicating whether text is visible or not 1144 */ 1145 INVISIBLE = 4, 1146 /** 1147 * Either "true" or "false" indicating whether text is editable or not 1148 */ 1149 EDITABLE = 5, 1150 /** 1151 * Pixels of blank space to leave above each newline-terminated line. 1152 */ 1153 PIXELS_ABOVE_LINES = 6, 1154 /** 1155 * Pixels of blank space to leave below each newline-terminated line. 1156 */ 1157 PIXELS_BELOW_LINES = 7, 1158 /** 1159 * Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph). 1160 */ 1161 PIXELS_INSIDE_WRAP = 8, 1162 /** 1163 * "true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character. 1164 */ 1165 BG_FULL_HEIGHT = 9, 1166 /** 1167 * Number of pixels that the characters are risen above the baseline 1168 */ 1169 RISE = 10, 1170 /** 1171 * "none", "single", "double", "low", or "error" 1172 */ 1173 UNDERLINE = 11, 1174 /** 1175 * "true" or "false" whether the text is strikethrough 1176 */ 1177 STRIKETHROUGH = 12, 1178 /** 1179 * The size of the characters in points. eg: 10 1180 */ 1181 SIZE = 13, 1182 /** 1183 * The scale of the characters. The value is a string representation of a double 1184 */ 1185 SCALE = 14, 1186 /** 1187 * The weight of the characters. 1188 */ 1189 WEIGHT = 15, 1190 /** 1191 * The language used 1192 */ 1193 LANGUAGE = 16, 1194 /** 1195 * The font family name 1196 */ 1197 FAMILY_NAME = 17, 1198 /** 1199 * The background color. The value is an RGB value of the format "%u,%u,%u" 1200 */ 1201 BG_COLOR = 18, 1202 /** 1203 * The foreground color. The value is an RGB value of the format "%u,%u,%u" 1204 */ 1205 FG_COLOR = 19, 1206 /** 1207 * "true" if a #GdkBitmap is set for stippling the background color. 1208 */ 1209 BG_STIPPLE = 20, 1210 /** 1211 * "true" if a #GdkBitmap is set for stippling the foreground color. 1212 */ 1213 FG_STIPPLE = 21, 1214 /** 1215 * The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char". 1216 */ 1217 WRAP_MODE = 22, 1218 /** 1219 * The direction of the text, if set. Values are "none", "ltr" or "rtl" 1220 */ 1221 DIRECTION = 23, 1222 /** 1223 * The justification of the text, if set. Values are "left", "right", "center" or "fill" 1224 */ 1225 JUSTIFICATION = 24, 1226 /** 1227 * The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded" 1228 */ 1229 STRETCH = 25, 1230 /** 1231 * The capitalization variant of the text, if set. Values are "normal" or "small_caps" 1232 */ 1233 VARIANT = 26, 1234 /** 1235 * The slant style of the text, if set. Values are "normal", "oblique" or "italic" 1236 */ 1237 STYLE = 27, 1238 /** 1239 * not a valid text attribute, used for finding end of enumeration 1240 */ 1241 LAST_DEFINED = 28, 1242 } 1243 alias AtkTextAttribute TextAttribute; 1244 1245 /** 1246 * Text boundary types used for specifying boundaries for regions of text. 1247 * This enumeration is deprecated since 2.9.4 and should not be used. Use 1248 * AtkTextGranularity with #atk_text_get_string_at_offset instead. 1249 */ 1250 public enum AtkTextBoundary 1251 { 1252 /** 1253 * Boundary is the boundary between characters 1254 * (including non-printing characters) 1255 */ 1256 CHAR = 0, 1257 /** 1258 * Boundary is the start (i.e. first character) of a word. 1259 */ 1260 WORD_START = 1, 1261 /** 1262 * Boundary is the end (i.e. last 1263 * character) of a word. 1264 */ 1265 WORD_END = 2, 1266 /** 1267 * Boundary is the first character in a sentence. 1268 */ 1269 SENTENCE_START = 3, 1270 /** 1271 * Boundary is the last (terminal) 1272 * character in a sentence; in languages which use "sentence stop" 1273 * punctuation such as English, the boundary is thus the '.', '?', or 1274 * similar terminal punctuation character. 1275 */ 1276 SENTENCE_END = 4, 1277 /** 1278 * Boundary is the initial character of the content or a 1279 * character immediately following a newline, linefeed, or return character. 1280 */ 1281 LINE_START = 5, 1282 /** 1283 * Boundary is the linefeed, or return 1284 * character. 1285 */ 1286 LINE_END = 6, 1287 } 1288 alias AtkTextBoundary TextBoundary; 1289 1290 /** 1291 * Describes the type of clipping required. 1292 */ 1293 public enum AtkTextClipType 1294 { 1295 /** 1296 * No clipping to be done 1297 */ 1298 NONE = 0, 1299 /** 1300 * Text clipped by min coordinate is omitted 1301 */ 1302 MIN = 1, 1303 /** 1304 * Text clipped by max coordinate is omitted 1305 */ 1306 MAX = 2, 1307 /** 1308 * Only text fully within mix/max bound is retained 1309 */ 1310 BOTH = 3, 1311 } 1312 alias AtkTextClipType TextClipType; 1313 1314 /** 1315 * Text granularity types used for specifying the granularity of the region of 1316 * text we are interested in. 1317 */ 1318 public enum AtkTextGranularity 1319 { 1320 /** 1321 * Granularity is defined by the boundaries between characters 1322 * (including non-printing characters) 1323 */ 1324 CHAR = 0, 1325 /** 1326 * Granularity is defined by the boundaries of a word, 1327 * starting at the beginning of the current word and finishing at the beginning of 1328 * the following one, if present. 1329 */ 1330 WORD = 1, 1331 /** 1332 * Granularity is defined by the boundaries of a sentence, 1333 * starting at the beginning of the current sentence and finishing at the beginning of 1334 * the following one, if present. 1335 */ 1336 SENTENCE = 2, 1337 /** 1338 * Granularity is defined by the boundaries of a line, 1339 * starting at the beginning of the current line and finishing at the beginning of 1340 * the following one, if present. 1341 */ 1342 LINE = 3, 1343 /** 1344 * Granularity is defined by the boundaries of a paragraph, 1345 * starting at the beginning of the current paragraph and finishing at the beginning of 1346 * the following one, if present. 1347 */ 1348 PARAGRAPH = 4, 1349 } 1350 alias AtkTextGranularity TextGranularity; 1351 1352 /** 1353 * Default types for a given value. Those are defined in order to 1354 * easily get localized strings to describe a given value or a given 1355 * subrange, using atk_value_type_get_localized_name(). 1356 */ 1357 public enum AtkValueType 1358 { 1359 VERY_WEAK = 0, 1360 WEAK = 1, 1361 ACCEPTABLE = 2, 1362 STRONG = 3, 1363 VERY_STRONG = 4, 1364 VERY_LOW = 5, 1365 LOW = 6, 1366 MEDIUM = 7, 1367 HIGH = 8, 1368 VERY_HIGH = 9, 1369 VERY_BAD = 10, 1370 BAD = 11, 1371 GOOD = 12, 1372 VERY_GOOD = 13, 1373 BEST = 14, 1374 LAST_DEFINED = 15, 1375 } 1376 alias AtkValueType ValueType; 1377 1378 struct AtkAction; 1379 1380 struct AtkActionIface 1381 { 1382 GTypeInterface parent; 1383 /** 1384 * 1385 * Params: 1386 * action = a #GObject instance that implements AtkActionIface 1387 * i = the action index corresponding to the action to be performed 1388 * Returns: %TRUE if success, %FALSE otherwise 1389 */ 1390 extern(C) int function(AtkAction* action, int i) doAction; 1391 /** 1392 * 1393 * Params: 1394 * action = a #GObject instance that implements AtkActionIface 1395 * Returns: a the number of actions, or 0 if @action does not 1396 * implement this interface. 1397 */ 1398 extern(C) int function(AtkAction* action) getNActions; 1399 /** 1400 * 1401 * Params: 1402 * action = a #GObject instance that implements AtkActionIface 1403 * i = the action index corresponding to the action to be performed 1404 * Returns: a description string, or %NULL if @action does 1405 * not implement this interface. 1406 */ 1407 extern(C) const(char)* function(AtkAction* action, int i) getDescription; 1408 /** 1409 * 1410 * Params: 1411 * action = a #GObject instance that implements AtkActionIface 1412 * i = the action index corresponding to the action to be performed 1413 * Returns: a name string, or %NULL if @action does not 1414 * implement this interface. 1415 */ 1416 extern(C) const(char)* function(AtkAction* action, int i) getName; 1417 /** 1418 * 1419 * Params: 1420 * action = a #GObject instance that implements AtkActionIface 1421 * i = the action index corresponding to the action to be performed 1422 * Returns: the keybinding which can be used to activate 1423 * this action, or %NULL if there is no keybinding for this action. 1424 */ 1425 extern(C) const(char)* function(AtkAction* action, int i) getKeybinding; 1426 /** 1427 * 1428 * Params: 1429 * action = a #GObject instance that implements AtkActionIface 1430 * i = the action index corresponding to the action to be performed 1431 * desc = the description to be assigned to this action 1432 * Returns: a gboolean representing if the description was successfully set; 1433 */ 1434 extern(C) int function(AtkAction* action, int i, const(char)* desc) setDescription; 1435 /** 1436 * 1437 * Params: 1438 * action = a #GObject instance that implements AtkActionIface 1439 * i = the action index corresponding to the action to be performed 1440 * Returns: a name string, or %NULL if @action does not 1441 * implement this interface. 1442 */ 1443 extern(C) const(char)* function(AtkAction* action, int i) getLocalizedName; 1444 } 1445 1446 struct AtkComponent; 1447 1448 struct AtkComponentIface 1449 { 1450 GTypeInterface parent; 1451 /** 1452 * 1453 * Params: 1454 * component = The #AtkComponent to attach the @handler to 1455 * handler = The #AtkFocusHandler to be attached to @component 1456 * Returns: a handler id which can be used in atk_component_remove_focus_handler() 1457 * or zero if the handler was already added. 1458 */ 1459 extern(C) uint function(AtkComponent* component, AtkFocusHandler handler) addFocusHandler; 1460 /** 1461 * 1462 * Params: 1463 * component = the #AtkComponent 1464 * x = x coordinate 1465 * y = y coordinate 1466 * coordType = specifies whether the coordinates are relative to the screen 1467 * or to the components top level window 1468 * Returns: %TRUE or %FALSE indicating whether the specified point is within 1469 * the extent of the @component or not 1470 */ 1471 extern(C) int function(AtkComponent* component, int x, int y, AtkCoordType coordType) contains; 1472 /** 1473 * 1474 * Params: 1475 * component = the #AtkComponent 1476 * x = x coordinate 1477 * y = y coordinate 1478 * coordType = specifies whether the coordinates are relative to the screen 1479 * or to the components top level window 1480 * Returns: a reference to the accessible 1481 * child, if one exists 1482 */ 1483 extern(C) AtkObject* function(AtkComponent* component, int x, int y, AtkCoordType coordType) refAccessibleAtPoint; 1484 /** */ 1485 extern(C) void function(AtkComponent* component, int* x, int* y, int* width, int* height, AtkCoordType coordType) getExtents; 1486 /** */ 1487 extern(C) void function(AtkComponent* component, int* x, int* y, AtkCoordType coordType) getPosition; 1488 /** */ 1489 extern(C) void function(AtkComponent* component, int* width, int* height) getSize; 1490 /** 1491 * 1492 * Params: 1493 * component = an #AtkComponent 1494 * Returns: %TRUE if successful, %FALSE otherwise. 1495 */ 1496 extern(C) int function(AtkComponent* component) grabFocus; 1497 /** */ 1498 extern(C) void function(AtkComponent* component, uint handlerId) removeFocusHandler; 1499 /** 1500 * 1501 * Params: 1502 * component = an #AtkComponent 1503 * x = x coordinate 1504 * y = y coordinate 1505 * width = width to set for @component 1506 * height = height to set for @component 1507 * coordType = specifies whether the coordinates are relative to the screen 1508 * or to the components top level window 1509 * Returns: %TRUE or %FALSE whether the extents were set or not 1510 */ 1511 extern(C) int function(AtkComponent* component, int x, int y, int width, int height, AtkCoordType coordType) setExtents; 1512 /** 1513 * 1514 * Params: 1515 * component = an #AtkComponent 1516 * x = x coordinate 1517 * y = y coordinate 1518 * coordType = specifies whether the coordinates are relative to the screen 1519 * or to the component's top level window 1520 * Returns: %TRUE or %FALSE whether or not the position was set or not 1521 */ 1522 extern(C) int function(AtkComponent* component, int x, int y, AtkCoordType coordType) setPosition; 1523 /** 1524 * 1525 * Params: 1526 * component = an #AtkComponent 1527 * width = width to set for @component 1528 * height = height to set for @component 1529 * Returns: %TRUE or %FALSE whether the size was set or not 1530 */ 1531 extern(C) int function(AtkComponent* component, int width, int height) setSize; 1532 /** 1533 * 1534 * Params: 1535 * component = an #AtkComponent 1536 * Returns: an #AtkLayer which is the layer of the component 1537 */ 1538 extern(C) AtkLayer function(AtkComponent* component) getLayer; 1539 /** 1540 * 1541 * Params: 1542 * component = an #AtkComponent 1543 * Returns: a gint which is the zorder of the component, i.e. the depth at 1544 * which the component is shown in relation to other components in the same 1545 * container. 1546 */ 1547 extern(C) int function(AtkComponent* component) getMdiZorder; 1548 /** */ 1549 extern(C) void function(AtkComponent* component, AtkRectangle* bounds) boundsChanged; 1550 /** 1551 * 1552 * Params: 1553 * component = an #AtkComponent 1554 * Returns: An alpha value from 0 to 1.0, inclusive. 1555 */ 1556 extern(C) double function(AtkComponent* component) getAlpha; 1557 /** 1558 * 1559 * Params: 1560 * component = an #AtkComponent 1561 * type = specify where the object should be made visible. 1562 * Returns: whether scrolling was successful. 1563 */ 1564 extern(C) int function(AtkComponent* component, AtkScrollType type) scrollTo; 1565 /** 1566 * 1567 * Params: 1568 * component = an #AtkComponent 1569 * coords = specify whether coordinates are relative to the screen or to the 1570 * parent object. 1571 * x = x-position where to scroll to 1572 * y = y-position where to scroll to 1573 * Returns: whether scrolling was successful. 1574 */ 1575 extern(C) int function(AtkComponent* component, AtkCoordType coords, int x, int y) scrollToPoint; 1576 } 1577 1578 struct AtkDocument; 1579 1580 struct AtkDocumentIface 1581 { 1582 GTypeInterface parent; 1583 /** 1584 * 1585 * Params: 1586 * document = a #GObject instance that implements AtkDocumentIface 1587 * Returns: a string indicating the document type 1588 */ 1589 extern(C) const(char)* function(AtkDocument* document) getDocumentType; 1590 /** 1591 * 1592 * Params: 1593 * document = a #GObject instance that implements AtkDocumentIface 1594 * Returns: a %gpointer that points to an instance of the DOM. 1595 */ 1596 extern(C) void* function(AtkDocument* document) getDocument; 1597 /** 1598 * 1599 * Params: 1600 * document = a #GObject instance that implements AtkDocumentIface 1601 * Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES 1602 * locale of the document content as a whole, or NULL if 1603 * the document content does not specify a locale. 1604 */ 1605 extern(C) const(char)* function(AtkDocument* document) getDocumentLocale; 1606 /** 1607 * 1608 * Params: 1609 * document = a #GObject instance that implements AtkDocumentIface 1610 * Returns: An AtkAttributeSet containing the explicitly 1611 * set name-value-pair attributes associated with this document 1612 * as a whole. 1613 */ 1614 extern(C) AtkAttributeSet* function(AtkDocument* document) getDocumentAttributes; 1615 /** 1616 * 1617 * Params: 1618 * document = a #GObject instance that implements AtkDocumentIface 1619 * attributeName = a character string representing the name of the attribute 1620 * whose value is being queried. 1621 * Returns: a string value associated with the named 1622 * attribute for this document, or NULL if a value for 1623 * #attribute_name has not been specified for this document. 1624 */ 1625 extern(C) const(char)* function(AtkDocument* document, const(char)* attributeName) getDocumentAttributeValue; 1626 /** 1627 * 1628 * Params: 1629 * document = a #GObject instance that implements AtkDocumentIface 1630 * attributeName = a character string representing the name of the attribute 1631 * whose value is being set. 1632 * attributeValue = a string value to be associated with #attribute_name. 1633 * Returns: TRUE if #value is successfully associated with #attribute_name 1634 * for this document, FALSE otherwise (e.g. if the document does not 1635 * allow the attribute to be modified). 1636 */ 1637 extern(C) int function(AtkDocument* document, const(char)* attributeName, const(char)* attributeValue) setDocumentAttribute; 1638 /** 1639 * 1640 * Params: 1641 * document = the #AtkDocument 1642 * Returns: current page number inside @document. -1 if not 1643 * implemented, not know by the implementor or irrelevant. 1644 */ 1645 extern(C) int function(AtkDocument* document) getCurrentPageNumber; 1646 /** 1647 * 1648 * Params: 1649 * document = the #AtkDocument 1650 * Returns: total page count of @document. -1 if not implemented, not 1651 * know by the implementor or irrelevant. 1652 */ 1653 extern(C) int function(AtkDocument* document) getPageCount; 1654 } 1655 1656 struct AtkEditableText; 1657 1658 struct AtkEditableTextIface 1659 { 1660 GTypeInterface parentInterface; 1661 /** 1662 * 1663 * Params: 1664 * text = an #AtkEditableText 1665 * attribSet = an #AtkAttributeSet 1666 * startOffset = start of range in which to set attributes 1667 * endOffset = end of range in which to set attributes 1668 * Returns: %TRUE if attributes successfully set for the specified 1669 * range, otherwise %FALSE 1670 */ 1671 extern(C) int function(AtkEditableText* text, AtkAttributeSet* attribSet, int startOffset, int endOffset) setRunAttributes; 1672 /** */ 1673 extern(C) void function(AtkEditableText* text, const(char)* string_) setTextContents; 1674 /** */ 1675 extern(C) void function(AtkEditableText* text, const(char)* string_, int length, int* position) insertText; 1676 /** */ 1677 extern(C) void function(AtkEditableText* text, int startPos, int endPos) copyText; 1678 /** */ 1679 extern(C) void function(AtkEditableText* text, int startPos, int endPos) cutText; 1680 /** */ 1681 extern(C) void function(AtkEditableText* text, int startPos, int endPos) deleteText; 1682 /** */ 1683 extern(C) void function(AtkEditableText* text, int position) pasteText; 1684 } 1685 1686 struct AtkGObjectAccessible 1687 { 1688 AtkObject parent; 1689 } 1690 1691 struct AtkGObjectAccessibleClass 1692 { 1693 AtkObjectClass parentClass; 1694 AtkFunction pad1; 1695 AtkFunction pad2; 1696 } 1697 1698 struct AtkHyperlink 1699 { 1700 GObject parent; 1701 } 1702 1703 struct AtkHyperlinkClass 1704 { 1705 GObjectClass parent; 1706 /** 1707 * 1708 * Params: 1709 * link = an #AtkHyperlink 1710 * i = a (zero-index) integer specifying the desired anchor 1711 * Returns: a string specifying the URI 1712 */ 1713 extern(C) char* function(AtkHyperlink* link, int i) getUri; 1714 /** 1715 * 1716 * Params: 1717 * link = an #AtkHyperlink 1718 * i = a (zero-index) integer specifying the desired anchor 1719 * Returns: an #AtkObject associated with this hyperlinks 1720 * i-th anchor 1721 */ 1722 extern(C) AtkObject* function(AtkHyperlink* link, int i) getObject; 1723 /** 1724 * 1725 * Params: 1726 * link = an #AtkHyperlink 1727 * Returns: the index with the hypertext document at which this link ends 1728 */ 1729 extern(C) int function(AtkHyperlink* link) getEndIndex; 1730 /** 1731 * 1732 * Params: 1733 * link = an #AtkHyperlink 1734 * Returns: the index with the hypertext document at which this link begins 1735 */ 1736 extern(C) int function(AtkHyperlink* link) getStartIndex; 1737 /** 1738 * 1739 * Params: 1740 * link = an #AtkHyperlink 1741 * Returns: whether or not this link is still valid 1742 */ 1743 extern(C) int function(AtkHyperlink* link) isValid; 1744 /** 1745 * 1746 * Params: 1747 * link = an #AtkHyperlink 1748 * Returns: the number of anchors associated with this hyperlink 1749 */ 1750 extern(C) int function(AtkHyperlink* link) getNAnchors; 1751 /** */ 1752 extern(C) uint function(AtkHyperlink* link) linkState; 1753 /** 1754 * 1755 * Params: 1756 * link = an #AtkHyperlink 1757 * Returns: True if the AtkHyperlink is selected, False otherwise 1758 */ 1759 extern(C) int function(AtkHyperlink* link) isSelectedLink; 1760 /** */ 1761 extern(C) void function(AtkHyperlink* link) linkActivated; 1762 AtkFunction pad1; 1763 } 1764 1765 struct AtkHyperlinkImpl; 1766 1767 struct AtkHyperlinkImplIface 1768 { 1769 GTypeInterface parent; 1770 /** 1771 * 1772 * Params: 1773 * impl = a #GObject instance that implements AtkHyperlinkImplIface 1774 * Returns: an AtkHyperlink object which points to this 1775 * implementing AtkObject. 1776 */ 1777 extern(C) AtkHyperlink* function(AtkHyperlinkImpl* impl) getHyperlink; 1778 } 1779 1780 struct AtkHypertext; 1781 1782 struct AtkHypertextIface 1783 { 1784 GTypeInterface parent; 1785 /** 1786 * 1787 * Params: 1788 * hypertext = an #AtkHypertext 1789 * linkIndex = an integer specifying the desired link 1790 * Returns: the link in this hypertext document at 1791 * index @link_index 1792 */ 1793 extern(C) AtkHyperlink* function(AtkHypertext* hypertext, int linkIndex) getLink; 1794 /** 1795 * 1796 * Params: 1797 * hypertext = an #AtkHypertext 1798 * Returns: the number of links within this hypertext document 1799 */ 1800 extern(C) int function(AtkHypertext* hypertext) getNLinks; 1801 /** 1802 * 1803 * Params: 1804 * hypertext = an #AtkHypertext 1805 * charIndex = a character index 1806 * Returns: an index into the array of hyperlinks in @hypertext, 1807 * or -1 if there is no hyperlink associated with this character. 1808 */ 1809 extern(C) int function(AtkHypertext* hypertext, int charIndex) getLinkIndex; 1810 /** */ 1811 extern(C) void function(AtkHypertext* hypertext, int linkIndex) linkSelected; 1812 } 1813 1814 struct AtkImage; 1815 1816 struct AtkImageIface 1817 { 1818 GTypeInterface parent; 1819 /** */ 1820 extern(C) void function(AtkImage* image, int* x, int* y, AtkCoordType coordType) getImagePosition; 1821 /** 1822 * 1823 * Params: 1824 * image = a #GObject instance that implements AtkImageIface 1825 * Returns: a string representing the image description 1826 */ 1827 extern(C) const(char)* function(AtkImage* image) getImageDescription; 1828 /** */ 1829 extern(C) void function(AtkImage* image, int* width, int* height) getImageSize; 1830 /** 1831 * 1832 * Params: 1833 * image = a #GObject instance that implements AtkImageIface 1834 * description = a string description to set for @image 1835 * Returns: boolean TRUE, or FALSE if operation could 1836 * not be completed. 1837 */ 1838 extern(C) int function(AtkImage* image, const(char)* description) setImageDescription; 1839 /** 1840 * 1841 * Params: 1842 * image = An #AtkImage 1843 * Returns: a string corresponding to the POSIX 1844 * LC_MESSAGES locale used by the image description, or %NULL if the 1845 * image does not specify a locale. 1846 */ 1847 extern(C) const(char)* function(AtkImage* image) getImageLocale; 1848 } 1849 1850 struct AtkImplementor; 1851 1852 /** 1853 * Encapsulates information about a key event. 1854 */ 1855 struct AtkKeyEventStruct 1856 { 1857 /** 1858 * An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE 1859 */ 1860 int type; 1861 /** 1862 * A bitmask representing the state of the modifier keys immediately after the event takes place. 1863 * The meaning of the bits is currently defined to match the bitmask used by GDK in 1864 * GdkEventType.state, see 1865 * http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html#GdkEventKey 1866 */ 1867 uint state; 1868 /** 1869 * A guint representing a keysym value corresponding to those used by GDK and X11: see 1870 * /usr/X11/include/keysymdef.h. 1871 */ 1872 uint keyval; 1873 /** 1874 * The length of member #string. 1875 */ 1876 int length; 1877 /** 1878 * A string containing one of the following: either a string approximating the text that would 1879 * result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress. 1880 * Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0", 1881 * "semicolon", "aacute". Keypad keys have the prefix "KP". 1882 */ 1883 char* string_; 1884 /** 1885 * The raw hardware code that generated the key event. This field is raraly useful. 1886 */ 1887 ushort keycode; 1888 /** 1889 * A timestamp in milliseconds indicating when the event occurred. 1890 * These timestamps are relative to a starting point which should be considered arbitrary, 1891 * and only used to compare the dispatch times of events to one another. 1892 */ 1893 uint timestamp; 1894 } 1895 1896 struct AtkMisc 1897 { 1898 GObject parent; 1899 } 1900 1901 /** 1902 * Usage of AtkMisc is deprecated since 2.12 and heavily discouraged. 1903 */ 1904 struct AtkMiscClass 1905 { 1906 GObjectClass parent; 1907 /** */ 1908 extern(C) void function(AtkMisc* misc) threadsEnter; 1909 /** */ 1910 extern(C) void function(AtkMisc* misc) threadsLeave; 1911 void*[32] vfuncs; 1912 } 1913 1914 struct AtkNoOpObject 1915 { 1916 AtkObject parent; 1917 } 1918 1919 struct AtkNoOpObjectClass 1920 { 1921 AtkObjectClass parentClass; 1922 } 1923 1924 struct AtkNoOpObjectFactory 1925 { 1926 AtkObjectFactory parent; 1927 } 1928 1929 struct AtkNoOpObjectFactoryClass 1930 { 1931 AtkObjectFactoryClass parentClass; 1932 } 1933 1934 struct AtkObject 1935 { 1936 GObject parent; 1937 char* description; 1938 char* name; 1939 AtkObject* accessibleParent; 1940 AtkRole role; 1941 AtkRelationSet* relationSet; 1942 AtkLayer layer; 1943 } 1944 1945 struct AtkObjectClass 1946 { 1947 GObjectClass parent; 1948 /** 1949 * 1950 * Params: 1951 * accessible = an #AtkObject 1952 * Returns: a character string representing the accessible name of the object. 1953 */ 1954 extern(C) const(char)* function(AtkObject* accessible) getName; 1955 /** 1956 * 1957 * Params: 1958 * accessible = an #AtkObject 1959 * Returns: a character string representing the accessible description 1960 * of the accessible. 1961 */ 1962 extern(C) const(char)* function(AtkObject* accessible) getDescription; 1963 /** 1964 * 1965 * Params: 1966 * accessible = an #AtkObject 1967 * Returns: an #AtkObject representing the accessible 1968 * parent of the accessible 1969 */ 1970 extern(C) AtkObject* function(AtkObject* accessible) getParent; 1971 /** */ 1972 extern(C) int function(AtkObject* accessible) getNChildren; 1973 /** */ 1974 extern(C) AtkObject* function(AtkObject* accessible, int i) refChild; 1975 /** 1976 * 1977 * Params: 1978 * accessible = an #AtkObject 1979 * Returns: an integer which is the index of the accessible in its parent 1980 */ 1981 extern(C) int function(AtkObject* accessible) getIndexInParent; 1982 /** 1983 * 1984 * Params: 1985 * accessible = an #AtkObject 1986 * Returns: an #AtkRelationSet representing the relation set 1987 * of the object. 1988 */ 1989 extern(C) AtkRelationSet* function(AtkObject* accessible) refRelationSet; 1990 /** 1991 * 1992 * Params: 1993 * accessible = an #AtkObject 1994 * Returns: an #AtkRole which is the role of the accessible 1995 */ 1996 extern(C) AtkRole function(AtkObject* accessible) getRole; 1997 /** 1998 * 1999 * Params: 2000 * accessible = an #AtkObject 2001 * Returns: an #AtkLayer which is the layer of the accessible 2002 */ 2003 extern(C) AtkLayer function(AtkObject* accessible) getLayer; 2004 /** 2005 * 2006 * Params: 2007 * accessible = an #AtkObject 2008 * Returns: a gint which is the zorder of the accessible, i.e. the depth at 2009 * which the component is shown in relation to other components in the same 2010 * container. 2011 */ 2012 extern(C) int function(AtkObject* accessible) getMdiZorder; 2013 /** 2014 * 2015 * Params: 2016 * accessible = an #AtkObject 2017 * Returns: a reference to an #AtkStateSet which is the state 2018 * set of the accessible 2019 */ 2020 extern(C) AtkStateSet* function(AtkObject* accessible) refStateSet; 2021 /** */ 2022 extern(C) void function(AtkObject* accessible, const(char)* name) setName; 2023 /** */ 2024 extern(C) void function(AtkObject* accessible, const(char)* description) setDescription; 2025 /** */ 2026 extern(C) void function(AtkObject* accessible, AtkObject* parent) setParent; 2027 /** */ 2028 extern(C) void function(AtkObject* accessible, AtkRole role) setRole; 2029 /** 2030 * 2031 * Params: 2032 * accessible = an #AtkObject 2033 * handler = a function to be called when a property changes its value 2034 * Returns: a #guint which is the handler id used in 2035 * atk_object_remove_property_change_handler() 2036 */ 2037 extern(C) uint function(AtkObject* accessible, AtkPropertyChangeHandler* handler) connectPropertyChangeHandler; 2038 /** */ 2039 extern(C) void function(AtkObject* accessible, uint handlerId) removePropertyChangeHandler; 2040 /** */ 2041 extern(C) void function(AtkObject* accessible, void* data) initialize; 2042 /** */ 2043 extern(C) void function(AtkObject* accessible, uint changeIndex, void* changedChild) childrenChanged; 2044 /** */ 2045 extern(C) void function(AtkObject* accessible, int focusIn) focusEvent; 2046 /** */ 2047 extern(C) void function(AtkObject* accessible, AtkPropertyValues* values) propertyChange; 2048 /** */ 2049 extern(C) void function(AtkObject* accessible, const(char)* name, int stateSet) stateChange; 2050 /** */ 2051 extern(C) void function(AtkObject* accessible) visibleDataChanged; 2052 /** */ 2053 extern(C) void function(AtkObject* accessible, void** child) activeDescendantChanged; 2054 /** 2055 * 2056 * Params: 2057 * accessible = An #AtkObject. 2058 * Returns: an #AtkAttributeSet consisting of all 2059 * explicit properties/annotations applied to the object, or an empty 2060 * set if the object has no name-value pair attributes assigned to 2061 * it. This #atkattributeset should be freed by a call to 2062 * atk_attribute_set_free(). 2063 */ 2064 extern(C) AtkAttributeSet* function(AtkObject* accessible) getAttributes; 2065 /** 2066 * 2067 * Params: 2068 * accessible = an #AtkObject 2069 * Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES 2070 * locale of @accessible. 2071 */ 2072 extern(C) const(char)* function(AtkObject* accessible) getObjectLocale; 2073 AtkFunction pad1; 2074 } 2075 2076 struct AtkObjectFactory 2077 { 2078 GObject parent; 2079 } 2080 2081 struct AtkObjectFactoryClass 2082 { 2083 GObjectClass parentClass; 2084 /** */ 2085 extern(C) AtkObject* function(GObject* obj) createAccessible; 2086 /** */ 2087 extern(C) void function(AtkObjectFactory* factory) invalidate; 2088 /** */ 2089 extern(C) GType function() getAccessibleType; 2090 AtkFunction pad1; 2091 AtkFunction pad2; 2092 } 2093 2094 struct AtkPlug 2095 { 2096 AtkObject parent; 2097 } 2098 2099 struct AtkPlugClass 2100 { 2101 AtkObjectClass parentClass; 2102 /** */ 2103 extern(C) char* function(AtkPlug* obj) getObjectId; 2104 } 2105 2106 /** 2107 * Note: @old_value field of #AtkPropertyValues will not contain a 2108 * valid value. This is a field defined with the purpose of contain 2109 * the previous value of the property, but is not used anymore. 2110 */ 2111 struct AtkPropertyValues 2112 { 2113 /** 2114 * The name of the ATK property which has changed. 2115 */ 2116 const(char)* propertyName; 2117 /** 2118 * NULL. This field is not used anymore. 2119 */ 2120 GValue oldValue; 2121 /** 2122 * The new value of the named property. 2123 */ 2124 GValue newValue; 2125 } 2126 2127 struct AtkRange; 2128 2129 /** 2130 * A data structure for holding a rectangle. Those coordinates are 2131 * relative to the component top-level parent. 2132 */ 2133 struct AtkRectangle 2134 { 2135 /** 2136 * X coordinate of the left side of the rectangle. 2137 */ 2138 int x; 2139 /** 2140 * Y coordinate of the top side of the rectangle. 2141 */ 2142 int y; 2143 /** 2144 * width of the rectangle. 2145 */ 2146 int width; 2147 /** 2148 * height of the rectangle. 2149 */ 2150 int height; 2151 } 2152 2153 struct AtkRegistry 2154 { 2155 GObject parent; 2156 GHashTable* factoryTypeRegistry; 2157 GHashTable* factorySingletonCache; 2158 } 2159 2160 struct AtkRegistryClass 2161 { 2162 GObjectClass parentClass; 2163 } 2164 2165 struct AtkRelation 2166 { 2167 GObject parent; 2168 GPtrArray* target; 2169 AtkRelationType relationship; 2170 } 2171 2172 struct AtkRelationClass 2173 { 2174 GObjectClass parent; 2175 } 2176 2177 struct AtkRelationSet 2178 { 2179 GObject parent; 2180 GPtrArray* relations; 2181 } 2182 2183 struct AtkRelationSetClass 2184 { 2185 GObjectClass parent; 2186 AtkFunction pad1; 2187 AtkFunction pad2; 2188 } 2189 2190 struct AtkSelection; 2191 2192 struct AtkSelectionIface 2193 { 2194 GTypeInterface parent; 2195 /** 2196 * 2197 * Params: 2198 * selection = a #GObject instance that implements AtkSelectionIface 2199 * i = a #gint specifying the child index. 2200 * Returns: TRUE if success, FALSE otherwise. 2201 */ 2202 extern(C) int function(AtkSelection* selection, int i) addSelection; 2203 /** 2204 * 2205 * Params: 2206 * selection = a #GObject instance that implements AtkSelectionIface 2207 * Returns: TRUE if success, FALSE otherwise. 2208 */ 2209 extern(C) int function(AtkSelection* selection) clearSelection; 2210 /** 2211 * 2212 * Params: 2213 * selection = a #GObject instance that implements AtkSelectionIface 2214 * i = a #gint specifying the index in the selection set. (e.g. the 2215 * ith selection as opposed to the ith child). 2216 * Returns: an #AtkObject representing the 2217 * selected accessible, or %NULL if @selection does not implement this 2218 * interface. 2219 */ 2220 extern(C) AtkObject* function(AtkSelection* selection, int i) refSelection; 2221 /** 2222 * 2223 * Params: 2224 * selection = a #GObject instance that implements AtkSelectionIface 2225 * Returns: a gint representing the number of items selected, or 0 2226 * if @selection does not implement this interface. 2227 */ 2228 extern(C) int function(AtkSelection* selection) getSelectionCount; 2229 /** 2230 * 2231 * Params: 2232 * selection = a #GObject instance that implements AtkSelectionIface 2233 * i = a #gint specifying the child index. 2234 * Returns: a gboolean representing the specified child is selected, or 0 2235 * if @selection does not implement this interface. 2236 */ 2237 extern(C) int function(AtkSelection* selection, int i) isChildSelected; 2238 /** 2239 * 2240 * Params: 2241 * selection = a #GObject instance that implements AtkSelectionIface 2242 * i = a #gint specifying the index in the selection set. (e.g. the 2243 * ith selection as opposed to the ith child). 2244 * Returns: TRUE if success, FALSE otherwise. 2245 */ 2246 extern(C) int function(AtkSelection* selection, int i) removeSelection; 2247 /** 2248 * 2249 * Params: 2250 * selection = a #GObject instance that implements AtkSelectionIface 2251 * Returns: TRUE if success, FALSE otherwise. 2252 */ 2253 extern(C) int function(AtkSelection* selection) selectAllSelection; 2254 /** */ 2255 extern(C) void function(AtkSelection* selection) selectionChanged; 2256 } 2257 2258 struct AtkSocket 2259 { 2260 AtkObject parent; 2261 char* embeddedPlugId; 2262 } 2263 2264 struct AtkSocketClass 2265 { 2266 AtkObjectClass parentClass; 2267 /** */ 2268 extern(C) void function(AtkSocket* obj, char* plugId) embed; 2269 } 2270 2271 struct AtkStateSet 2272 { 2273 GObject parent; 2274 } 2275 2276 struct AtkStateSetClass 2277 { 2278 GObjectClass parent; 2279 } 2280 2281 struct AtkStreamableContent; 2282 2283 struct AtkStreamableContentIface 2284 { 2285 GTypeInterface parent; 2286 /** 2287 * 2288 * Params: 2289 * streamable = a GObject instance that implements AtkStreamableContentIface 2290 * Returns: a gint which is the number of mime types supported by the object. 2291 */ 2292 extern(C) int function(AtkStreamableContent* streamable) getNMimeTypes; 2293 /** 2294 * 2295 * Params: 2296 * streamable = a GObject instance that implements AtkStreamableContent 2297 * i = a gint representing the position of the mime type starting from 0 2298 * Returns: a gchar* representing the specified mime type; the caller 2299 * should not free the character string. 2300 */ 2301 extern(C) const(char)* function(AtkStreamableContent* streamable, int i) getMimeType; 2302 /** 2303 * 2304 * Params: 2305 * streamable = a GObject instance that implements AtkStreamableContentIface 2306 * mimeType = a gchar* representing the mime type 2307 * Returns: A #GIOChannel which contains the content in the 2308 * specified mime type. 2309 */ 2310 extern(C) GIOChannel* function(AtkStreamableContent* streamable, const(char)* mimeType) getStream; 2311 /** 2312 * 2313 * Params: 2314 * streamable = a GObject instance that implements AtkStreamableContentIface 2315 * mimeType = a gchar* representing the mime type, or NULL to request a URI 2316 * for the default mime type. 2317 * Returns: Returns a string representing a URI, or %NULL 2318 * if no corresponding URI can be constructed. 2319 */ 2320 extern(C) const(char)* function(AtkStreamableContent* streamable, const(char)* mimeType) getUri; 2321 AtkFunction pad1; 2322 AtkFunction pad2; 2323 AtkFunction pad3; 2324 } 2325 2326 struct AtkTable; 2327 2328 struct AtkTableCell; 2329 2330 struct AtkTableCellIface 2331 { 2332 GTypeInterface parent; 2333 /** 2334 * 2335 * Params: 2336 * cell = a GObject instance that implements AtkTableCellIface 2337 * Returns: a gint representing the number of columns occupied by this cell, 2338 * or 0 if the cell does not implement this method. 2339 */ 2340 extern(C) int function(AtkTableCell* cell) getColumnSpan; 2341 /** 2342 * 2343 * Params: 2344 * cell = a GObject instance that implements AtkTableCellIface 2345 * Returns: a GPtrArray of AtkObjects 2346 * representing the column header cells. 2347 */ 2348 extern(C) GPtrArray* function(AtkTableCell* cell) getColumnHeaderCells; 2349 /** 2350 * 2351 * Params: 2352 * cell = a GObject instance that implements AtkTableCellIface 2353 * row = the row of the given cell. 2354 * column = the column of the given cell. 2355 * Returns: TRUE if successful; FALSE otherwise. 2356 */ 2357 extern(C) int function(AtkTableCell* cell, int* row, int* column) getPosition; 2358 /** 2359 * 2360 * Params: 2361 * cell = a GObject instance that implements AtkTableCellIface 2362 * Returns: a gint representing the number of rows occupied by this cell, 2363 * or 0 if the cell does not implement this method. 2364 */ 2365 extern(C) int function(AtkTableCell* cell) getRowSpan; 2366 /** 2367 * 2368 * Params: 2369 * cell = a GObject instance that implements AtkTableCellIface 2370 * Returns: a GPtrArray of AtkObjects 2371 * representing the row header cells. 2372 */ 2373 extern(C) GPtrArray* function(AtkTableCell* cell) getRowHeaderCells; 2374 /** 2375 * 2376 * Params: 2377 * cell = a GObject instance that implements AtkTableCellIface 2378 * row = the row index of the given cell. 2379 * column = the column index of the given cell. 2380 * rowSpan = the number of rows occupied by this cell. 2381 * columnSpan = the number of columns occupied by this cell. 2382 * Returns: TRUE if successful; FALSE otherwise. 2383 */ 2384 extern(C) int function(AtkTableCell* cell, int* row, int* column, int* rowSpan, int* columnSpan) getRowColumnSpan; 2385 /** 2386 * 2387 * Params: 2388 * cell = a GObject instance that implements AtkTableCellIface 2389 * Returns: the atk object for the containing table. 2390 */ 2391 extern(C) AtkObject* function(AtkTableCell* cell) getTable; 2392 } 2393 2394 struct AtkTableIface 2395 { 2396 GTypeInterface parent; 2397 /** 2398 * 2399 * Params: 2400 * table = a GObject instance that implements AtkTableIface 2401 * row = a #gint representing a row in @table 2402 * column = a #gint representing a column in @table 2403 * Returns: an #AtkObject representing the referred 2404 * to accessible 2405 */ 2406 extern(C) AtkObject* function(AtkTable* table, int row, int column) refAt; 2407 /** 2408 * 2409 * Params: 2410 * table = a GObject instance that implements AtkTableIface 2411 * row = a #gint representing a row in @table 2412 * column = a #gint representing a column in @table 2413 * Returns: a #gint representing the index at specified position. 2414 * The value -1 is returned if the object at row,column is not a child 2415 * of table or table does not implement this interface. 2416 */ 2417 extern(C) int function(AtkTable* table, int row, int column) getIndexAt; 2418 /** 2419 * 2420 * Params: 2421 * table = a GObject instance that implements AtkTableInterface 2422 * index = a #gint representing an index in @table 2423 * Returns: a gint representing the column at the specified index, 2424 * or -1 if the table does not implement this method. 2425 */ 2426 extern(C) int function(AtkTable* table, int index) getColumnAtIndex; 2427 /** 2428 * 2429 * Params: 2430 * table = a GObject instance that implements AtkTableInterface 2431 * index = a #gint representing an index in @table 2432 * Returns: a gint representing the row at the specified index, 2433 * or -1 if the table does not implement this method. 2434 */ 2435 extern(C) int function(AtkTable* table, int index) getRowAtIndex; 2436 /** 2437 * 2438 * Params: 2439 * table = a GObject instance that implements AtkTableIface 2440 * Returns: a gint representing the number of columns, or 0 2441 * if value does not implement this interface. 2442 */ 2443 extern(C) int function(AtkTable* table) getNColumns; 2444 /** 2445 * 2446 * Params: 2447 * table = a GObject instance that implements AtkTableIface 2448 * Returns: a gint representing the number of rows, or 0 2449 * if value does not implement this interface. 2450 */ 2451 extern(C) int function(AtkTable* table) getNRows; 2452 /** 2453 * 2454 * Params: 2455 * table = a GObject instance that implements AtkTableIface 2456 * row = a #gint representing a row in @table 2457 * column = a #gint representing a column in @table 2458 * Returns: a gint representing the column extent at specified position, or 0 2459 * if value does not implement this interface. 2460 */ 2461 extern(C) int function(AtkTable* table, int row, int column) getColumnExtentAt; 2462 /** 2463 * 2464 * Params: 2465 * table = a GObject instance that implements AtkTableIface 2466 * row = a #gint representing a row in @table 2467 * column = a #gint representing a column in @table 2468 * Returns: a gint representing the row extent at specified position, or 0 2469 * if value does not implement this interface. 2470 */ 2471 extern(C) int function(AtkTable* table, int row, int column) getRowExtentAt; 2472 /** 2473 * 2474 * Params: 2475 * table = a GObject instance that implements AtkTableInterface 2476 * Returns: a AtkObject* representing the 2477 * table caption, or %NULL if value does not implement this interface. 2478 */ 2479 extern(C) AtkObject* function(AtkTable* table) getCaption; 2480 /** 2481 * 2482 * Params: 2483 * table = a GObject instance that implements AtkTableIface 2484 * column = a #gint representing a column in @table 2485 * Returns: a gchar* representing the column description, or %NULL 2486 * if value does not implement this interface. 2487 */ 2488 extern(C) const(char)* function(AtkTable* table, int column) getColumnDescription; 2489 /** 2490 * 2491 * Params: 2492 * table = a GObject instance that implements AtkTableIface 2493 * column = a #gint representing a column in the table 2494 * Returns: a AtkObject* representing the 2495 * specified column header, or %NULL if value does not implement this 2496 * interface. 2497 */ 2498 extern(C) AtkObject* function(AtkTable* table, int column) getColumnHeader; 2499 /** 2500 * 2501 * Params: 2502 * table = a GObject instance that implements AtkTableIface 2503 * row = a #gint representing a row in @table 2504 * Returns: a gchar* representing the row description, or 2505 * %NULL if value does not implement this interface. 2506 */ 2507 extern(C) const(char)* function(AtkTable* table, int row) getRowDescription; 2508 /** 2509 * 2510 * Params: 2511 * table = a GObject instance that implements AtkTableIface 2512 * row = a #gint representing a row in the table 2513 * Returns: a AtkObject* representing the 2514 * specified row header, or %NULL if value does not implement this 2515 * interface. 2516 */ 2517 extern(C) AtkObject* function(AtkTable* table, int row) getRowHeader; 2518 /** 2519 * 2520 * Params: 2521 * table = a GObject instance that implements AtkTableIface 2522 * Returns: a AtkObject* representing a summary description 2523 * of the table, or zero if value does not implement this interface. 2524 */ 2525 extern(C) AtkObject* function(AtkTable* table) getSummary; 2526 /** */ 2527 extern(C) void function(AtkTable* table, AtkObject* caption) setCaption; 2528 /** */ 2529 extern(C) void function(AtkTable* table, int column, const(char)* description) setColumnDescription; 2530 /** */ 2531 extern(C) void function(AtkTable* table, int column, AtkObject* header) setColumnHeader; 2532 /** */ 2533 extern(C) void function(AtkTable* table, int row, const(char)* description) setRowDescription; 2534 /** */ 2535 extern(C) void function(AtkTable* table, int row, AtkObject* header) setRowHeader; 2536 /** */ 2537 extern(C) void function(AtkTable* table, AtkObject* accessible) setSummary; 2538 /** 2539 * 2540 * Params: 2541 * table = a GObject instance that implements AtkTableIface 2542 * selected = a #gint** that is to contain the selected columns numbers 2543 * Returns: a gint representing the number of selected columns, 2544 * or %0 if value does not implement this interface. 2545 */ 2546 extern(C) int function(AtkTable* table, int** selected) getSelectedColumns; 2547 /** 2548 * 2549 * Params: 2550 * table = a GObject instance that implements AtkTableIface 2551 * selected = a #gint** that is to contain the selected row numbers 2552 * Returns: a gint representing the number of selected rows, 2553 * or zero if value does not implement this interface. 2554 */ 2555 extern(C) int function(AtkTable* table, int** selected) getSelectedRows; 2556 /** 2557 * 2558 * Params: 2559 * table = a GObject instance that implements AtkTableIface 2560 * column = a #gint representing a column in @table 2561 * Returns: a gboolean representing if the column is selected, or 0 2562 * if value does not implement this interface. 2563 */ 2564 extern(C) int function(AtkTable* table, int column) isColumnSelected; 2565 /** 2566 * 2567 * Params: 2568 * table = a GObject instance that implements AtkTableIface 2569 * row = a #gint representing a row in @table 2570 * Returns: a gboolean representing if the row is selected, or 0 2571 * if value does not implement this interface. 2572 */ 2573 extern(C) int function(AtkTable* table, int row) isRowSelected; 2574 /** 2575 * 2576 * Params: 2577 * table = a GObject instance that implements AtkTableIface 2578 * row = a #gint representing a row in @table 2579 * column = a #gint representing a column in @table 2580 * Returns: a gboolean representing if the cell is selected, or 0 2581 * if value does not implement this interface. 2582 */ 2583 extern(C) int function(AtkTable* table, int row, int column) isSelected; 2584 /** 2585 * 2586 * Params: 2587 * table = a GObject instance that implements AtkTableIface 2588 * row = a #gint representing a row in @table 2589 * Returns: a gboolean representing if row was successfully added to selection, 2590 * or 0 if value does not implement this interface. 2591 */ 2592 extern(C) int function(AtkTable* table, int row) addRowSelection; 2593 /** 2594 * 2595 * Params: 2596 * table = a GObject instance that implements AtkTableIface 2597 * row = a #gint representing a row in @table 2598 * Returns: a gboolean representing if the row was successfully removed from 2599 * the selection, or 0 if value does not implement this interface. 2600 */ 2601 extern(C) int function(AtkTable* table, int row) removeRowSelection; 2602 /** 2603 * 2604 * Params: 2605 * table = a GObject instance that implements AtkTableIface 2606 * column = a #gint representing a column in @table 2607 * Returns: a gboolean representing if the column was successfully added to 2608 * the selection, or 0 if value does not implement this interface. 2609 */ 2610 extern(C) int function(AtkTable* table, int column) addColumnSelection; 2611 /** 2612 * 2613 * Params: 2614 * table = a GObject instance that implements AtkTableIface 2615 * column = a #gint representing a column in @table 2616 * Returns: a gboolean representing if the column was successfully removed from 2617 * the selection, or 0 if value does not implement this interface. 2618 */ 2619 extern(C) int function(AtkTable* table, int column) removeColumnSelection; 2620 /** */ 2621 extern(C) void function(AtkTable* table, int row, int numInserted) rowInserted; 2622 /** */ 2623 extern(C) void function(AtkTable* table, int column, int numInserted) columnInserted; 2624 /** */ 2625 extern(C) void function(AtkTable* table, int row, int numDeleted) rowDeleted; 2626 /** */ 2627 extern(C) void function(AtkTable* table, int column, int numDeleted) columnDeleted; 2628 /** */ 2629 extern(C) void function(AtkTable* table) rowReordered; 2630 /** */ 2631 extern(C) void function(AtkTable* table) columnReordered; 2632 /** */ 2633 extern(C) void function(AtkTable* table) modelChanged; 2634 } 2635 2636 struct AtkText; 2637 2638 struct AtkTextIface 2639 { 2640 GTypeInterface parent; 2641 /** 2642 * 2643 * Params: 2644 * text = an #AtkText 2645 * startOffset = a starting character offset within @text 2646 * endOffset = an ending character offset within @text, or -1 for the end of the string. 2647 * Returns: a newly allocated string containing the text from @start_offset up 2648 * to, but not including @end_offset. Use g_free() to free the returned 2649 * string. 2650 */ 2651 extern(C) char* function(AtkText* text, int startOffset, int endOffset) getText; 2652 /** 2653 * 2654 * Params: 2655 * text = an #AtkText 2656 * offset = position 2657 * boundaryType = An #AtkTextBoundary 2658 * startOffset = the starting character offset of the returned string 2659 * endOffset = the offset of the first character after the 2660 * returned substring 2661 * Returns: a newly allocated string containing the text after @offset bounded 2662 * by the specified @boundary_type. Use g_free() to free the returned 2663 * string. 2664 */ 2665 extern(C) char* function(AtkText* text, int offset, AtkTextBoundary boundaryType, int* startOffset, int* endOffset) getTextAfterOffset; 2666 /** 2667 * 2668 * Params: 2669 * text = an #AtkText 2670 * offset = position 2671 * boundaryType = An #AtkTextBoundary 2672 * startOffset = the starting character offset of the returned string 2673 * endOffset = the offset of the first character after the 2674 * returned substring 2675 * Returns: a newly allocated string containing the text at @offset bounded 2676 * by the specified @boundary_type. Use g_free() to free the returned 2677 * string. 2678 */ 2679 extern(C) char* function(AtkText* text, int offset, AtkTextBoundary boundaryType, int* startOffset, int* endOffset) getTextAtOffset; 2680 /** 2681 * 2682 * Params: 2683 * text = an #AtkText 2684 * offset = a character offset within @text 2685 * Returns: the character at @offset or 0 in the case of failure. 2686 */ 2687 extern(C) dchar function(AtkText* text, int offset) getCharacterAtOffset; 2688 /** 2689 * 2690 * Params: 2691 * text = an #AtkText 2692 * offset = position 2693 * boundaryType = An #AtkTextBoundary 2694 * startOffset = the starting character offset of the returned string 2695 * endOffset = the offset of the first character after the 2696 * returned substring 2697 * Returns: a newly allocated string containing the text before @offset bounded 2698 * by the specified @boundary_type. Use g_free() to free the returned 2699 * string. 2700 */ 2701 extern(C) char* function(AtkText* text, int offset, AtkTextBoundary boundaryType, int* startOffset, int* endOffset) getTextBeforeOffset; 2702 /** 2703 * 2704 * Params: 2705 * text = an #AtkText 2706 * Returns: the character offset of the position of the caret or 0 if 2707 * the caret is not located inside the element or in the case of 2708 * any other failure. 2709 */ 2710 extern(C) int function(AtkText* text) getCaretOffset; 2711 /** 2712 * 2713 * Params: 2714 * text = an #AtkText 2715 * offset = the character offset at which to get the attributes, -1 means the offset of 2716 * the character to be inserted at the caret location. 2717 * startOffset = the address to put the start offset of the range 2718 * endOffset = the address to put the end offset of the range 2719 * Returns: an #AtkAttributeSet which contains the attributes 2720 * explicitly set at @offset. This #AtkAttributeSet should be freed by 2721 * a call to atk_attribute_set_free(). 2722 */ 2723 extern(C) AtkAttributeSet* function(AtkText* text, int offset, int* startOffset, int* endOffset) getRunAttributes; 2724 /** 2725 * 2726 * Params: 2727 * text = an #AtkText 2728 * Returns: an #AtkAttributeSet which contains the default values 2729 * of attributes. at @offset. this #atkattributeset should be freed by 2730 * a call to atk_attribute_set_free(). 2731 */ 2732 extern(C) AtkAttributeSet* function(AtkText* text) getDefaultAttributes; 2733 /** */ 2734 extern(C) void function(AtkText* text, int offset, int* x, int* y, int* width, int* height, AtkCoordType coords) getCharacterExtents; 2735 /** 2736 * 2737 * Params: 2738 * text = an #AtkText 2739 * Returns: the number of characters or -1 in case of failure. 2740 */ 2741 extern(C) int function(AtkText* text) getCharacterCount; 2742 /** 2743 * 2744 * Params: 2745 * text = an #AtkText 2746 * x = screen x-position of character 2747 * y = screen y-position of character 2748 * coords = specify whether coordinates are relative to the screen or 2749 * widget window 2750 * Returns: the offset to the character which is located at the specified 2751 * @x and @y coordinates of -1 in case of failure. 2752 */ 2753 extern(C) int function(AtkText* text, int x, int y, AtkCoordType coords) getOffsetAtPoint; 2754 /** 2755 * 2756 * Params: 2757 * text = an #AtkText 2758 * Returns: The number of selected regions, or -1 in the case of failure. 2759 */ 2760 extern(C) int function(AtkText* text) getNSelections; 2761 /** 2762 * 2763 * Params: 2764 * text = an #AtkText 2765 * selectionNum = The selection number. The selected regions are 2766 * assigned numbers that correspond to how far the region is from the 2767 * start of the text. The selected region closest to the beginning 2768 * of the text region is assigned the number 0, etc. Note that adding, 2769 * moving or deleting a selected region can change the numbering. 2770 * startOffset = passes back the starting character offset of the selected region 2771 * endOffset = passes back the ending character offset (offset immediately past) 2772 * of the selected region 2773 * Returns: a newly allocated string containing the selected text. Use g_free() 2774 * to free the returned string. 2775 */ 2776 extern(C) char* function(AtkText* text, int selectionNum, int* startOffset, int* endOffset) getSelection; 2777 /** 2778 * 2779 * Params: 2780 * text = an #AtkText 2781 * startOffset = the starting character offset of the selected region 2782 * endOffset = the offset of the first character after the selected region. 2783 * Returns: %TRUE if successful, %FALSE otherwise 2784 */ 2785 extern(C) int function(AtkText* text, int startOffset, int endOffset) addSelection; 2786 /** 2787 * 2788 * Params: 2789 * text = an #AtkText 2790 * selectionNum = The selection number. The selected regions are 2791 * assigned numbers that correspond to how far the region is from the 2792 * start of the text. The selected region closest to the beginning 2793 * of the text region is assigned the number 0, etc. Note that adding, 2794 * moving or deleting a selected region can change the numbering. 2795 * Returns: %TRUE if successful, %FALSE otherwise 2796 */ 2797 extern(C) int function(AtkText* text, int selectionNum) removeSelection; 2798 /** 2799 * 2800 * Params: 2801 * text = an #AtkText 2802 * selectionNum = The selection number. The selected regions are 2803 * assigned numbers that correspond to how far the region is from the 2804 * start of the text. The selected region closest to the beginning 2805 * of the text region is assigned the number 0, etc. Note that adding, 2806 * moving or deleting a selected region can change the numbering. 2807 * startOffset = the new starting character offset of the selection 2808 * endOffset = the new end position of (e.g. offset immediately past) 2809 * the selection 2810 * Returns: %TRUE if successful, %FALSE otherwise 2811 */ 2812 extern(C) int function(AtkText* text, int selectionNum, int startOffset, int endOffset) setSelection; 2813 /** 2814 * 2815 * Params: 2816 * text = an #AtkText 2817 * offset = the character offset of the new caret position 2818 * Returns: %TRUE if successful, %FALSE otherwise. 2819 */ 2820 extern(C) int function(AtkText* text, int offset) setCaretOffset; 2821 /** */ 2822 extern(C) void function(AtkText* text, int position, int length) textChanged; 2823 /** */ 2824 extern(C) void function(AtkText* text, int location) textCaretMoved; 2825 /** */ 2826 extern(C) void function(AtkText* text) textSelectionChanged; 2827 /** */ 2828 extern(C) void function(AtkText* text) textAttributesChanged; 2829 /** */ 2830 extern(C) void function(AtkText* text, int startOffset, int endOffset, AtkCoordType coordType, AtkTextRectangle* rect) getRangeExtents; 2831 /** 2832 * 2833 * Params: 2834 * text = an #AtkText 2835 * rect = An AtkTextRectangle giving the dimensions of the bounding box. 2836 * coordType = Specify whether coordinates are relative to the screen or widget window. 2837 * xClipType = Specify the horizontal clip type. 2838 * yClipType = Specify the vertical clip type. 2839 * Returns: Array of AtkTextRange. The last 2840 * element of the array returned by this function will be NULL. 2841 */ 2842 extern(C) AtkTextRange** function(AtkText* text, AtkTextRectangle* rect, AtkCoordType coordType, AtkTextClipType xClipType, AtkTextClipType yClipType) getBoundedRanges; 2843 /** 2844 * 2845 * Params: 2846 * text = an #AtkText 2847 * offset = position 2848 * granularity = An #AtkTextGranularity 2849 * startOffset = the starting character offset of the returned string, or -1 2850 * in the case of error (e.g. invalid offset, not implemented) 2851 * endOffset = the offset of the first character after the returned string, 2852 * or -1 in the case of error (e.g. invalid offset, not implemented) 2853 * Returns: a newly allocated string containing the text at 2854 * the @offset bounded by the specified @granularity. Use g_free() 2855 * to free the returned string. Returns %NULL if the offset is invalid 2856 * or no implementation is available. 2857 */ 2858 extern(C) char* function(AtkText* text, int offset, AtkTextGranularity granularity, int* startOffset, int* endOffset) getStringAtOffset; 2859 /** 2860 * 2861 * Params: 2862 * text = an #AtkText 2863 * startOffset = start position 2864 * endOffset = end position, or -1 for the end of the string. 2865 * type = specify where the object should be made visible. 2866 * Returns: whether scrolling was successful. 2867 */ 2868 extern(C) int function(AtkText* text, int startOffset, int endOffset, AtkScrollType type) scrollSubstringTo; 2869 /** 2870 * 2871 * Params: 2872 * text = an #AtkText 2873 * startOffset = start position 2874 * endOffset = end position, or -1 for the end of the string. 2875 * coords = specify whether coordinates are relative to the screen or to the 2876 * parent object. 2877 * x = x-position where to scroll to 2878 * y = y-position where to scroll to 2879 * Returns: whether scrolling was successful. 2880 */ 2881 extern(C) int function(AtkText* text, int startOffset, int endOffset, AtkCoordType coords, int x, int y) scrollSubstringToPoint; 2882 } 2883 2884 /** 2885 * A structure used to describe a text range. 2886 */ 2887 struct AtkTextRange 2888 { 2889 /** 2890 * A rectangle giving the bounds of the text range 2891 */ 2892 AtkTextRectangle bounds; 2893 /** 2894 * The start offset of a AtkTextRange 2895 */ 2896 int startOffset; 2897 /** 2898 * The end offset of a AtkTextRange 2899 */ 2900 int endOffset; 2901 /** 2902 * The text in the text range 2903 */ 2904 char* content; 2905 } 2906 2907 /** 2908 * A structure used to store a rectangle used by AtkText. 2909 */ 2910 struct AtkTextRectangle 2911 { 2912 /** 2913 * The horizontal coordinate of a rectangle 2914 */ 2915 int x; 2916 /** 2917 * The vertical coordinate of a rectangle 2918 */ 2919 int y; 2920 /** 2921 * The width of a rectangle 2922 */ 2923 int width; 2924 /** 2925 * The height of a rectangle 2926 */ 2927 int height; 2928 } 2929 2930 /** 2931 * A set of ATK utility functions which are used to support event 2932 * registration of various types, and obtaining the 'root' accessible 2933 * of a process and information about the current ATK implementation 2934 * and toolkit version. 2935 */ 2936 struct AtkUtil 2937 { 2938 GObject parent; 2939 } 2940 2941 struct AtkUtilClass 2942 { 2943 GObjectClass parent; 2944 /** */ 2945 extern(C) uint function(GSignalEmissionHook listener, const(char)* eventType) addGlobalEventListener; 2946 /** */ 2947 extern(C) void function(uint listenerId) removeGlobalEventListener; 2948 /** */ 2949 extern(C) uint function(AtkKeySnoopFunc listener, void* data) addKeyEventListener; 2950 /** */ 2951 extern(C) void function(uint listenerId) removeKeyEventListener; 2952 /** */ 2953 extern(C) AtkObject* function() getRoot; 2954 /** */ 2955 extern(C) const(char)* function() getToolkitName; 2956 /** */ 2957 extern(C) const(char)* function() getToolkitVersion; 2958 } 2959 2960 struct AtkValue; 2961 2962 struct AtkValueIface 2963 { 2964 GTypeInterface parent; 2965 /** */ 2966 extern(C) void function(AtkValue* obj, GValue* value) getCurrentValue; 2967 /** */ 2968 extern(C) void function(AtkValue* obj, GValue* value) getMaximumValue; 2969 /** */ 2970 extern(C) void function(AtkValue* obj, GValue* value) getMinimumValue; 2971 /** 2972 * 2973 * Params: 2974 * obj = a GObject instance that implements AtkValueIface 2975 * value = a #GValue which is the desired new accessible value. 2976 * Returns: %TRUE if new value is successfully set, %FALSE otherwise. 2977 */ 2978 extern(C) int function(AtkValue* obj, GValue* value) setCurrentValue; 2979 /** */ 2980 extern(C) void function(AtkValue* obj, GValue* value) getMinimumIncrement; 2981 /** */ 2982 extern(C) void function(AtkValue* obj, double* value, char** text) getValueAndText; 2983 /** 2984 * 2985 * Params: 2986 * obj = a GObject instance that implements AtkValueIface 2987 * Returns: a newly allocated #AtkRange 2988 * that represents the minimum, maximum and descriptor (if available) 2989 * of @obj. NULL if that range is not defined. 2990 */ 2991 extern(C) AtkRange* function(AtkValue* obj) getRange; 2992 /** 2993 * 2994 * Params: 2995 * obj = a GObject instance that implements AtkValueIface 2996 * Returns: the minimum increment by which the value of this 2997 * object may be changed. zero if undefined. 2998 */ 2999 extern(C) double function(AtkValue* obj) getIncrement; 3000 /** 3001 * 3002 * Params: 3003 * obj = a GObject instance that implements AtkValueIface 3004 * Returns: an #GSList of 3005 * #AtkRange which each of the subranges defined for this object. Free 3006 * the returns list with g_slist_free(). 3007 */ 3008 extern(C) GSList* function(AtkValue* obj) getSubRanges; 3009 /** */ 3010 extern(C) void function(AtkValue* obj, double newValue) setValue; 3011 } 3012 3013 struct AtkWindow; 3014 3015 struct AtkWindowIface 3016 { 3017 GTypeInterface parent; 3018 } 3019 3020 /** 3021 * A function which is called when an object emits a matching event, 3022 * as used in #atk_add_focus_tracker. 3023 * Currently the only events for which object-specific handlers are 3024 * supported are events of type "focus:". Most clients of ATK will prefer to 3025 * attach signal handlers for the various ATK signals instead. 3026 * 3027 * see atk_add_focus_tracker. 3028 * 3029 * Params: 3030 * obj = An #AtkObject instance for whom the callback will be called when 3031 * the specified event (e.g. 'focus:') takes place. 3032 */ 3033 public alias extern(C) void function(AtkObject* obj) AtkEventListener; 3034 3035 /** 3036 * An #AtkEventListenerInit function is a special function that is 3037 * called in order to initialize the per-object event registration system 3038 * used by #AtkEventListener, if any preparation is required. 3039 * 3040 * see atk_focus_tracker_init. 3041 */ 3042 public alias extern(C) void function() AtkEventListenerInit; 3043 3044 /** 3045 * The type of callback function used for 3046 * atk_component_add_focus_handler() and 3047 * atk_component_remove_focus_handler() 3048 * 3049 * Deprecated: Deprecated with atk_component_add_focus_handler() 3050 * and atk_component_remove_focus_handler(). See those 3051 * methods for more information. 3052 * 3053 * Params: 3054 * object = the #AtkObject that receives/lose the focus 3055 * focusIn = TRUE if the object receives the focus 3056 */ 3057 public alias extern(C) void function(AtkObject* object, int focusIn) AtkFocusHandler; 3058 3059 /** 3060 * An AtkFunction is a function definition used for padding which has 3061 * been added to class and interface structures to allow for expansion 3062 * in the future. 3063 * 3064 * Params: 3065 * userData = custom data defined by the user 3066 * 3067 * Returns: not used 3068 */ 3069 public alias extern(C) int function(void* userData) AtkFunction; 3070 3071 /** 3072 * An #AtkKeySnoopFunc is a type of callback which is called whenever a key event occurs, 3073 * if registered via atk_add_key_event_listener. It allows for pre-emptive 3074 * interception of key events via the return code as described below. 3075 * 3076 * Params: 3077 * event = an AtkKeyEventStruct containing information about the key event for which 3078 * notification is being given. 3079 * userData = a block of data which will be passed to the event listener, on notification. 3080 * 3081 * Returns: TRUE (nonzero) if the event emission should be stopped and the event 3082 * discarded without being passed to the normal GUI recipient; FALSE (zero) if the 3083 * event dispatch to the client application should proceed as normal. 3084 * 3085 * see atk_add_key_event_listener. 3086 */ 3087 public alias extern(C) int function(AtkKeyEventStruct* event, void* userData) AtkKeySnoopFunc; 3088 3089 /** 3090 * An AtkPropertyChangeHandler is a function which is executed when an 3091 * AtkObject's property changes value. It is specified in a call to 3092 * atk_object_connect_property_change_handler(). 3093 * 3094 * Deprecated: Since 2.12. 3095 * 3096 * Params: 3097 * obj = atkobject which property changes 3098 * vals = values changed 3099 */ 3100 public alias extern(C) void function(AtkObject* obj, AtkPropertyValues* vals) AtkPropertyChangeHandler; 3101 3102 /** 3103 * Like atk_get_binary_age(), but from the headers used at 3104 * application compile time, rather than from the library linked 3105 * against at application run time. 3106 */ 3107 enum BINARY_AGE = 23210; 3108 alias ATK_BINARY_AGE = BINARY_AGE; 3109 3110 /** 3111 * Like atk_get_interface_age(), but from the headers used at 3112 * application compile time, rather than from the library linked 3113 * against at application run time. 3114 */ 3115 enum INTERFACE_AGE = 1; 3116 alias ATK_INTERFACE_AGE = INTERFACE_AGE; 3117 3118 /** 3119 * Like atk_get_major_version(), but from the headers used at 3120 * application compile time, rather than from the library linked 3121 * against at application run time. 3122 */ 3123 enum MAJOR_VERSION = 2; 3124 alias ATK_MAJOR_VERSION = MAJOR_VERSION; 3125 3126 /** 3127 * Like atk_get_micro_version(), but from the headers used at 3128 * application compile time, rather than from the library linked 3129 * against at application run time. 3130 */ 3131 enum MICRO_VERSION = 0; 3132 alias ATK_MICRO_VERSION = MICRO_VERSION; 3133 3134 /** 3135 * Like atk_get_minor_version(), but from the headers used at 3136 * application compile time, rather than from the library linked 3137 * against at application run time. 3138 */ 3139 enum MINOR_VERSION = 32; 3140 alias ATK_MINOR_VERSION = MINOR_VERSION; 3141 3142 /** 3143 * A macro that should be defined by the user prior to including 3144 * the atk/atk.h header. 3145 * The definition should be one of the predefined ATK version 3146 * macros: %ATK_VERSION_2_12, %ATK_VERSION_2_14,... 3147 * 3148 * This macro defines the earliest version of ATK that the package is 3149 * required to be able to compile against. 3150 * 3151 * If the compiler is configured to warn about the use of deprecated 3152 * functions, then using functions that were deprecated in version 3153 * %ATK_VERSION_MIN_REQUIRED or earlier will cause warnings (but 3154 * using functions deprecated in later releases will not). 3155 */ 3156 enum VERSION_MIN_REQUIRED = 2; 3157 alias ATK_VERSION_MIN_REQUIRED = VERSION_MIN_REQUIRED;