home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / Canvas / Item.pod < prev    next >
Encoding:
Text File  |  2008-06-14  |  5.2 KB  |  387 lines

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