home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / Canvas / Item.pod < prev    next >
Encoding:
Text File  |  2005-12-16  |  5.1 KB  |  386 lines

  1. =head1 NAME
  2.  
  3. Gnome2::Canvas::Item
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Object
  8.   +----Gtk2::Object
  9.        +----Gnome2::Canvas::Item
  10.  
  11.  
  12. =head1 METHODS
  13.  
  14. =head2 item = Gnome2::Canvas::Item-E<gt>B<new> ($parent, $object_class, ...)
  15.  
  16. =over
  17.  
  18. =over
  19.  
  20. =item * $parent (Gnome2::Canvas::Group) 
  21.  
  22. =item * $object_class (string) 
  23.  
  24. =item * ... (list) property name => value pairs
  25.  
  26. =back
  27.  
  28. Factory constructor for Gnome2::Canvas::Item subclasses.
  29.  
  30. =back
  31.  
  32. =head2 $item-E<gt>B<affine_absolute> ($affine)
  33.  
  34. =over
  35.  
  36. =over
  37.  
  38. =item * $affine (arrayref) affine transformation matrix
  39.  
  40. =back
  41.  
  42. Replaces I<$item>'s transformation matrix.
  43.  
  44. =back
  45.  
  46. =head2 $item-E<gt>B<affine_relative> ($affine)
  47.  
  48. =over
  49.  
  50. =over
  51.  
  52. =item * $affine (arrayref) affine transformation matrix
  53.  
  54. =back
  55.  
  56. Combines I<$affine> with I<$item>'s current transformation.
  57.  
  58. =back
  59.  
  60. =head2 (x1, y1, x2, y2) = $item-E<gt>B<get_bounds> 
  61.  
  62. =over
  63.  
  64. =back
  65.  
  66. =head2 $canvas = $item->B<canvas>
  67.  
  68. =over
  69.  
  70. Fetch the Gnome2::Canvas to which I<$item> is attached.
  71.  
  72. =back
  73.  
  74. =head2 grabstatus = $item-E<gt>B<grab> ($event_mask, $cursor, $etime=GDK_CURRENT_TIME)
  75.  
  76. =over
  77.  
  78. =over
  79.  
  80. =item * $event_mask (Gtk2::Gdk::EventMask) 
  81.  
  82. =item * $cursor (Gtk2::Gdk::Cursor) 
  83.  
  84. =item * $etime (unsigned) 
  85.  
  86. =back
  87.  
  88. =back
  89.  
  90. =head2 $item-E<gt>B<grab_focus> 
  91.  
  92. =over
  93.  
  94. =back
  95.  
  96. =head2 $item-E<gt>B<hide> 
  97.  
  98. =over
  99.  
  100. =back
  101.  
  102. =head2 $affine = $item->B<i2c_affine>
  103.  
  104. =over
  105.  
  106. =over
  107.  
  108. =back
  109.  
  110. Fetch the affine transform that converts from item-relative coordinates to
  111. canvas pixel coordinates.
  112.  
  113. Note: This method was completely broken for all
  114. $Gnome2::Canvas::VERSION < 1.002.
  115.  
  116. =back
  117.  
  118. =head2 (x, y) = $item-E<gt>B<i2w> ($x, $y)
  119.  
  120. =over
  121.  
  122. =over
  123.  
  124. =item * $x (double) 
  125.  
  126. =item * $y (double) 
  127.  
  128. =back
  129.  
  130. =back
  131.  
  132. =head2 $affine = $item->B<i2w_affine>
  133.  
  134. =over
  135.  
  136. =over
  137.  
  138. =back
  139.  
  140. Fetch the affine transform that converts from item's coordinate system to
  141. world coordinates.
  142.  
  143. Note: This method was completely broken for all
  144. $Gnome2::Canvas::VERSION < 1.002.
  145.  
  146. =back
  147.  
  148. =head2 $item-E<gt>B<lower> ($positions)
  149.  
  150. =over
  151.  
  152. =over
  153.  
  154. =item * $positions (integer) 
  155.  
  156. =back
  157.  
  158. =back
  159.  
  160. =head2 $item-E<gt>B<lower_to_bottom> 
  161.  
  162. =over
  163.  
  164. =back
  165.  
  166. =head2 $item-E<gt>B<move> ($dx, $dy)
  167.  
  168. =over
  169.  
  170. =over
  171.  
  172. =item * $dx (double) 
  173.  
  174. =item * $dy (double) 
  175.  
  176. =back
  177.  
  178. =back
  179.  
  180. =head2 $canvasgroup = $item->B<parent>
  181.  
  182. =over
  183.  
  184. Fetch I<$item>'s parent group item.
  185.  
  186. =back
  187.  
  188. =head2 $item-E<gt>B<raise> ($positions)
  189.  
  190. =over
  191.  
  192. =over
  193.  
  194. =item * $positions (integer) 
  195.  
  196. =back
  197.  
  198. =back
  199.  
  200. =head2 $item-E<gt>B<raise_to_top> 
  201.  
  202. =over
  203.  
  204. =back
  205.  
  206. =head2 $item-E<gt>B<reparent> ($new_group)
  207.  
  208. =over
  209.  
  210. =over
  211.  
  212. =item * $new_group (Gnome2::Canvas::Group) 
  213.  
  214. =back
  215.  
  216. =back
  217.  
  218. =head2 $item-E<gt>B<request_update> 
  219.  
  220. =over
  221.  
  222. =back
  223.  
  224. =head2 $item-E<gt>B<reset_bounds> 
  225.  
  226. =over
  227.  
  228. Reset the bounding box of I<$item> to an empty rectangle.
  229.  
  230. =back
  231.  
  232. =head2 $item-E<gt>B<show> 
  233.  
  234. =over
  235.  
  236. =back
  237.  
  238. =head2 $item-E<gt>B<ungrab> ($etime=GDK_CURRENT_TIME)
  239.  
  240. =over
  241.  
  242. =over
  243.  
  244. =item * $etime (unsigned) 
  245.  
  246. =back
  247.  
  248. =back
  249.  
  250. =head2 $item-E<gt>B<update_bbox> ($x1, $y1, $x2, $y2)
  251.  
  252. =over
  253.  
  254. =over
  255.  
  256. =item * $x1 (integer) 
  257.  
  258. =item * $y1 (integer) 
  259.  
  260. =item * $x2 (integer) 
  261.  
  262. =item * $y2 (integer) 
  263.  
  264. =back
  265.  
  266. Set I<$item>'s bounding box to a new rectangle, and request a full repaint.
  267.  
  268. =back
  269.  
  270. =head2 (x, y) = $item-E<gt>B<w2i> ($x, $y)
  271.  
  272. =over
  273.  
  274. =over
  275.  
  276. =item * $x (double) 
  277.  
  278. =item * $y (double) 
  279.  
  280. =back
  281.  
  282. =back
  283.  
  284.  
  285. =head1 PROPERTIES
  286.  
  287. =over
  288.  
  289. =item 'parent' (Gnome2::Canvas::Item : readable / writable)
  290.  
  291. =back
  292.  
  293.  
  294. =head1 SIGNALS
  295.  
  296. =over
  297.  
  298. =item boolean = B<event> (Gnome2::Canvas::Item, Gtk2::Gdk::Event)
  299.  
  300. =back
  301.  
  302.  
  303. =head1 ENUMS AND FLAGS
  304.  
  305. =head2 flags Gtk2::Gdk::EventMask
  306.  
  307. =over
  308.  
  309. =item * 'exposure-mask' / 'GDK_EXPOSURE_MASK'
  310.  
  311. =item * 'pointer-motion-mask' / 'GDK_POINTER_MOTION_MASK'
  312.  
  313. =item * 'pointer-motion-hint-mask' / 'GDK_POINTER_MOTION_HINT_MASK'
  314.  
  315. =item * 'button-motion-mask' / 'GDK_BUTTON_MOTION_MASK'
  316.  
  317. =item * 'button1-motion-mask' / 'GDK_BUTTON1_MOTION_MASK'
  318.  
  319. =item * 'button2-motion-mask' / 'GDK_BUTTON2_MOTION_MASK'
  320.  
  321. =item * 'button3-motion-mask' / 'GDK_BUTTON3_MOTION_MASK'
  322.  
  323. =item * 'button-press-mask' / 'GDK_BUTTON_PRESS_MASK'
  324.  
  325. =item * 'button-release-mask' / 'GDK_BUTTON_RELEASE_MASK'
  326.  
  327. =item * 'key-press-mask' / 'GDK_KEY_PRESS_MASK'
  328.  
  329. =item * 'key-release-mask' / 'GDK_KEY_RELEASE_MASK'
  330.  
  331. =item * 'enter-notify-mask' / 'GDK_ENTER_NOTIFY_MASK'
  332.  
  333. =item * 'leave-notify-mask' / 'GDK_LEAVE_NOTIFY_MASK'
  334.  
  335. =item * 'focus-change-mask' / 'GDK_FOCUS_CHANGE_MASK'
  336.  
  337. =item * 'structure-mask' / 'GDK_STRUCTURE_MASK'
  338.  
  339. =item * 'property-change-mask' / 'GDK_PROPERTY_CHANGE_MASK'
  340.  
  341. =item * 'visibility-notify-mask' / 'GDK_VISIBILITY_NOTIFY_MASK'
  342.  
  343. =item * 'proximity-in-mask' / 'GDK_PROXIMITY_IN_MASK'
  344.  
  345. =item * 'proximity-out-mask' / 'GDK_PROXIMITY_OUT_MASK'
  346.  
  347. =item * 'substructure-mask' / 'GDK_SUBSTRUCTURE_MASK'
  348.  
  349. =item * 'scroll-mask' / 'GDK_SCROLL_MASK'
  350.  
  351. =item * 'all-events-mask' / 'GDK_ALL_EVENTS_MASK'
  352.  
  353. =back
  354.  
  355.  
  356. =head2 enum Gtk2::Gdk::GrabStatus
  357.  
  358. =over
  359.  
  360. =item * 'success' / 'GDK_GRAB_SUCCESS'
  361.  
  362. =item * 'already-grabbed' / 'GDK_GRAB_ALREADY_GRABBED'
  363.  
  364. =item * 'invalid-time' / 'GDK_GRAB_INVALID_TIME'
  365.  
  366. =item * 'not-viewable' / 'GDK_GRAB_NOT_VIEWABLE'
  367.  
  368. =item * 'frozen' / 'GDK_GRAB_FROZEN'
  369.  
  370. =back
  371.  
  372.  
  373.  
  374. =head1 SEE ALSO
  375.  
  376. L<Gnome2::Canvas>, L<Glib::Object>, L<Gtk2::Object>
  377.  
  378. =head1 COPYRIGHT
  379.  
  380. Copyright (C) 2003-2004 by the Gtk2-Perl Team.
  381.  
  382. This software is licensed under the LGPL; see L<Gnome2::Canvas> for a full notice.
  383.  
  384. =cut
  385.  
  386.