<html> <head> <title>Constants' Group ContentAction</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="navimainnone">Use</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="#Constants" class="navisub">Constants</a></td> <td class="navisub"><a href="#ConstantDetails" class="navisub">Constants' 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">ucb</a> :: </p> </td> </tr> <tr> <td class="title">constants group ContentAction</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies actions which can be transported with content events. </dd> <dd><p> The situations under which contents will send ContentEvents of the various action types are described below. The description is broken into a list of useful definitions, a list of events that happen to contents, and a list of reactions taken by contents in response to those events. </p> <p> The definitions are as follows: </p> <table border =1> <tr><td>D1</td><td>A content C has an identifier id(C).</td></tr> <tr><td>D2</td><td>A content C is in one of two states, Alive or Deleted. </td></tr> <tr><td>D3</td><td>A folder content F has a set of children H(F) that is a set of content identifiers. For example, an "open" command will usually return a subset of the contents denoted by H(F).</td></tr> </table> <p> The events that can happen to contents (and that are of interest in this context) are listed next. Note that "event" here does not mean an ContentEvent, but rather some event that occurs either because some content processes a command, or because a content gets informed about a relevant change in the underlying system it represents. </p> <table border =1> <tr><td>E1</td><td>The identifier of a content C changes from id1(C) == A to id2(C) == B, denoted as E1(C: A->B). For example, this event may occur when content C processes a "setPropertyValues" command changing its "Title" property, or when a folder that hierarchically contains C changes its identity.</td></tr> <tr><td>E2</td><td>The state of a content C changes from Alive to Deleted, denoted as E2(C). For example, this event may occur when content C processes a "delete" command, or when a content representing an IMAP message gets informed by the IMAP server that the message has been deleted.</td></tr> <tr><td>E3</td><td>The set of children of a folder content F is enlarged by some identifier A (that was not previously in that set, i.e., !(A in H1(F)) && (A in H2(F))), denoted as E3(F, A). For example, this event may occur when a new content created at folder F processes its "insert" command, or when a folder representing an IMAP mailbox gets informed by the IMAP server that a new message has arrived at that mailbox.</td></tr> </table> <p> Finally, the list of reactions taken by contents in response to the above events gives a description of what kinds of ContentEvents are sent in which situations: </p> <table border =1> <tr><td>R1</td><td>E1(C: A->B) results in C sending an EXCHANGED ContentEvent, which then results in the following: All folders F that used to have A as a child, but will not have B as a child, i.e., (A in H1(F)) && !(B in H2(F)), send a REMOVED ContentEvent.</td></tr> <tr><td>R2</td><td>E2(C) results in C sending a DELETED ContentEvent, which then results in the following: All folders F that used to have A as a child, but will not continue to have A as a child, i.e., (A in H1(F)) && !(A in H2(F)), send a REMOVED event.</td></tr> <tr><td>R3</td><td>E3(F, A) results in F sending an INSERTED event.</td></tr> </table> </dd> </dl> </td> </tr> </table> <hr> <a name="Constants"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constants</td> </tr> <tr> <td class="imsum_left"><a href="#INSERTED">INSERTED</a></td> <td class="imsum_right">A content was inserted into a folder content (i.e., while updating the folder). </td> </tr> <tr> <td class="imsum_left"><a href="#REMOVED">REMOVED</a></td> <td class="imsum_right">A content was removed from a folder content, but not physically destroyed (i.e., due to rules just applied to the folder). </td> </tr> <tr> <td class="imsum_left"><a href="#DELETED">DELETED</a></td> <td class="imsum_right">A content was physically destroyed. </td> </tr> <tr> <td class="imsum_left"><a href="#EXCHANGED">EXCHANGED</a></td> <td class="imsum_right">This Action indicates that a content has changed its identity (i.e. after renaming a file system folder). </td> </tr> <tr> <td class="imsum_left"><a href="#SEARCH_MATCHED">SEARCH_MATCHED</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b>This is obsolete and should no longer be used. </td> </tr> </table> <a name="ConstantDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constants' Details</td> </tr> <tr> <td class="imdetail"><a name="INSERTED" class="membertitle">INSERTED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>INSERTED</b> = 0;<hr> <dl> <dt><b>Description</b></dt> <dd>A content was inserted into a folder content (i.e., while updating the folder). </dd> <dd><p>This action must be notified at the listeners of the folder content. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="REMOVED" class="membertitle">REMOVED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>REMOVED</b> = 1;<hr> <dl> <dt><b>Description</b></dt> <dd>A content was removed from a folder content, but not physically destroyed (i.e., due to rules just applied to the folder). </dd> <dd><p>This action must be notified at the listeners of the folder content. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DELETED" class="membertitle">DELETED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>DELETED</b> = 2;<hr> <dl> <dt><b>Description</b></dt> <dd>A content was physically destroyed. </dd> <dd><p>Events containing this action may be generated at any time. So a content event listener should be prepared to get notified the "death" of the related content! <p>This action must be notified at the listeners of the deleted content. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EXCHANGED" class="membertitle">EXCHANGED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>EXCHANGED</b> = 4;<hr> <dl> <dt><b>Description</b></dt> <dd>This Action indicates that a content has changed its identity (i.e. after renaming a file system folder). </dd> <dd><p>This action must be notified at the listeners of the exchanged content. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SEARCH_MATCHED" class="membertitle">SEARCH_MATCHED</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>SEARCH_MATCHED</b> = 128;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>This is obsolete and should no longer be used. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
