<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkCaptionWidget Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkCaptionWidget Class Reference</h1><!-- doxytag: class="vtkCaptionWidget" --><!-- doxytag: inherits="vtkBorderWidget" --><code>#include <<a class="el" href="a05462.html">vtkCaptionWidget.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkCaptionWidget:</div>
<div class="dynsection">
<p><center><img src="a08430.png" border="0" usemap="#a08431" alt="Inheritance graph"></center>
<map name="a08431">
<area shape="rect" href="a00192.html" title="place a border around a 2D rectangular region" alt="" coords="21,304,144,331"><area shape="rect" href="a00091.html" title="define the API for widget / widget representation" alt="" coords="16,230,149,256"><area shape="rect" href="a00902.html" title="an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor..." alt="" coords="5,155,160,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="43,80,123,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="28,6,137,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkCaptionWidget:</div>
<div class="dynsection">
<p><center><img src="a08432.png" border="0" usemap="#a08433" alt="Collaboration graph"></center>
<map name="a08433">
<area shape="rect" href="a00192.html" title="place a border around a 2D rectangular region" alt="" coords="2783,979,2905,1005"><area shape="rect" href="a00091.html" title="define the API for widget / widget representation" alt="" coords="2821,901,2955,928"><area shape="rect" href="a00679.html" title="a general widget for moving handles" alt="" coords="2929,979,3055,1005"><area shape="rect" href="a00902.html" title="an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor..." alt="" coords="2571,293,2725,320"><area shape="rect" href="a01091.html" title="manage contention for cursors and other resources" alt="" coords="2452,395,2601,421"><area shape="rect" href="a01491.html" title="platform-independent render window interaction including picking and frame rate control..." alt="" coords="2317,512,2509,539"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="1420,96,1500,123"><area shape="rect" href="a01886.html" title="window superclass for vtkRenderWindow" alt="" coords="2032,512,2120,539"><area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="1696,187,1797,213"><area shape="rect" href="a01150.html" title="An adapter between a vtkPainter and a rendering device." alt="" coords="2115,240,2288,267"><area shape="rect" href="a00086.html" title="define API for picking subclasses" alt="" coords="316,811,444,837"><area shape="rect" href="a01833.html" title="abstract specification for Viewports" alt="" coords="1505,629,1599,656"><area shape="rect" href="a01317.html" title="abstract superclass for all actors, volumes and annotations" alt="" coords="1424,395,1493,421"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="545,187,655,213"><area shape="rect" href="a01149.html" title="Abstract class for drawing poly data." alt="" coords="341,293,424,320"><area shape="rect" href="a00681.html" title="manager for OpenGL-based selection." alt="" coords="2624,811,2773,837"><area shape="rect" href="a01482.html" title="Render the props of a vtkRenderer." alt="" coords="455,240,604,267"><area shape="rect" href="a01485.html" title="Perform part of the rendering of a vtkRenderer." alt="" coords="491,448,605,475"><area shape="rect" href="a00954.html" title="a virtual light for 3D rendering" alt="" coords="1184,293,1253,320"><area shape="rect" href="a00998.html" title="represent and manipulate 4x4 transformation matrices" alt="" coords="1143,187,1241,213"><area shape="rect" href="a00227.html" title="a virtual camera for 3D rendering" alt="" coords="805,512,893,539"><area shape="rect" href="a01876.html" title="map VTK events into widget events" alt="" coords="2967,293,3145,320"><area shape="rect" href="a00469.html" title="a complete specification of a VTK event including all modifiers" alt="" coords="2965,187,3040,213"><area shape="rect" href="a01874.html" title="map widget events into callbacks" alt="" coords="2965,395,3147,421"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="1405,5,1515,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="985,96,1148,123"><area shape="rect" href="a00291.html" title="superclass for callback/observer methods" alt="" coords="2337,96,2441,123"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="217,5,327,32"><area shape="rect" href="a01480.html" title="abstract specification for renderers" alt="" coords="1320,720,1416,747"><area shape="rect" href="a01877.html" title="abstract class defines interface between the widget and widget representation classes..." alt="" coords="1327,811,1500,837"><area shape="rect" href="a01489.html" title="create a window for renderers to draw into" alt="" coords="2141,629,2275,656"><area shape="rect" href="a01481.html" title="a list of renderers" alt="" coords="1943,344,2100,371"><area shape="rect" href="a01321.html" title="a list of Props" alt="" coords="1144,395,1272,421"><area shape="rect" href="a00143.html" title="a list of nodes that form an assembly path" alt="" coords="1681,512,1807,539"><area shape="rect" href="a00144.html" title="a list of lists of props representing an assembly hierarchy" alt="" coords="1576,293,1709,320"><area shape="rect" href="a00956.html" title="a list of lights" alt="" coords="1779,448,1909,475"><area shape="rect" href="a00346.html" title="a list of Cullers" alt="" coords="1800,344,1936,371"><area shape="rect" href="a00094.html" title="a list of 2D actors" alt="" coords="1407,512,1556,539"><area shape="rect" href="a00095.html" title="a list of actors" alt="" coords="1121,576,1255,603"><area shape="rect" href="a01841.html" title="a list of volumes" alt="" coords="1264,576,1411,603"><area shape="rect" href="a00717.html" title="DEPRECATED A vtkPolyDataPainter that colors each polygon with a color coded integer..." alt="" coords="304,512,467,539"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="479,96,660,123"><area shape="rect" href="a01723.html" title="describes linear transformations via a 4x4 matrix" alt="" coords="1296,395,1400,421"><area shape="rect" href="a01268.html" title="Abstract class for drawing poly data." alt="" coords="356,395,495,421"><area shape="rect" href="a00722.html" title="dynamic, self-adjusting array of vtkIdType" alt="" coords="217,395,332,421"><area shape="rect" href="a00356.html" title="abstract superclass for arrays of numeric data" alt="" coords="216,293,317,320"><area shape="rect" href="a00696.html" title="superclass for homogeneous transformations" alt="" coords="824,293,1016,320"><area shape="rect" href="a01207.html" title="describes a 4x4 matrix transformation" alt="" coords="723,395,896,421"><area shape="rect" href="a00226.html" title="supports function callbacks" alt="" coords="3115,187,3269,213"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a08434.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
widget for placing a caption (text plus leader)
<p>
This class provides support for interactively placing a caption on the 2D overlay plane. A caption is defined by some text with a leader (e.g., arrow) that points from the text to a point in the scene. The caption is represented by a <a class="el" href="a00234.html" title="represents vtkCaptionWidget in the scene">vtkCaptionRepresentation</a>. It uses the event bindings of its superclass (<a class="el" href="a00192.html" title="place a border around a 2D rectangular region">vtkBorderWidget</a>) to control the placement of the text, and adds the ability to move the attachment point around. In addition, when the caption text is selected, the widget emits a ActivateEvent that observers can watch for. This is useful for opening GUI dialogoues to adjust font characteristics, etc. (Please see the superclass for a description of event bindings.)<p>
Note that this widget extends the behavior of its superclass <a class="el" href="a00192.html" title="place a border around a 2D rectangular region">vtkBorderWidget</a>. The end point of the leader can be selected and moved around with an internal <a class="el" href="a00679.html" title="a general widget for moving handles">vtkHandleWidget</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00192.html" title="place a border around a 2D rectangular region">vtkBorderWidget</a> <a class="el" href="a01703.html" title="widget for placing text on overlay plane">vtkTextWidget</a></dd></dl>
<dl class="user" compact><dt><b>Events:</b></dt><dd><a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fe3be316361b18c911f1655da2896b8556">vtkCommand::EndInteractionEvent</a> <a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fec29906f21d68334a1fb26f6c4fddef02">vtkCommand::InteractionEvent</a> <a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fe51920c61b5ecd5e68068ec0d53dae020">vtkCommand::StartInteractionEvent</a></dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_3.html#c2_vtk_t_vtkCaptionWidget">vtkCaptionWidget (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a05462.html#l00055">55</a> of file <a class="el" href="a05462.html">vtkCaptionWidget.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00192.html">vtkBorderWidget</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#d8552ffe7cba973d60cd6c1f9dcb032c">Superclass</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#7ea9772e96d437aa91f220155dc09e88">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00235.html">vtkCaptionWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#0f1acf875c6a85cbaa52fda028033767">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#0345be33830c87047733ace02bf8d5eb">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#ba90fde9cdf430d9e40b762c3249c0d4">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#3e36903f15d6347cdbcf423bb956497c">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#7c29bf3fba21d75bf7fdf4afbb8db6ba">SetEnabled</a> (int enabling)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#722aa5de23e8d70e3b988e8fb61ab675">CreateDefaultRepresentation</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#a122f3ac7b2208187146e0131540de43">SetRepresentation</a> (<a class="el" href="a00234.html">vtkCaptionRepresentation</a> *r)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#ab1e5a184d8516ad05d43395aa5285ce">SetCaptionActor2D</a> (<a class="el" href="a00233.html">vtkCaptionActor2D</a> *capActor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00233.html">vtkCaptionActor2D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#8c2e80aff8ebded760307360e8aa10f0">GetCaptionActor2D</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00235.html">vtkCaptionWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#5508171ef089256a8ea1ee4cf161b3a5">New</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#6e91daf7ef578949affc6b3cc1163d9b">vtkCaptionWidget</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#63d2ddb320e1838e4e1dfe2b61b56d42">~vtkCaptionWidget</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#4c2161c1c85ab0e71c37d265c98423e0">StartAnchorInteraction</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#18982aa5690305d6a69be09ad34b82e1">AnchorInteraction</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#e2c2eea56bb93e0fbfaaa1e68870ae77">EndAnchorInteraction</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vtkCaptionAnchorCallback * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#fe6fbf258959232a6eed188d40fc004c">AnchorCallback</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00679.html">vtkHandleWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#85fccbe6cda32a77d42d21efa68b73e2">HandleWidget</a></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00235.html#9ceb39f255f7a72d6ca87c9d86555326">vtkCaptionAnchorCallback</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="d8552ffe7cba973d60cd6c1f9dcb032c"></a><!-- doxytag: member="vtkCaptionWidget::Superclass" ref="d8552ffe7cba973d60cd6c1f9dcb032c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00192.html">vtkBorderWidget</a> <a class="el" href="a00192.html">vtkCaptionWidget::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00192.html#f625327b6763b2bc4f8693c3f39cc4c3">vtkBorderWidget</a>.</p>
<p>Definition at line <a class="el" href="a05462.html#l00063">63</a> of file <a class="el" href="a05462.html">vtkCaptionWidget.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="6e91daf7ef578949affc6b3cc1163d9b"></a><!-- doxytag: member="vtkCaptionWidget::vtkCaptionWidget" ref="6e91daf7ef578949affc6b3cc1163d9b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkCaptionWidget::vtkCaptionWidget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="63d2ddb320e1838e4e1dfe2b61b56d42"></a><!-- doxytag: member="vtkCaptionWidget::~vtkCaptionWidget" ref="63d2ddb320e1838e4e1dfe2b61b56d42" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkCaptionWidget::~vtkCaptionWidget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5508171ef089256a8ea1ee4cf161b3a5"></a><!-- doxytag: member="vtkCaptionWidget::New" ref="5508171ef089256a8ea1ee4cf161b3a5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00235.html">vtkCaptionWidget</a>* vtkCaptionWidget::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Instantiate this class.
<p>Reimplemented from <a class="el" href="a00192.html#5880f6b2142ebc31f7d229e399eef334">vtkBorderWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="0345be33830c87047733ace02bf8d5eb"></a><!-- doxytag: member="vtkCaptionWidget::GetClassName" ref="0345be33830c87047733ace02bf8d5eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkCaptionWidget::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00192.html#8689b578761c16f7c866aba6c05c9889">vtkBorderWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="7ea9772e96d437aa91f220155dc09e88"></a><!-- doxytag: member="vtkCaptionWidget::IsTypeOf" ref="7ea9772e96d437aa91f220155dc09e88" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkCaptionWidget::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00192.html#912bdd4cd7d10278094b9a4572534dd9">vtkBorderWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="ba90fde9cdf430d9e40b762c3249c0d4"></a><!-- doxytag: member="vtkCaptionWidget::IsA" ref="ba90fde9cdf430d9e40b762c3249c0d4" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkCaptionWidget::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00192.html#d7c70b02108ab0845616559bb88c51de">vtkBorderWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="0f1acf875c6a85cbaa52fda028033767"></a><!-- doxytag: member="vtkCaptionWidget::SafeDownCast" ref="0f1acf875c6a85cbaa52fda028033767" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00235.html">vtkCaptionWidget</a>* vtkCaptionWidget::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00192.html#81bd068dd317191d704a2192d4cf43be">vtkBorderWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="3e36903f15d6347cdbcf423bb956497c"></a><!-- doxytag: member="vtkCaptionWidget::PrintSelf" ref="3e36903f15d6347cdbcf423bb956497c" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionWidget::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00192.html#7c60f80a5e124cd3e88b18acb4387e37">vtkBorderWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="7c29bf3fba21d75bf7fdf4afbb8db6ba"></a><!-- doxytag: member="vtkCaptionWidget::SetEnabled" ref="7c29bf3fba21d75bf7fdf4afbb8db6ba" args="(int enabling)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkCaptionWidget::SetEnabled </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>enabling</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Override superclasses' <a class="el" href="a00235.html#7c29bf3fba21d75bf7fdf4afbb8db6ba">SetEnabled()</a> method because the caption leader has its own dedicated widget.
<p>Reimplemented from <a class="el" href="a00091.html#0da0171256058b829eb2d99ab75e793e">vtkAbstractWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="a122f3ac7b2208187146e0131540de43"></a><!-- doxytag: member="vtkCaptionWidget::SetRepresentation" ref="a122f3ac7b2208187146e0131540de43" args="(vtkCaptionRepresentation *r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionWidget::SetRepresentation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00234.html">vtkCaptionRepresentation</a> * </td>
<td class="paramname"> <em>r</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify an instance of <a class="el" href="a01877.html" title="abstract class defines interface between the widget and widget representation classes...">vtkWidgetRepresentation</a> used to represent this widget in the scene. Note that the representation is a subclass of <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> so it can be added to the renderer independent of the widget.
<p>Definition at line <a class="el" href="a05462.html#l00075">75</a> of file <a class="el" href="a05462.html">vtkCaptionWidget.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="ab1e5a184d8516ad05d43395aa5285ce"></a><!-- doxytag: member="vtkCaptionWidget::SetCaptionActor2D" ref="ab1e5a184d8516ad05d43395aa5285ce" args="(vtkCaptionActor2D *capActor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionWidget::SetCaptionActor2D </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00233.html">vtkCaptionActor2D</a> * </td>
<td class="paramname"> <em>capActor</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify a <a class="el" href="a00233.html" title="draw text label associated with a point">vtkCaptionActor2D</a> to manage. This is convenient, alternative method to <a class="el" href="a00235.html#a122f3ac7b2208187146e0131540de43">SetRepresentation()</a>. It internally create a <a class="el" href="a00234.html" title="represents vtkCaptionWidget in the scene">vtkCaptionRepresentation</a> and then invokes <a class="el" href="a00234.html#ffa17bebbc021589696242587518c6f4">vtkCaptionRepresentation::SetCaptionActor2D()</a>.
</div>
</div><p>
<a class="anchor" name="8c2e80aff8ebded760307360e8aa10f0"></a><!-- doxytag: member="vtkCaptionWidget::GetCaptionActor2D" ref="8c2e80aff8ebded760307360e8aa10f0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00233.html">vtkCaptionActor2D</a>* vtkCaptionWidget::GetCaptionActor2D </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify a <a class="el" href="a00233.html" title="draw text label associated with a point">vtkCaptionActor2D</a> to manage. This is convenient, alternative method to <a class="el" href="a00235.html#a122f3ac7b2208187146e0131540de43">SetRepresentation()</a>. It internally create a <a class="el" href="a00234.html" title="represents vtkCaptionWidget in the scene">vtkCaptionRepresentation</a> and then invokes <a class="el" href="a00234.html#ffa17bebbc021589696242587518c6f4">vtkCaptionRepresentation::SetCaptionActor2D()</a>.
</div>
</div><p>
<a class="anchor" name="722aa5de23e8d70e3b988e8fb61ab675"></a><!-- doxytag: member="vtkCaptionWidget::CreateDefaultRepresentation" ref="722aa5de23e8d70e3b988e8fb61ab675" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionWidget::CreateDefaultRepresentation </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create the default widget representation if one is not set.
<p>Reimplemented from <a class="el" href="a00192.html#16406840191ab409fc912bef990202f9">vtkBorderWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="4c2161c1c85ab0e71c37d265c98423e0"></a><!-- doxytag: member="vtkCaptionWidget::StartAnchorInteraction" ref="4c2161c1c85ab0e71c37d265c98423e0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionWidget::StartAnchorInteraction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="18982aa5690305d6a69be09ad34b82e1"></a><!-- doxytag: member="vtkCaptionWidget::AnchorInteraction" ref="18982aa5690305d6a69be09ad34b82e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionWidget::AnchorInteraction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e2c2eea56bb93e0fbfaaa1e68870ae77"></a><!-- doxytag: member="vtkCaptionWidget::EndAnchorInteraction" ref="e2c2eea56bb93e0fbfaaa1e68870ae77" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionWidget::EndAnchorInteraction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="9ceb39f255f7a72d6ca87c9d86555326"></a><!-- doxytag: member="vtkCaptionWidget::vtkCaptionAnchorCallback" ref="9ceb39f255f7a72d6ca87c9d86555326" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class vtkCaptionAnchorCallback<code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05462.html#l00107">107</a> of file <a class="el" href="a05462.html">vtkCaptionWidget.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="fe6fbf258959232a6eed188d40fc004c"></a><!-- doxytag: member="vtkCaptionWidget::AnchorCallback" ref="fe6fbf258959232a6eed188d40fc004c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkCaptionAnchorCallback* <a class="el" href="a00235.html#fe6fbf258959232a6eed188d40fc004c">vtkCaptionWidget::AnchorCallback</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05462.html#l00096">96</a> of file <a class="el" href="a05462.html">vtkCaptionWidget.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="85fccbe6cda32a77d42d21efa68b73e2"></a><!-- doxytag: member="vtkCaptionWidget::HandleWidget" ref="85fccbe6cda32a77d42d21efa68b73e2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00679.html">vtkHandleWidget</a>* <a class="el" href="a00235.html#85fccbe6cda32a77d42d21efa68b73e2">vtkCaptionWidget::HandleWidget</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05462.html#l00099">99</a> of file <a class="el" href="a05462.html">vtkCaptionWidget.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Widgets/<a class="el" href="a05462.html">vtkCaptionWidget.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:55:54 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
238
