1 2@c %start of fragment 3 4@deftp Class <gtk-settings> 5Derives from @code{<gobject>}. 6 7This class defines the following slots: 8 9@table @code 10@item gtk-double-click-time 11Maximum time allowed between two clicks for them to be considered a double click 12(in milliseconds) 13 14@item gtk-double-click-distance 15Maximum distance allowed between two clicks for them to be considered a double 16click (in pixels) 17 18@item gtk-cursor-blink 19Whether the cursor should blink 20 21@item gtk-cursor-blink-time 22Length of the cursor blink cycle, in milliseconds 23 24@item gtk-cursor-blink-timeout 25Time after which the cursor stops blinking, in seconds 26 27@item gtk-split-cursor 28Whether two cursors should be displayed for mixed left-to-right and 29right-to-left text 30 31@item gtk-theme-name 32Name of theme RC file to load 33 34@item gtk-icon-theme-name 35Name of icon theme to use 36 37@item gtk-fallback-icon-theme 38Name of a icon theme to fall back to 39 40@item gtk-key-theme-name 41Name of key theme RC file to load 42 43@item gtk-menu-bar-accel 44Keybinding to activate the menu bar 45 46@item gtk-dnd-drag-threshold 47Number of pixels the cursor can move before dragging 48 49@item gtk-font-name 50Name of default font to use 51 52@item gtk-icon-sizes 53List of icon sizes (gtk-menu=16,16:gtk-button=20,20... 54 55@item gtk-modules 56List of currently active GTK modules 57 58@item gtk-xft-antialias 59Whether to antialias Xft fonts; 0=no, 1=yes, -1=default 60 61@item gtk-xft-hinting 62Whether to hint Xft fonts; 0=no, 1=yes, -1=default 63 64@item gtk-xft-hintstyle 65What degree of hinting to use; hintnone, hintslight, hintmedium, or hintfull 66 67@item gtk-xft-rgba 68Type of subpixel antialiasing; none, rgb, bgr, vrgb, vbgr 69 70@item gtk-xft-dpi 71Resolution for Xft, in 1024 * dots/inch. -1 to use default value 72 73@item gtk-cursor-theme-name 74Name of the cursor theme to use, or NULL to use the default theme 75 76@item gtk-cursor-theme-size 77Size to use for cursors, or 0 to use the default size 78 79@item gtk-alternative-button-order 80Whether buttons in dialogs should use the alternative button order 81 82@item gtk-alternative-sort-arrows 83Whether the direction of the sort indicators in list and tree views is inverted 84compared to the default (where down means ascending) 85 86@item gtk-show-input-method-menu 87Whether the context menus of entries and text views should offer to change the 88input method 89 90@item gtk-show-unicode-menu 91Whether the context menus of entries and text views should offer to insert 92control characters 93 94@item gtk-timeout-initial 95Starting value for timeouts, when button is pressed 96 97@item gtk-timeout-repeat 98Repeat value for timeouts, when button is pressed 99 100@item gtk-timeout-expand 101Expand value for timeouts, when a widget is expanding a new region 102 103@item gtk-color-scheme 104A palette of named colors for use in themes 105 106@item gtk-enable-animations 107Whether to enable toolkit-wide animations. 108 109@item gtk-touchscreen-mode 110When TRUE, there are no motion notify events delivered on this screen 111 112@item gtk-tooltip-timeout 113Timeout before tooltip is shown 114 115@item gtk-tooltip-browse-timeout 116Timeout before tooltip is shown when browse mode is enabled 117 118@item gtk-tooltip-browse-mode-timeout 119Timeout after which browse mode is disabled 120 121@item gtk-keynav-cursor-only 122When TRUE, there are only cursor keys available to navigate widgets 123 124@item gtk-keynav-wrap-around 125Whether to wrap around when keyboard-navigating widgets 126 127@item gtk-error-bell 128When TRUE, keyboard navigation and other errors will cause a beep 129 130@item color-hash 131A hash table representation of the color scheme. 132 133@item gtk-file-chooser-backend 134Name of the GtkFileChooser backend to use by default 135 136@item gtk-print-backends 137List of the GtkPrintBackend backends to use by default 138 139@item gtk-print-preview-command 140Command to run when displaying a print preview 141 142@item gtk-enable-mnemonics 143Whether labels should have mnemonics 144 145@item gtk-enable-accels 146Whether menu items should have accelerators 147 148@item gtk-recent-files-limit 149Number of recently used files 150 151@item gtk-im-module 152Which IM module should be used by default 153 154@item gtk-label-select-on-focus 155Whether to select the contents of a selectable label when it is focused 156 157@item gtk-can-change-accels 158Whether menu accelerators can be changed by pressing a key over the menu item 159 160@item gtk-menu-popup-delay 161Minimum time the pointer must stay over a menu item before the submenu appear 162 163@item gtk-menu-popdown-delay 164The time before hiding a submenu when the pointer is moving towards the submenu 165 166@item gtk-button-images 167Whether stock icons should be shown in buttons 168 169@item gtk-color-palette 170Palette to use in the color selector 171 172@item gtk-entry-select-on-focus 173Whether to select the contents of an entry when it is focused 174 175@item gtk-entry-password-hint-timeout 176How long to show the last input character in hidden entries 177 178@item gtk-menu-images 179Whether images should be shown in menus 180 181@item gtk-menu-bar-popup-delay 182Delay before the submenus of a menu bar appear 183 184@item gtk-scrolled-window-placement 185Where the contents of scrolled windows are located with respect to the 186scrollbars, if not overridden by the scrolled window's own placement. 187 188@end table 189 190@end deftp 191 192@deffn Function gtk-settings-get-default @result{}@tie{} (ret@tie{}@code{<gtk-settings>}) 193Gets the @code{<gtk-settings>} object for the default GDK screen, creating it if 194necessary. See @code{gtk-settings-get-for-screen}. 195 196@table @var 197@item ret 198a @code{<gtk-settings>} object. If there is no default screen, then returns 199@samp{@code{#f}}. 200 201@end table 202 203@end deffn 204 205@deffn Function gtk-settings-get-for-screen (screen@tie{}@code{<gdk-screen>}) @result{}@tie{} (ret@tie{}@code{<gtk-settings>}) 206Gets the @code{<gtk-settings>} object for @var{screen}, creating it if 207necessary. 208 209@table @var 210@item screen 211a @code{<gdk-screen>}. 212 213@item ret 214a @code{<gtk-settings>} object. 215 216@end table 217 218Since 2.2 219 220@end deffn 221 222@deffn Function gtk-settings-install-property (pspec@tie{}@code{<gparam>}) 223@table @var 224@item pspec 225 226 227@end table 228 229@end deffn 230 231@deffn Function gtk-rc-property-parse-color (pspec@tie{}@code{<gparam>}) (gstring@tie{}@code{<g-string*>}) (property_value@tie{}@code{<gvalue>}) @result{}@tie{} (ret@tie{}@code{bool}) 232A @code{<gtk-rc-property-parser>} for use with 233@code{gtk-settings-install-property-parser} or 234@code{gtk-widget-class-install-style-property-parser} which parses a color given 235either by its name or in the form @samp{@{ red, green, blue @}} where 236@samp{red}, @samp{green} and @samp{blue} are integers between 0 and 65535 or 237floating-point numbers between 0 and 1. 238 239@table @var 240@item pspec 241a @code{<gparam>} 242 243@item gstring 244the @code{<g-string>} to be parsed 245 246@item property-value 247a @code{<gvalue>} which must hold @code{<gdk-color>} values. 248 249@item ret 250@samp{@code{#t}} if @var{gstring} could be parsed and @var{property-value} has 251been set to the resulting @code{<gdk-color>}. 252 253@end table 254 255@end deffn 256 257@deffn Function gtk-rc-property-parse-enum (pspec@tie{}@code{<gparam>}) (gstring@tie{}@code{<g-string*>}) (property_value@tie{}@code{<gvalue>}) @result{}@tie{} (ret@tie{}@code{bool}) 258A @code{<gtk-rc-property-parser>} for use with 259@code{gtk-settings-install-property-parser} or 260@code{gtk-widget-class-install-style-property-parser} which parses a single 261enumeration value. 262 263The enumeration value can be specified by its name, its nickname or its numeric 264value. For consistency with flags parsing, the value may be surrounded by 265parentheses. 266 267@table @var 268@item pspec 269a @code{<gparam>} 270 271@item gstring 272the @code{<g-string>} to be parsed 273 274@item property-value 275a @code{<gvalue>} which must hold enum values. 276 277@item ret 278@samp{@code{#t}} if @var{gstring} could be parsed and @var{property-value} has 279been set to the resulting @code{<g-enum-value>}. 280 281@end table 282 283@end deffn 284 285@deffn Function gtk-rc-property-parse-flags (pspec@tie{}@code{<gparam>}) (gstring@tie{}@code{<g-string*>}) (property_value@tie{}@code{<gvalue>}) @result{}@tie{} (ret@tie{}@code{bool}) 286A @code{<gtk-rc-property-parser>} for use with 287@code{gtk-settings-install-property-parser} or 288@code{gtk-widget-class-install-style-property-parser} which parses flags. 289 290Flags can be specified by their name, their nickname or numerically. Multiple 291flags can be specified in the form @samp{"( flag1 | flag2 | ... )"}. 292 293@table @var 294@item pspec 295a @code{<gparam>} 296 297@item gstring 298the @code{<g-string>} to be parsed 299 300@item property-value 301a @code{<gvalue>} which must hold flags values. 302 303@item ret 304@samp{@code{#t}} if @var{gstring} could be parsed and @var{property-value} has 305been set to the resulting flags value. 306 307@end table 308 309@end deffn 310 311@deffn Function gtk-rc-property-parse-requisition (pspec@tie{}@code{<gparam>}) (gstring@tie{}@code{<g-string*>}) (property_value@tie{}@code{<gvalue>}) @result{}@tie{} (ret@tie{}@code{bool}) 312A @code{<gtk-rc-property-parser>} for use with 313@code{gtk-settings-install-property-parser} or 314@code{gtk-widget-class-install-style-property-parser} which parses a requisition 315in the form @samp{"@{ width, height @}"} for integers @samp{width} and 316@samp{height}. 317 318@table @var 319@item pspec 320a @code{<gparam>} 321 322@item gstring 323the @code{<g-string>} to be parsed 324 325@item property-value 326a @code{<gvalue>} which must hold boxed values. 327 328@item ret 329@samp{@code{#t}} if @var{gstring} could be parsed and @var{property-value} has 330been set to the resulting @code{<gtk-requisition>}. 331 332@end table 333 334@end deffn 335 336@deffn Function gtk-rc-property-parse-border (pspec@tie{}@code{<gparam>}) (gstring@tie{}@code{<g-string*>}) (property_value@tie{}@code{<gvalue>}) @result{}@tie{} (ret@tie{}@code{bool}) 337A @code{<gtk-rc-property-parser>} for use with 338@code{gtk-settings-install-property-parser} or 339@code{gtk-widget-class-install-style-property-parser} which parses borders in 340the form @samp{"@{ left, right, top, bottom @}"} for integers @samp{left}, 341@samp{right}, @samp{top} and @samp{bottom}. 342 343@table @var 344@item pspec 345a @code{<gparam>} 346 347@item gstring 348the @code{<g-string>} to be parsed 349 350@item property-value 351a @code{<gvalue>} which must hold boxed values. 352 353@item ret 354@samp{@code{#t}} if @var{gstring} could be parsed and @var{property-value} has 355been set to the resulting @code{<gtk-border>}. 356 357@end table 358 359@end deffn 360 361@deffn Function gtk-settings-set-string-property (self@tie{}@code{<gtk-settings>}) (name@tie{}@code{mchars}) (v_string@tie{}@code{mchars}) (origin@tie{}@code{mchars}) 362@deffnx Method set-string-property 363@table @var 364@item settings 365 366 367@item name 368 369 370@item v-string 371 372 373@item origin 374 375 376@end table 377 378@end deffn 379 380@deffn Function gtk-settings-set-long-property (self@tie{}@code{<gtk-settings>}) (name@tie{}@code{mchars}) (v_long@tie{}@code{long}) (origin@tie{}@code{mchars}) 381@deffnx Method set-long-property 382@table @var 383@item settings 384 385 386@item name 387 388 389@item v-long 390 391 392@item origin 393 394 395@end table 396 397@end deffn 398 399@deffn Function gtk-settings-set-double-property (self@tie{}@code{<gtk-settings>}) (name@tie{}@code{mchars}) (v_double@tie{}@code{double}) (origin@tie{}@code{mchars}) 400@deffnx Method set-double-property 401@table @var 402@item settings 403 404 405@item name 406 407 408@item v-double 409 410 411@item origin 412 413 414@end table 415 416@end deffn 417 418 419@c %end of fragment 420