1
2@c %start of fragment
3
4@deftp Class <gtk-style>
5Derives from @code{<gobject>}.
6
7This class defines no direct slots.
8
9@end deftp
10
11@defop Signal <gtk-style> realize
12Emitted when the style has been initialized for a particular colormap and depth.
13Connecting to this signal is probably seldom useful since most of the time
14applications and widgets only deal with styles that have been already realized.
15
16Since 2.4
17
18@end defop
19
20@defop Signal <gtk-style> unrealize
21Emitted when the aspects of the style specific to a particular colormap and
22depth are being cleaned up. A connection to this signal can be useful if a
23widget wants to cache objects like a @code{<gdk-gc>} as object data on
24@code{<gtk-style>}. This signal provides a convenient place to free such cached
25objects.
26
27Since 2.4
28
29@end defop
30
31@deftp Class <gtk-border>
32Derives from @code{<gboxed>}.
33
34This class defines no direct slots.
35
36@end deftp
37
38@deffn Function gtk-style-new  @result{}@tie{} (ret@tie{}@code{<gtk-style>})
39Creates a new @code{<gtk-style>}.
40
41@table @var
42@item ret
43a new @code{<gtk-style>}.
44
45@end table
46
47@end deffn
48
49@deffn Function gtk-style-copy  (self@tie{}@code{<gtk-style>}) @result{}@tie{} (ret@tie{}@code{<gtk-style>})
50@deffnx Method copy
51@table @var
52@item style
53
54
55@item ret
56
57
58@end table
59
60@end deffn
61
62@deffn Function gtk-style-attach  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) @result{}@tie{} (ret@tie{}@code{<gtk-style>})
63@deffnx Method attach
64Attaches a style to a window; this process allocates the colors and creates the
65GC's for the style - it specializes it to a particular visual and colormap. The
66process may involve the creation of a new style if the style has already been
67attached to a window with a different style and colormap.
68
69Since this function may return a new object, you have to use it in the following
70way: @samp{style = gtk_style_attach (style, window)}
71
72@table @var
73@item style
74a @code{<gtk-style>}.
75
76@item window
77a @code{<gdk-window>}.
78
79@item ret
80Either @var{style}, or a newly-created @code{<gtk-style>}. If the style is newly
81created, the style parameter will be dereferenced, and the new style will have a
82reference count belonging to the caller.
83
84@end table
85
86@end deffn
87
88@deffn Function gtk-style-detach  (self@tie{}@code{<gtk-style>})
89@deffnx Method detach
90Detaches a style from a window. If the style is not attached to any windows
91anymore, it is unrealized. See @code{gtk-style-attach}.
92
93@table @var
94@item style
95a @code{<gtk-style>}
96
97@end table
98
99@end deffn
100
101@deffn Function gtk-style-set-background  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>})
102@deffnx Method set-background
103Sets the background of @var{window} to the background color or pixmap specified
104by @var{style} for the given state.
105
106@table @var
107@item style
108a @code{<gtk-style>}
109
110@item window
111a @code{<gdk-window>}
112
113@item state-type
114a state
115
116@end table
117
118@end deffn
119
120@deffn Function gtk-style-apply-default-background  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (set_bg@tie{}@code{bool}) (state_type@tie{}@code{<gtk-state-type>}) (area@tie{}@code{<gdk-rectangle>}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
121@deffnx Method apply-default-background
122@table @var
123@item style
124
125
126@item window
127
128
129@item set-bg
130
131
132@item state-type
133
134
135@item area
136
137
138@item x
139
140
141@item y
142
143
144@item width
145
146
147@item height
148
149
150@end table
151
152@end deffn
153
154@deffn Function gtk-style-lookup-color  (self@tie{}@code{<gtk-style>}) (color_name@tie{}@code{mchars}) (color@tie{}@code{<gdk-color>}) @result{}@tie{} (ret@tie{}@code{bool})
155@deffnx Method lookup-color
156Looks up @var{color-name} in the style's logical color mappings, filling in
157@var{color} and returning @samp{@code{#t}} if found, otherwise returning
158@samp{@code{#f}}. Do not cache the found mapping, because it depends on the
159@code{<gtk-style>} and might change when a theme switch occurs.
160
161@table @var
162@item style
163a @code{<gtk-style>}
164
165@item color-name
166the name of the logical color to look up
167
168@item color
169the @code{<gdk-color>} to fill in
170
171@item ret
172@samp{@code{#t}} if the mapping was found.
173
174@end table
175
176Since 2.10
177
178@end deffn
179
180@deffn Function gtk-style-lookup-icon-set  (self@tie{}@code{<gtk-style>}) (stock_id@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gtk-icon-set>})
181@deffnx Method lookup-icon-set
182@table @var
183@item style
184
185
186@item stock-id
187
188
189@item ret
190
191
192@end table
193
194@end deffn
195
196@deffn Function gtk-style-render-icon  (self@tie{}@code{<gtk-style>}) (source@tie{}@code{<gtk-icon-source>}) (direction@tie{}@code{<gtk-text-direction>}) (state@tie{}@code{<gtk-state-type>}) (size@tie{}@code{<gtk-icon-size>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gdk-pixbuf>})
197@deffnx Method render-icon
198Renders the icon specified by @var{source} at the given @var{size} according to
199the given parameters and returns the result in a pixbuf.
200
201@table @var
202@item style
203a @code{<gtk-style>}
204
205@item source
206the @code{<gtk-icon-source>} specifying the icon to render
207
208@item direction
209a text direction
210
211@item state
212a state
213
214@item size
215the size to render the icon at. A size of (GtkIconSize)-1 means render at the
216size of the source and don't scale.
217
218@item widget
219the widget
220
221@item detail
222a style detail
223
224@item ret
225a newly-created @code{<gdk-pixbuf>} containing the rendered icon
226
227@end table
228
229@end deffn
230
231@deffn Function gtk-paint-arrow  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (arrow_type@tie{}@code{<gtk-arrow-type>}) (fill@tie{}@code{bool}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
232Draws an arrow in the given rectangle on @var{window} using the given
233parameters. @var{arrow-type} determines the direction of the arrow.
234
235@table @var
236@item style
237a @code{<gtk-style>}
238
239@item window
240a @code{<gdk-window>}
241
242@item state-type
243a state
244
245@item shadow-type
246the type of shadow to draw
247
248@item area
249clip rectangle, or @samp{@code{#f}} if the output should not be clipped
250
251@item widget
252the widget (may be @samp{@code{#f}})
253
254@item detail
255a style detail (may be @samp{@code{#f}})
256
257@item arrow-type
258the type of arrow to draw
259
260@item fill
261@samp{@code{#t}} if the arrow tip should be filled
262
263@item x
264x origin of the rectangle to draw the arrow in
265
266@item y
267y origin of the rectangle to draw the arrow in
268
269@item width
270width of the rectangle to draw the arrow in
271
272@item height
273height of the rectangle to draw the arrow in
274
275@end table
276
277@end deffn
278
279@deffn Function gtk-paint-box  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
280Draws a box on @var{window} with the given parameters.
281
282@table @var
283@item style
284a @code{<gtk-style>}
285
286@item window
287a @code{<gdk-window>}
288
289@item state-type
290a state
291
292@item shadow-type
293the type of shadow to draw
294
295@item area
296clip rectangle, or @samp{@code{#f}} if the output should not be clipped
297
298@item widget
299the widget (may be @samp{@code{#f}})
300
301@item detail
302a style detail (may be @samp{@code{#f}})
303
304@item x
305x origin of the box
306
307@item y
308y origin of the box
309
310@item width
311the width of the box
312
313@item height
314the height of the box
315
316@end table
317
318@end deffn
319
320@deffn Function gtk-paint-box-gap  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int}) (gap_side@tie{}@code{<gtk-position-type>}) (gap_x@tie{}@code{int}) (gap_width@tie{}@code{int})
321Draws a box in @var{window} using the given style and state and shadow type,
322leaving a gap in one side.
323
324@table @var
325@item style
326a @code{<gtk-style>}
327
328@item window
329a @code{<gdk-window>}
330
331@item state-type
332a state
333
334@item shadow-type
335type of shadow to draw
336
337@item area
338clip rectangle, or @samp{@code{#f}} if the output should not be clipped
339
340@item widget
341the widget (may be @samp{@code{#f}})
342
343@item detail
344a style detail (may be @samp{@code{#f}})
345
346@item x
347x origin of the rectangle
348
349@item y
350y origin of the rectangle
351
352@item width
353width of the rectangle
354
355@item height
356width of the rectangle
357
358@item gap-side
359side in which to leave the gap
360
361@item gap-x
362starting position of the gap
363
364@item gap-width
365width of the gap
366
367@end table
368
369@end deffn
370
371@deffn Function gtk-paint-check  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
372Draws a check button indicator in the given rectangle on @var{window} with the
373given parameters.
374
375@table @var
376@item style
377a @code{<gtk-style>}
378
379@item window
380a @code{<gdk-window>}
381
382@item state-type
383a state
384
385@item shadow-type
386the type of shadow to draw
387
388@item area
389clip rectangle, or @samp{@code{#f}} if the output should not be clipped
390
391@item widget
392the widget (may be @samp{@code{#f}})
393
394@item detail
395a style detail (may be @samp{@code{#f}})
396
397@item x
398x origin of the rectangle to draw the check in
399
400@item y
401y origin of the rectangle to draw the check in
402
403@item width
404the width of the rectangle to draw the check in
405
406@item height
407the height of the rectangle to draw the check in
408
409@end table
410
411@end deffn
412
413@deffn Function gtk-paint-diamond  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
414Draws a diamond in the given rectangle on @var{window} using the given
415parameters.
416
417@table @var
418@item style
419a @code{<gtk-style>}
420
421@item window
422a @code{<gdk-window>}
423
424@item state-type
425a state
426
427@item shadow-type
428the type of shadow to draw
429
430@item area
431clip rectangle, or @samp{@code{#f}} if the output should not be clipped
432
433@item widget
434the widget (may be @samp{@code{#f}})
435
436@item detail
437a style detail (may be @samp{@code{#f}})
438
439@item x
440x origin of the rectangle to draw the diamond in
441
442@item y
443y origin of the rectangle to draw the diamond in
444
445@item width
446width of the rectangle to draw the diamond in
447
448@item height
449height of the rectangle to draw the diamond in
450
451@end table
452
453@end deffn
454
455@deffn Function gtk-paint-extension  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int}) (gap_side@tie{}@code{<gtk-position-type>})
456Draws an extension, i.e. a notebook tab.
457
458@table @var
459@item style
460a @code{<gtk-style>}
461
462@item window
463a @code{<gdk-window>}
464
465@item state-type
466a state
467
468@item shadow-type
469type of shadow to draw
470
471@item area
472clip rectangle, or @samp{@code{#f}} if the output should not be clipped
473
474@item widget
475the widget (may be @samp{@code{#f}})
476
477@item detail
478a style detail (may be @samp{@code{#f}})
479
480@item x
481x origin of the extension
482
483@item y
484y origin of the extension
485
486@item width
487width of the extension
488
489@item height
490width of the extension
491
492@item gap-side
493the side on to which the extension is attached
494
495@end table
496
497@end deffn
498
499@deffn Function gtk-paint-flat-box  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
500Draws a flat box on @var{window} with the given parameters.
501
502@table @var
503@item style
504a @code{<gtk-style>}
505
506@item window
507a @code{<gdk-window>}
508
509@item state-type
510a state
511
512@item shadow-type
513the type of shadow to draw
514
515@item area
516clip rectangle, or @samp{@code{#f}} if the output should not be clipped
517
518@item widget
519the widget (may be @samp{@code{#f}})
520
521@item detail
522a style detail (may be @samp{@code{#f}})
523
524@item x
525x origin of the box
526
527@item y
528y origin of the box
529
530@item width
531the width of the box
532
533@item height
534the height of the box
535
536@end table
537
538@end deffn
539
540@deffn Function gtk-paint-focus  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
541Draws a focus indicator around the given rectangle on @var{window} using the
542given style.
543
544@table @var
545@item style
546a @code{<gtk-style>}
547
548@item window
549a @code{<gdk-window>}
550
551@item state-type
552a state
553
554@item area
555clip rectangle, or @samp{@code{#f}} if the output should not be clipped
556
557@item widget
558the widget (may be @samp{@code{#f}})
559
560@item detail
561a style detail (may be @samp{@code{#f}})
562
563@item x
564the x origin of the rectangle around which to draw a focus indicator
565
566@item y
567the y origin of the rectangle around which to draw a focus indicator
568
569@item width
570the width of the rectangle around which to draw a focus indicator
571
572@item height
573the height of the rectangle around which to draw a focus indicator
574
575@end table
576
577@end deffn
578
579@deffn Function gtk-paint-handle  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int}) (orientation@tie{}@code{<gtk-orientation>})
580Draws a handle as used in @code{<gtk-handle-box>} and @code{<gtk-paned>}.
581
582@table @var
583@item style
584a @code{<gtk-style>}
585
586@item window
587a @code{<gdk-window>}
588
589@item state-type
590a state
591
592@item shadow-type
593type of shadow to draw
594
595@item area
596clip rectangle, or @samp{@code{#f}} if the output should not be clipped
597
598@item widget
599the widget (may be @samp{@code{#f}})
600
601@item detail
602a style detail (may be @samp{@code{#f}})
603
604@item x
605x origin of the handle
606
607@item y
608y origin of the handle
609
610@item width
611with of the handle
612
613@item height
614height of the handle
615
616@item orientation
617the orientation of the handle
618
619@end table
620
621@end deffn
622
623@deffn Function gtk-paint-hline  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x1@tie{}@code{int}) (x2@tie{}@code{int}) (y@tie{}@code{int})
624Draws a horizontal line from (@var{x1}, @var{y}) to (@var{x2}, @var{y}) in
625@var{window} using the given style and state.
626
627@table @var
628@item style
629a @code{<gtk-style>}
630
631@item window
632a @code{<gdk-window>}
633
634@item state-type
635a state
636
637@item area
638rectangle to which the output is clipped, or @samp{@code{#f}} if the output
639should not be clipped
640
641@item widget
642the widget (may be @samp{@code{#f}})
643
644@item detail
645a style detail (may be @samp{@code{#f}})
646
647@item x1
648the starting x coordinate
649
650@item x2
651the ending x coordinate
652
653@item y
654the y coordinate
655
656@end table
657
658@end deffn
659
660@deffn Function gtk-paint-option  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
661Draws a radio button indicator in the given rectangle on @var{window} with the
662given parameters.
663
664@table @var
665@item style
666a @code{<gtk-style>}
667
668@item window
669a @code{<gdk-window>}
670
671@item state-type
672a state
673
674@item shadow-type
675the type of shadow to draw
676
677@item area
678clip rectangle, or @samp{@code{#f}} if the output should not be clipped
679
680@item widget
681the widget (may be @samp{@code{#f}})
682
683@item detail
684a style detail (may be @samp{@code{#f}})
685
686@item x
687x origin of the rectangle to draw the option in
688
689@item y
690y origin of the rectangle to draw the option in
691
692@item width
693the width of the rectangle to draw the option in
694
695@item height
696the height of the rectangle to draw the option in
697
698@end table
699
700@end deffn
701
702@deffn Function gtk-paint-shadow  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
703Draws a shadow around the given rectangle in @var{window} using the given style
704and state and shadow type.
705
706@table @var
707@item style
708a @code{<gtk-style>}
709
710@item window
711a @code{<gdk-window>}
712
713@item state-type
714a state
715
716@item shadow-type
717type of shadow to draw
718
719@item area
720clip rectangle or @samp{@code{#f}} if the output should not be clipped
721
722@item widget
723the widget (may be @samp{@code{#f}})
724
725@item detail
726a style detail (may be @samp{@code{#f}})
727
728@item x
729x origin of the rectangle
730
731@item y
732y origin of the rectangle
733
734@item width
735width of the rectangle
736
737@item height
738width of the rectangle
739
740@end table
741
742@end deffn
743
744@deffn Function gtk-paint-shadow-gap  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int}) (gap_side@tie{}@code{<gtk-position-type>}) (gap_x@tie{}@code{int}) (gap_width@tie{}@code{int})
745Draws a shadow around the given rectangle in @var{window} using the given style
746and state and shadow type, leaving a gap in one side.
747
748@table @var
749@item style
750a @code{<gtk-style>}
751
752@item window
753a @code{<gdk-window>}
754
755@item state-type
756a state
757
758@item shadow-type
759type of shadow to draw
760
761@item area
762clip rectangle, or @samp{@code{#f}} if the output should not be clipped
763
764@item widget
765the widget (may be @samp{@code{#f}})
766
767@item detail
768a style detail (may be @samp{@code{#f}})
769
770@item x
771x origin of the rectangle
772
773@item y
774y origin of the rectangle
775
776@item width
777width of the rectangle
778
779@item height
780width of the rectangle
781
782@item gap-side
783side in which to leave the gap
784
785@item gap-x
786starting position of the gap
787
788@item gap-width
789width of the gap
790
791@end table
792
793@end deffn
794
795@deffn Function gtk-paint-slider  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int}) (orientation@tie{}@code{<gtk-orientation>})
796Draws a slider in the given rectangle on @var{window} using the given style and
797orientation.
798
799@table @var
800@item style
801a @code{<gtk-style>}
802
803@item window
804a @code{<gdk-window>}
805
806@item state-type
807a state
808
809@item shadow-type
810a shadow
811
812@item area
813clip rectangle, or @samp{@code{#f}} if the output should not be clipped
814
815@item widget
816the widget (may be @samp{@code{#f}})
817
818@item detail
819a style detail (may be @samp{@code{#f}})
820
821@item x
822the x origin of the rectangle in which to draw a slider
823
824@item y
825the y origin of the rectangle in which to draw a slider
826
827@item width
828the width of the rectangle in which to draw a slider
829
830@item height
831the height of the rectangle in which to draw a slider
832
833@item orientation
834the orientation to be used
835
836@end table
837
838@end deffn
839
840@deffn Function gtk-paint-tab  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (shadow_type@tie{}@code{<gtk-shadow-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
841Draws an option menu tab (i.e. the up and down pointing arrows) in the given
842rectangle on @var{window} using the given parameters.
843
844@table @var
845@item style
846a @code{<gtk-style>}
847
848@item window
849a @code{<gdk-window>}
850
851@item state-type
852a state
853
854@item shadow-type
855the type of shadow to draw
856
857@item area
858clip rectangle, or @samp{@code{#f}} if the output should not be clipped
859
860@item widget
861the widget (may be @samp{@code{#f}})
862
863@item detail
864a style detail (may be @samp{@code{#f}})
865
866@item x
867x origin of the rectangle to draw the tab in
868
869@item y
870y origin of the rectangle to draw the tab in
871
872@item width
873the width of the rectangle to draw the tab in
874
875@item height
876the height of the rectangle to draw the tab in
877
878@end table
879
880@end deffn
881
882@deffn Function gtk-paint-vline  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (y1@tie{}@code{int}) (y2@tie{}@code{int}) (x@tie{}@code{int})
883Draws a vertical line from (@var{x}, @var{y1}) to (@var{x}, @var{y2}) in
884@var{window} using the given style and state.
885
886@table @var
887@item style
888a @code{<gtk-style>}
889
890@item window
891a @code{<gdk-window>}
892
893@item state-type
894a state
895
896@item area
897rectangle to which the output is clipped, or @samp{@code{#f}} if the output
898should not be clipped
899
900@item widget
901the widget (may be @samp{@code{#f}})
902
903@item detail
904a style detail (may be @samp{@code{#f}})
905
906@item y1
907the starting y coordinate
908
909@item y2
910the ending y coordinate
911
912@item x
913the x coordinate
914
915@end table
916
917@end deffn
918
919@deffn Function gtk-paint-expander  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (expander_style@tie{}@code{<gtk-expander-style>})
920Draws an expander as used in @code{<gtk-tree-view>}. @var{x} and @var{y} specify
921the center the expander. The size of the expander is determined by the
922"expander-size" style property of @var{widget}. (If widget is not specified or
923doesn't have an "expander-size" property, an unspecified default size will be
924used, since the caller doesn't have sufficient information to position the
925expander, this is likely not useful.) The expander is expander_size pixels tall
926in the collapsed position and expander_size pixels wide in the expanded
927position.
928
929@table @var
930@item style
931a @code{<gtk-style>}
932
933@item window
934a @code{<gdk-window>}
935
936@item state-type
937a state
938
939@item area
940clip rectangle, or @samp{@code{#f}} if the output should not be clipped
941
942@item widget
943the widget (may be @samp{@code{#f}})
944
945@item detail
946a style detail (may be @samp{@code{#f}})
947
948@item x
949the x position to draw the expander at
950
951@item y
952the y position to draw the expander at
953
954@item expander-style
955the style to draw the expander in; determines whether the expander is collapsed,
956expanded, or in an intermediate state.
957
958@end table
959
960@end deffn
961
962@deffn Function gtk-paint-layout  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (use_text@tie{}@code{bool}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (x@tie{}@code{int}) (y@tie{}@code{int}) (layout@tie{}@code{<pango-layout>})
963Draws a layout on @var{window} using the given parameters.
964
965@table @var
966@item style
967a @code{<gtk-style>}
968
969@item window
970a @code{<gdk-window>}
971
972@item state-type
973a state
974
975@item use-text
976whether to use the text or foreground graphics context of @var{style}
977
978@item area
979clip rectangle, or @samp{@code{#f}} if the output should not be clipped
980
981@item widget
982the widget (may be @samp{@code{#f}})
983
984@item detail
985a style detail (may be @samp{@code{#f}})
986
987@item x
988x origin
989
990@item y
991y origin
992
993@item layout
994the layout to draw
995
996@end table
997
998@end deffn
999
1000@deffn Function gtk-paint-resize-grip  (self@tie{}@code{<gtk-style>}) (window@tie{}@code{<gdk-window>}) (state_type@tie{}@code{<gtk-state-type>}) (area@tie{}@code{<gdk-rectangle>}) (widget@tie{}@code{<gtk-widget>}) (detail@tie{}@code{mchars}) (edge@tie{}@code{<gdk-window-edge>}) (x@tie{}@code{int}) (y@tie{}@code{int}) (width@tie{}@code{int}) (height@tie{}@code{int})
1001Draws a resize grip in the given rectangle on @var{window} using the given
1002parameters.
1003
1004@table @var
1005@item style
1006a @code{<gtk-style>}
1007
1008@item window
1009a @code{<gdk-window>}
1010
1011@item state-type
1012a state
1013
1014@item area
1015clip rectangle, or @samp{@code{#f}} if the output should not be clipped
1016
1017@item widget
1018the widget (may be @samp{@code{#f}})
1019
1020@item detail
1021a style detail (may be @samp{@code{#f}})
1022
1023@item edge
1024the edge in which to draw the resize grip
1025
1026@item x
1027the x origin of the rectangle in which to draw the resize grip
1028
1029@item y
1030the y origin of the rectangle in which to draw the resize grip
1031
1032@item width
1033the width of the rectangle in which to draw the resize grip
1034
1035@item height
1036the height of the rectangle in which to draw the resize grip
1037
1038@end table
1039
1040@end deffn
1041
1042@deffn Function gtk-draw-insertion-cursor  (widget@tie{}@code{<gtk-widget>}) (drawable@tie{}@code{<gdk-drawable>}) (area@tie{}@code{<gdk-rectangle>}) (location@tie{}@code{<gdk-rectangle>}) (is_primary@tie{}@code{bool}) (direction@tie{}@code{<gtk-text-direction>}) (draw_arrow@tie{}@code{bool})
1043Draws a text caret on @var{drawable} at @var{location}. This is not a style
1044function but merely a convenience function for drawing the standard cursor
1045shape.
1046
1047@table @var
1048@item widget
1049a @code{<gtk-widget>}
1050
1051@item drawable
1052a @code{<gdk-drawable>}
1053
1054@item area
1055rectangle to which the output is clipped, or @samp{@code{#f}} if the output
1056should not be clipped
1057
1058@item location
1059location where to draw the cursor (@var{location->width} is ignored)
1060
1061@item is-primary
1062if the cursor should be the primary cursor color.
1063
1064@item direction
1065whether the cursor is left-to-right or right-to-left. Should never be
1066@code{<gtk-text-dir-none>}
1067
1068@item draw-arrow
1069@samp{@code{#t}} to draw a directional arrow on the cursor. Should be
1070@samp{@code{#f}} unless the cursor is split.
1071
1072@end table
1073
1074Since 2.4
1075
1076@end deffn
1077
1078@deffn Function gtk-border-copy  (self@tie{}@code{<gtk-border>}) @result{}@tie{} (ret@tie{}@code{<gtk-border>})
1079Copies a @code{<gtk-border>} structure.
1080
1081@table @var
1082@item border
1083a @code{<gtk-border>}.
1084
1085@item ret
1086a copy of @var{border}.
1087
1088@end table
1089
1090@end deffn
1091
1092@deffn Function gtk-border-free  (self@tie{}@code{<gtk-border>})
1093Frees a @code{<gtk-border>} structure.
1094
1095@table @var
1096@item border
1097a @code{<gtk-border>}.
1098
1099@end table
1100
1101@end deffn
1102
1103
1104@c %end of fragment
1105