Added support for CAIRO 1.6 API
[phpCairo.git] / cairo.xml
blob635c7a3f12b5715f1e361623f5e66156af353c59
1 <?xml version="1.0" ?>
2 <extension name="phpCairo" version="0.1.0">
4         <!-- Summary and other details -->      
5         <summary>PHP bindings for Cairo Graphic Library</summary>
6         <description>
7                 This extension offers you object oriented support for Cairo.
8         </description>
9         <license>php</license>
10         <maintainer>
11                 <user>aki</user>
12                 <name>Akshat Gupta</name>
13                 <email>g.akshat@gmail.com</email>
14                 <role>lead</role>
15         </maintainer>
16         <changelog>
17                 <release>
18                         <version>0.1</version>
19                         <date>2006-06-10</date>
20                         <state>alpha</state>
21                         <notes>First alpha version</notes>
22                 </release>
23         </changelog>
25         <!-- cairo interface -->
26         
27         <class name="cairoContext">
28                 <summary>The main drawing class</summary>
29                 
30 <!--
31                 <function name="__construct">
32                         <proto>void construct(string path)</proto>
33                         <code></code>
34                 </function>
35 -->
36                 <function name="append_path">
37                         <proto>void append_path(object p)</proto>
38                         <code></code>
39                 </function>
41                 <function name="arc">
42                         <proto>void arc(float xc, float yc, float radius, float angle1, float angle2)</proto>
43                         <code></code>
44                 </function>
46                 <function name="arc_negative">
47                         <proto>void arc_negative(float xc, float yc, float radius, float angle1, float angle2)</proto>
48                         <code></code>
49                 </function>
51                 <function name="clip">
52                         <proto>void clip()</proto>
53                         <code></code>
54                 </function>
56                 <function name="clip_extents">
57                         <proto>array clip_extents()</proto>
58                         <code></code>
59                 </function>
62                 <function name="clip_preserve">
63                         <proto>void clip_preserve()</proto>
64                         <code></code>
65                 </function>
66         
67                 <function name="close_path">
68                     <proto>void close_path()</proto>
69                         <code></code>
70                 </function>
71 <!-- need to work on the next functin -->
72         <function name="copy_clip_rectangle_list">
73                         <proto>object copy_clip_rectangle_list()</proto>
74                         <code>/*using iterator in php5.0 to store the 
75                                 list. Pass the array to an iterator during the 
76                                 object definition and jobs done */</code>
77                 </function>
78         
79                 <function name="copy_page">
80                         <proto>void copy_page()</proto>
81                         <code></code>
82                 </function>
84         <function name="copy_path">
85                         <proto>object copy_path()</proto>
86                         <code></code>
87                 </function>
89         <function name="copy_path_flat">
90                         <proto>object copy_path_flat()</proto>
91                         <code></code>
92                 </function>
94                 <function name="curve_to">
95                         <proto>void curve_to (float x1, float y1, float x2, float y2, float x3, float y3)</proto>
96                         <code></code>
97                 </function>
99                 <function name="device_to_user">
100                         <proto>array device_to_user(float x, float y)</proto>
101                         <code></code>
102                 </function>
104                 <function name="device_to_user_distance">
105                         <proto>array device_to_user_distance(float x, float y)</proto>
106                         <code></code>
107                 </function>
109                 <function name="fill">
110                         <proto>void fill()</proto>
111                         <code></code>
112                 </function>
114                 <function name="fill_extents">
115                         <proto>array fill_extents()</proto>
116                         <code></code>
117                 </function>
119                 <function name="fill_preserve">
120                         <proto>void fill_preserve()</proto>
121                         <code></code>
122                 </function>
124                 <function name="font_extents">
125                         <proto>array font_extents()</proto>
126                         <code></code>
127                 </function>
129                 <function name="get_antialias">
130                         <proto>int get_antialias()</proto>
131                         <code></code>
132                 </function>
134                 <function name="get_current_point">
135                         <proto>array get_current_point()</proto>
136                         <code></code>
137                 </function>
139                 <function name="get_dash">
140                         <proto>array get_dash()</proto>
141                         <code></code>
142                 </function>
144                 <function name="get_dash_count">
145                         <proto>int get_dash_count()</proto>
146                         <code></code>
147                 </function>
149                 <function name="get_fill_rule">
150                         <proto>int get_fill_rule()</proto>
151                         <code></code>
152                 </function>
154                 <function name="get_font_face">
155                         <proto>object get_font_face()</proto>
156                         <code></code>
157                 </function>
159                 <function name="get_font_matrix">
160                         <proto>object get_font_matrix()</proto>
161                         <code></code>
162                 </function>
164                 <function name="get_font_options">
165                         <proto>object get_font_options()</proto>
166                         <code></code>
167                 </function>
169                 <function name="get_group_target">
170                         <proto>object get_group_target()</proto>
171                         <code></code>
172                 </function>
174                 <function name="get_line_cap">
175                         <proto>int get_line_cap()</proto>
176                         <code></code>
177                 </function>
179                 <function name="get_line_join">
180                         <proto>int get_line_join()</proto>
181                         <code></code>
182                 </function>
184                 <function name="get_line_width">
185                         <proto>float get_line_width()</proto>
186                         <code></code>
187                 </function>
189                 <function name="get_matrix">
190                         <proto>object get_matrix()</proto>
191                         <code></code>
192                 </function>
194                 <function name="get_matrix_limit">
195                         <proto>float get_matrix_limit()</proto>
196                         <code></code>
197                 </function>
199                 <function name="get_operator">
200                         <proto>int get_operator()</proto>
201                         <code></code>
202                 </function>
204                 <function name="get_scaled_font">
205                         <proto>object get_scaled_font()</proto>
206                         <code></code>
207                 </function>
209                 <function name="get_source">
210                         <proto>object get_source()</proto>
211                         <code></code>
212                 </function>
213 <!-- -->
214                 <function name="get_target">
215                         <proto>object get_target()</proto>
216                         <code></code>
217                 </function>
219                 <function name="get_tolerance">
220                         <proto>float get_tolerance()</proto>
221                         <code></code>
222                 </function>
224                 <function name="glyph_extents">
225                         <proto>array get_extents(object obj[,int num])</proto>
226                         <code>/*This might be a prob*/</code>
227                 </function>
229                 <function name="glyph_path">
230                         <proto>void glyph_pat(object obh[,int num])</proto>
231                         <code></code>
232                 </function>
234                 <function name="identity_matrix">
235                         <proto>void identity_matrix()</proto>
236                         <code></code>
237                 </function>
239                 <function name="in_fill">
240                         <proto>bool in_fill(float x, float y)</proto>
241                         <code></code>
242                 </function>
244                 <function name="in_stroke">
245                         <proto>bool in_stroke(float x, float y)</proto>
246                         <code></code>
247                 </function>
249                 <function name="line_to">
250                         <proto>void line_to(float x, float y)</proto>
251                         <code></code>
252                 </function>
254                 <function name="mask">
255                         <proto>void mask(object p)</proto>
256                         <code></code>
257                 </function>
259                 <function name="mask_surface">
260                         <proto>void mask_surface(object s[,float surface_x, float surface_y])</proto>
261                         <code></code>
262                 </function>
264                 <function name="move_to">
265                         <proto>void move_to(float x, float y)</proto>
266                         <code></code>
267                 </function>
269                 <function name="new_path">
270                         <proto>void new_path()</proto>
271                         <code></code>
272                 </function>
274                 <function name="new_sub_path">
275                         <proto>void new_sub_path()</proto>
276                         <code></code>
277                 </function>
279                 <function name="paint">
280                         <proto>void paint()</proto>
281                         <code></code>
282                 </function>
284                 <function name="paint_with_alpha">
285                         <proto>void paint_with_alpha(float alpha)</proto>
286                         <code></code>
287                 </function>
289                 <function name="pop_group">
290                         <proto>object pop_group()</proto>
291                         <code></code>
292                 </function>
294                 <function name="pop_group_to_source">
295                         <proto>void pop_group_to_source()</proto>
296                         <code></code>
297                 </function>
299                 <function name="push_group">
300                         <proto>void push_group()</proto>
301                         <code></code>
302                 </function>
304                 <function name="push_group_with_content">
305                         <proto>void push_group_with_content(int content)</proto>
306                         <code></code>
307                 </function>
309                 <function name="rectangle">
310                         <proto>void rectangle(float x, float y, float width, float height)</proto>
311                         <code></code>
312                 </function>
314                 <function name="rel_curve_to">
315                         <proto>void rel_curve_to(float x1, float y1, float x2, float y2, float x3, float y3)</proto>
316                         <code></code>
317                 </function>
319                 <function name="rel_line_to">
320                         <proto>void rel_line_to(float x, float y)</proto>
321                         <code></code>
322                 </function>
324                 <function name="rel_move_to">
325                         <proto>void rel_move_to(float x, float y)</proto>
326                         <code></code>
327                 </function>
329                 <function name="reset_clip">
330                         <proto>void reset_clip()</proto>
331                         <code></code>
332                 </function>
334                 <function name="restore">
335                         <proto>void restore()</proto>
336                         <code></code>
337                 </function>
339                 <function name="rotate">
340                         <proto>void rotate(float angle)</proto>
341                         <code></code>
342                 </function>
344                 <function name="save">
345                         <proto>void save()</proto>
346                         <code></code>
347                 </function>
349                 <function name="scale">
350                         <proto>void scale(float x, float y)</proto>
351                         <code></code>
352                 </function>
354                 <function name="select_font_face">
355                         <proto>void select_font_face(object obj[, int slant, int weight])</proto>
356                         <code></code>
357                 </function>
359                 <function name="set_antialias">
360                         <proto>void set_antialias([int antialias])</proto>
361                         <code></code>
362                 </function>
364                 <function name="set_dash">
365                         <proto>void set_dash(object dashes [,float offset])</proto>
366                         <code></code>
367                 </function>
369                 <function name="set_fill_rule">
370                         <proto>void set_fill_rule(int fill_rule)</proto>
371                         <code></code>
372                 </function>
374                 <function name="set_font_face"> 
375                         <proto>void set_font_face([object obj])</proto>
376                         <code></code>
377                 </function>
379                 <function name="set_font_matrix">
380                         <proto>void set_font_matrix(object matrix)</proto>
381                         <code></code>
382                 </function>
384                 <function name="set_font_options">
385                         <proto>void set_font_options(object options)</proto>
386                         <code></code>
387                 </function>
389                 <function name="set_font_size">
390                         <proto>void set_font_size(float size)</proto>
391                         <code></code>
392                 </function>
394                 <function name="set_line_cap">
395                         <proto>void set_line_cap(int line_cap)</proto>
396                         <code></code>
397                 </function>
399                 <function name="set_line_join">
400                         <proto>void set_line_join(int line_join)</proto>
401                         <code></code>
402                 </function>
404                 <function name="set_line_width">
405                         <proto>void set_line_width(float width)</proto>
406                         <code></code>
407                 </function>
409                 <function name="set_matrix">
410                         <proto>void set_matrix(object matix)</proto>
411                         <code></code>
412                 </function>
414                 <function name="set_miter_limit">
415                         <proto>void set_miter_limit(float limit)</proto>
416                         <code></code>
417                 </function>
419                 <function name="set_operator">
420                         <proto>void set_operator(int op)</proto>
421                         <code></code>
422                 </function>
424                 <function name="set_source">
425                         <proto>void set_source(object p)</proto>
426                         <code></code>
427                 </function>
429                 <function name="set_source_rgb">
430                         <proto>void set_source_rgb(float red, float green, float blue)</proto>
431                         <code></code>
432                 </function>
434                 <function name="set_source_rgba">
435                         <proto>void set_source_rgba(float red, float green, float blue [,float alpha])</proto>
436                         <code></code>
437                 </function>
439                 <function name="set_source_surface">
440                         <proto>void set_source_surface(object surface [,float x, float y])</proto>
441                         <code></code>
442                 </function>
444                 <function name="set_tolerance">
445                         <proto>void set_tolerance(float tolerance)</proto>
446                         <code></code>
447                 </function>
449                 <function name="show_glyphs">
450                         <proto>void show_glyphs(object glyphs [,int num_glyphs])</proto>
451                         <code></code>
452                 </function>
454                 <function name="show_page">
455                         <proto>void show_page()</proto>
456                         <code></code>
457                 </function>
459                 <function name="show_text">
460                         <proto>void show_text(object obj)</proto>
461                         <code></code>
462                 </function>
464                 <function name="stroke">
465                         <proto>void stroke()</proto>
466                         <code></code>
467                 </function>
469                 <function name="stroke_extents">
470                         <proto>array stroke_extents()</proto>
471                         <code></code>
472                 </function>
474                 <function name="stroke_preserve">
475                         <proto>void stroke_preserve()</proto>
476                         <code></code>
477                 </function>
479                 <function name="text_extents">
480                         <proto>array text_extents(object extents)</proto>
481                         <code></code>
482                 </function>
484                 <function name="text_path">
485                         <proto>void text_path(object obj)</proto>
486                         <code></code>
487                 </function>
488                 
489                 <function name="transform">
490                         <proto>void transform(object matrix)</proto>
491                         <code></code>
492                 </function>
494                 <function name="translate">
495                         <proto>void translate(float tx, float ty)</proto>
496                         <code></code>
497                 </function>
499                 <function name="user_to_device">
500                         <proto>array user_to_device(float x, float y)</proto>
501                         <code></code>
502                 </function>
504                 <function name="user_to_device_distance">
505                         <proto>array user_to_device_distance(float dx, float dy)</proto>
506                         <code></code>
507                 </function>
509         </class>
511         <class name="cairoFontFace">
512                 <function name="__construct">
513                         <proto>void construct()</proto>
514                         <code>/* not allowede to create an object directly*/</code>
515                 </function>
517                 <function name="__destruct">
518                         <proto>void destruct()</proto>
519                         <code></code>
520                 </function>
522         </class>
523         
525         <class name="cairoFontOptions">
526                 <function name="__construct">
527                         <proto>void construct()</proto>
528                         <code></code>
529                 </function>
531                 <function name="get_antialias">
532                         <proto>int get_antialias()</proto>
533                         <code></code>
534                 </function>
536                 <function name="get_hint_metrics">
537                         <proto>int get_hint_metrics()</proto>
538                         <code></code>
539                 </function>
541                 <function name="get_hint_style">
542                         <proto>int get_hint_style()</proto>
543                         <code></code>
544                 </function>
546                 <function name="get_subpixel_order">
547                         <proto>int get_subpixel_order()</proto>
548                         <code></code>
549                 </function>
551                 <function name="set_antialias">
552                         <proto>void set_antialias([int aa])</proto>
553                         <code></code>
554                 </function>
556                 <function name="set_hint_metrics">
557                         <proto>void set_hint_metrics([int hm])</proto>
558                         <code></code>
559                 </function>
561                 <function name="set_hint_style">
562                         <proto>void set_hint_style([int hs])</proto>
563                         <code></code>
564                 </function>
565                 
566                 <function name="set_subpixel_order">
567                         <proto>void set_subpixel_order([int so])</proto>
568                         <code></code>
569                 </function>
570         </class>
572         <class name="cairoMatrix">
573                 
574                 <function name="__construct">
575                         <proto>void construct([float xx, float yx, float xy, float yy, float x0, float y0])</proto>
576                         <code></code>
577                 </function>
579                 <function name="init_rotate" access="private">
580                         <proto>object inti_rotate(float radians)</proto>
581                         <code></code>
582                 </function>
584                 <function name="invert">
585                         <proto>void invert()</proto>
586                         <code></code>
587                 </function>
589                 <function name="multiply">
590                         <proto>object multiply(object o2)</proto>
591                         <code></code>
592                 </function>
594                 <function name="rotate">
595                         <proto>void rotate(float radians)</proto>
596                         <code></code>
597                 </function>
599                 <function name="scale">
600                         <proto>void scale(float sx, float xy)</proto>
601                         <code></code>
602                 </function>
604                 <function name="transform_distance">
605                         <proto>array transform_distance(float dx, float dy)</proto>
606                         <code></code>
607                 </function>
609                 <function name="transform_point">
610                         <proto>array transform_point(float x, float y)</proto>
611                         <code></code>
612                 </function>
614                 <function name="translate">
615                         <proto>void translate(float tx, float ty)</proto>
616                         <code></code>
617                 </function>
619                 <!--Some more functions given in pyCairo ... depends on need -->
620         </class>
622         <class name="cairoPattern">
623                 
624                 <function name="__construct">
625                         <proto>void contruct()</proto>
626                         <code></code>
627                 </function>
629                 <function name="get_matrix">
630                         <proto>object get_matrix()</proto>
631                         <code></code>
632                 </function>
634                 <function name="set_matrix">
635                         <proto>void set_matrix(object m)</proto>
636                         <code></code>
637                 </function>
639         </class>
641         <class name="cairoGradient" extends="cairoPattern">
643                 <function name="__contruct">
644                         <proto>void construct()</proto>
645                         <code></code>
646                 </function>
648                 <function name="add_color_stop_rgb">
649                         <proto>void add_color_stop_rgb(float offset, float red, float green, float blue)</proto>
650                         <code></code>
651                 </function>
653                 <function name="add_color_stop_rgba">
654                         <proto>void add_color_stop_rgba(float offset, float red, float green, float blue, float alpha)</proto>
655                         <code></code>
656                 </function>
658         </class>
660         <class name="cairoLinearGradient" extends="cairoGradient">
661                 
662                 <function name="__construct">
663                         <proto>void construct(float x0, float y0, float x1, float y1)</proto>
664                         <code></code>
665                 </function>
667                 <function name="get_linear_points">
668                         <proto>array get_linear_points()</proto>
669                         <code></code>
670                 </function>
672         </class>
674         <class name="cairoRadialGradient" extends="cairoGradient">
675                 
676                 <function name="__constuct">
677                         <proto>void construct(float cx0, float cy0, float radius0, float cx1, float cy1, float radius1)</proto>
678                         <code></code>
679                 </function>
681                 <function name="get_radial_circles">
682                         <proto>array get_radial_circles()</proto>
683                         <code></code>
684                 </function>
685         
686         </class>
688         <class name="cairoSolidPattern" extends="cairoPattern">
689                 
690                 <function name="__construct">
691                         <proto>void construct(float r, float g, float b [, float a])</proto>
692                         <code></code>
693                 </function>
695                 <function name="get_rgba">
696                         <proto>array get_rgba()</proto>
697                         <code></code>
698                 </function>
700         </class>
702         <class name="cairoSurfacePattern" extends="cairoPattern">
703                 
704                 <function name="__construct">
705                         <proto>void construct(object s)</proto>
706                         <code></code>
707                 </function>
709                 <function name="get_extend">
710                         <proto>int get_extend()</proto>
711                         <code></code>
712                 </function>
713                 
714                 <function name="get_filter">
715                         <proto>int get_filter()</proto>
716                         <code></code>
717                 </function>
719                 <function name="get_surface">
720                         <proto>object get_surface()</proto>
721                         <code></code>
722                 </function>
724                 <function name="set_extend">
725                         <proto>void set_extend(int extend)</proto>
726                         <code></code>
727                 </function>
729                 <function name="set_filter">
730                         <proto>void set_filter(int filter)</proto>
731                         <code></code>
732                 </function>
734         </class>
736         <class name="cairoScaledFont">
737                 
738                 <function name="__construct">
739                         <proto>void construct(object ff, object mx1, object mx2, object fo)</proto>
740                         <code></code>
741                 </function>
743                 <function name="extents">
744                         <proto>array extents()</proto>
745                         <code></code>
746                 </function>
748                 <function name="get_font_face">
749                         <proto>object get_font_face()</proto>
750                         <code></code>
751                 </function>
753                 <function name="text_extents">
754                         <proto>array text_extents(string str)</proto>
755                         <code></code>
756                 </function>
758         </class>
759         
760         <class name="cairoSurface">
761                 
762                 <function name="__construct">
763                         <proto>void construct()</proto>
764                         <code></code>
765                 </function>
767                 <function name="create_similar">
768                         <proto>object create_similar(int content, int width, int height)</proto>
769                         <code></code>
770                 </function>
772                 <function name="finish">
773                         <proto>void finish()</proto>
774                         <code></code>
775                 </function>
777                 <function name="flush">
778                         <proto>void flush()</proto>
779                         <code></code>
780                 </function>
782                 <function name="get_content">
783                         <proto>int get_content()</proto>
784                         <code></code>
785                 </function>
787                 <function name="get_device_offset">
788                         <proto>array get_device_offset()</proto>
789                         <code></code>
790                 </function>
792                 <function name="get_font_options">
793                         <proto>object get_font_options()</proto>
794                         <code></code>
795                 </function>
797                 <function name="mark_dirty_rectangle">
798                         <proto>void mark_dirty_rectangle([int x, int y, int width, int height])</proto>
799                         <code></code>
800                 </function>
802                 <function name="set_device_offset">
803                         <proto>void set_device_offset(float x_offset, float y_offset)</proto>
804                         <code></code>
805                 </function>
807                 <function name="set_fallback_resolution">
808                         <proto>void set_fallback_resolution(float x_ppi, float y_ppi)</proto>
809                         <code></code>
810                 </function>
812                 <function name="write_to_png">
813                         <proto>void write_to_png(string file)</proto>
814                         <code></code>
815                 </function>
817         </class>
819         <class name="cairoImageSurface" extends="cairoSurface">
820                 
821                 <function name="__construct">
822                         <proto>void construct(int format, int widthm, int height)</proto>
823                         <code></code>
824                 </function>
826                 <function name="create_from_data" access="private">
827                         <proto>object create_from_data(object obj, int format, int width, int height [, int stride])</proto>
828                         <code></code>
829                 </function>
831                 <function name="create_from_png" access="private">
832                         <proto>object create_from_png(string file)</proto>
833                         <code></code>
834                 </function>
836                 <function name="get_data">
837                         <proto>string get_data()</proto>
838                         <code></code>
839                 </function>
841                 <function name="get_format">
842                         <proto>int get_format()</proto>
843                         <code></code>
844                 </function>
846                 <function name="get_height">
847                         <proto>int get_height()</proto>
848                         <code></code>
849                 </function>
851                 <function name="get_stride">
852                         <proto>int get_stride()</proto>
853                         <code></code>
854                 </function>
856                 <function name="get_width">
857                         <proto>int get_width()</proto>
858                         <code></code>
859                 </function>
861         
862         </class>
864         <class name="cairoPDFSurface" extends="cairoSurface">
865         
866                 <function name="__construct">
867                         <proto>void construct(string file, float wpts, float hpts)</proto>
868                         <code></code>
869                 </function>
871                 <function name="set_size">
872                         <proto>void set_size(float wptd, float hpts)</proto>
873                         <code></code>
874                 </function>
876         </class>
878         <class name="cairoPSSurface" extends="cairoSurface">
880                 <function name="__construct">
881                         <proto>void construct(string file, float wpts, float hpts)</proto>
882                         <code></code>
883                 </function>
885                 <function name="dsc_begin_page_setup">
886                         <proto>void dsc_begin_page_setup()</proto>
887                         <code></code>
888                 </function>
890                 <function name="dsc_begin_setup">
891                         <proto>void dsc_begin_setup()</proto>
892                         <code></code>
893                 </function>
895                 <function name="dsc_comment">
896                         <proto>void dsc_comment()</proto>
897                         <code></code>
898                 </function>
900                 <function name="set_size">
901                         <proto>void set_size(float wpts, float hpts)</proto>
902                         <code></code>
903                 </function>
905         </class>
907         <class name="cairoSVGSurface" extends="cairoSurface">
908                 
909                 <function name="__construct">
910                         <proto>void construct(string file, float wpts, float hpts)</proto>
911                         <code></code>
912                 </function>
914         </class>
916         <class name="cairoWin32Surface" extends="cairoSurface">
917                 
918                 <function name="__construct">
919                         <proto>void construct(int hdc)</proto>
920                         <code></code>
921                 </function>
923         </class>
925         <class name="cairoXlibSurface" extends="cairoSurface">
927                 <function name="__construct">
928                         <proto>void construct()</proto>
929                         <code></code>
930                 </function>
932                 <function name="get_depth">
933                         <proto>int get_depth()</proto>
934                         <code></code>
935                 </function>
937                 <function name="get_height">
938                         <proto>int get_height()</proto>
939                         <code></code>
940                 </function>
942                 <function name="get_width">
943                         <proto>int get_width()</proto>
944                         <code></code>
945                 </function>
947         </class>
949         <class name="cairoError" extends="Exception">
950                 
951         </class>
952         
953         <function name="cairo_version">
954                 <proto>int cairo_version()</proto>
955                 <code></code>
956         </function>
958         <function name="cairo_version_string">
959                 <proto>string cairo_version_string()</proto>
960                 <code></code>
961         </function>
964 </extension>