<html> <head> <title>Interface XPropertyControl</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XPropertyControl-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">inspection</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XPropertyControl</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>defines the interface for a single control in an <a href="ObjectInspector.html">ObjectInspector</a> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0.3</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#isModified">isModified</a></td> <td class="imsum_right">determines whether the control content is currently modified </td> </tr> <tr> <td class="imsum_left"><a href="#notifyModifiedValue">notifyModifiedValue</a></td> <td class="imsum_right">notifies the context in which the control lives of the current control value, if this value is currently modified </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="isModified" class="membertitle">isModified</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isModified</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the control content is currently modified </dd> <dd><p>An <a href="XPropertyControl.html">XPropertyControl</a> internally manages a flag indicating whether its content is modified. This flag is reset to <b>false</b> every time our <a href="#ControlContext">ControlContext</a> is notified of our current value. Also, the control implementation must set this flag to <b>true</b> if and only if the user changed the control content.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#notifyModifiedValue">notifyModifiedValue</a>, <a href="#ControlContext">ControlContext</a>, <a href="XPropertyControlContext.html">XPropertyControlContext</a>::<a href="XPropertyControlContext.html#valueChanged">valueChanged</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="notifyModifiedValue" class="membertitle">notifyModifiedValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>notifyModifiedValue</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies the context in which the control lives of the current control value, if this value is currently modified </dd> <dt><b>See also</b></dt> <dd><a href="#isModified">isModified</a>, <a href="#ControlContext">ControlContext</a>, XPropertyControlListener::valueChanged</dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#ControlType">ControlType</a></td> <td class="imsum_right">denotes the type of the control, as one of the <a href="PropertyControlType.html">PropertyControlType</a> constants </td> </tr> <tr> <td class="imsum_left"><a href="#Value">Value</a></td> <td class="imsum_right">denotes the current content of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#ValueType">ValueType</a></td> <td class="imsum_right">denotes the value type of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#ControlContext">ControlContext</a></td> <td class="imsum_right">specifies the context of the control within the <a href="ObjectInspector.html">ObjectInspector</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#ControlWindow">ControlWindow</a></td> <td class="imsum_right">denotes the window which is the real UI representation of the property control. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="ControlType" class="membertitle">ControlType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] short <b>ControlType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the type of the control, as one of the <a href="PropertyControlType.html">PropertyControlType</a> constants </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Value" class="membertitle">Value</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>any <b>Value</b><dl> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/IllegalTypeException.html">IllegalTypeException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>denotes the current content of the control. </dd> <dd><p>At every point in time, this value is either <b>void</b>, or of the type described by <a href="#ValueType">ValueType</a>.</p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::beans::IllegalTypeException if an attempt is made to set a value which is not <b>void</b> and whose type does not equal <a href="#ValueType">ValueType</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ValueType" class="membertitle">ValueType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] type <b>ValueType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the value type of the control. </dd> <dt><b>See also</b></dt> <dd><a href="#Value">Value</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ControlContext" class="membertitle">ControlContext</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XPropertyControlContext.html">XPropertyControlContext</a> <b>ControlContext</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the context of the control within the <a href="ObjectInspector.html">ObjectInspector</a>. </dd> <dd><p>The property control should actively notify its state changes to the context. In particular, changes in the focus and the value of the control must be notified. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ControlWindow" class="membertitle">ControlWindow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a> <b>ControlWindow</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the window which is the real UI representation of the property control. </dd> <dd><p>The <a href="ObjectInspector.html">ObjectInspector</a> will automatically position and size this control as needed, care for its Z-order, and so on.</p> <p>This Window must not be <b>NULL</b>, else the whole control is not usable.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>