<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>libglom-1.22: Glom::TranslatableItem Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libglom-1.22  <span id="projectnumber">1.22.5</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceGlom.html">Glom</a></li><li class="navelem"><a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="classGlom_1_1TranslatableItem-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Glom::TranslatableItem Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><a class="el" href="classGlom_1_1TranslatableItem.html" title="TranslatableItem have a map of translation strings - one string for each locale. ">TranslatableItem</a> have a map of translation strings - one string for each locale. <a href="classGlom_1_1TranslatableItem.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for Glom::TranslatableItem:</div> <div class="dyncontent"> <div class="center"><img src="classGlom_1_1TranslatableItem__inherit__graph.png" border="0" usemap="#Glom_1_1TranslatableItem_inherit__map" alt="Inheritance graph"/></div> <map name="Glom_1_1TranslatableItem_inherit__map" id="Glom_1_1TranslatableItem_inherit__map"> <area shape="rect" id="node2" href="classGlom_1_1ChoiceValue.html" title="A value of a custom choice, for a field or a layout item. " alt="" coords="212,39,343,65"/><area shape="rect" id="node3" href="classGlom_1_1CustomTitle.html" title="Glom::CustomTitle" alt="" coords="213,89,341,116"/><area shape="rect" id="node4" href="classGlom_1_1DatabaseTitle.html" title="This is a separate class, instead of just deriving Document from TranslatableItem, to avoid the need to use Document via sharedptr. " alt="" coords="208,140,347,167"/><area shape="rect" id="node5" href="classGlom_1_1Field.html" title="Glom::Field" alt="" coords="234,191,321,217"/><area shape="rect" id="node6" href="classGlom_1_1GroupInfo.html" title="Glom::GroupInfo" alt="" coords="219,241,335,268"/><area shape="rect" id="node7" href="classGlom_1_1LayoutItem.html" title="Glom::LayoutItem" alt="" coords="216,292,339,319"/><area shape="rect" id="node25" href="classGlom_1_1PrintLayout.html" title="Glom::PrintLayout" alt="" coords="215,343,339,369"/><area shape="rect" id="node26" href="classGlom_1_1Relationship.html" title="Glom::Relationship" alt="" coords="213,393,342,420"/><area shape="rect" id="node27" href="classGlom_1_1Report.html" title="Glom::Report" alt="" coords="229,444,326,471"/><area shape="rect" id="node28" href="classGlom_1_1TableInfo.html" title="Glom::TableInfo" alt="" coords="221,495,334,521"/><area shape="rect" id="node8" href="classGlom_1_1LayoutGroup.html" title="Glom::LayoutGroup" alt="" coords="438,183,570,209"/><area shape="rect" id="node17" href="classGlom_1_1LayoutItem__Image.html" title="Glom::LayoutItem_Image" alt="" coords="421,241,587,268"/><area shape="rect" id="node18" href="classGlom_1_1LayoutItem__Line.html" title="This is only used on print layouts. " alt="" coords="427,292,581,319"/><area shape="rect" id="node19" href="classGlom_1_1LayoutItem__Placeholder.html" title="Glom::LayoutItem_Placeholder" alt="" coords="405,343,603,369"/><area shape="rect" id="node20" href="classGlom_1_1LayoutItem__WithFormatting.html" title="A base class for all layout items that may have formatting options. " alt="" coords="395,411,613,437"/><area shape="rect" id="node9" href="classGlom_1_1LayoutItem__Footer.html" title="Glom::LayoutItem_Footer" alt="" coords="671,5,838,32"/><area shape="rect" id="node10" href="classGlom_1_1LayoutItem__GroupBy.html" title="The child items are fields to be shown for each record in the group. " alt="" coords="665,56,845,83"/><area shape="rect" id="node11" href="classGlom_1_1LayoutItem__Header.html" title="Glom::LayoutItem_Header" alt="" coords="669,107,840,133"/><area shape="rect" id="node12" href="classGlom_1_1LayoutItem__Notebook.html" title="The child items are LayoutGroups, each of which will be shown on its own tab. " alt="" coords="662,157,847,184"/><area shape="rect" id="node13" href="classGlom_1_1LayoutItem__Portal.html" title="get_title() returns either the title of the Field or the CustomTitle. " alt="" coords="673,208,837,235"/><area shape="rect" id="node15" href="classGlom_1_1LayoutItem__Summary.html" title="Glom::LayoutItem_Summary" alt="" coords="662,259,847,285"/><area shape="rect" id="node16" href="classGlom_1_1LayoutItem__VerticalGroup.html" title="The child items are arranged vertically in a row on a report. " alt="" coords="668,310,841,351"/><area shape="rect" id="node14" href="classGlom_1_1LayoutItem__CalendarPortal.html" title="Glom::LayoutItem_Calendar\lPortal" alt="" coords="912,201,1093,242"/><area shape="rect" id="node21" href="classGlom_1_1LayoutItem__Button.html" title="Glom::LayoutItem_Button" alt="" coords="671,376,839,403"/><area shape="rect" id="node22" href="classGlom_1_1LayoutItem__Field.html" title="A LayoutItem that shows the data from a table field. " alt="" coords="675,427,834,453"/><area shape="rect" id="node24" href="classGlom_1_1LayoutItem__Text.html" title="Glom::LayoutItem_Text" alt="" coords="677,477,832,504"/><area shape="rect" id="node23" href="classGlom_1_1LayoutItem__FieldSummary.html" title="Glom::LayoutItem_FieldSummary" alt="" coords="896,427,1109,453"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a42caf941e237ef5c654c2a232a272f09"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> { <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09aa0e068f4c925e126640b5713d30df90d">TRANSLATABLE_TYPE_INVALID</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a0d44075d1d61db1c44573ee2fc1d7085">TRANSLATABLE_TYPE_FIELD</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a351c7ac2e55e769d65eb352ab56d259d">TRANSLATABLE_TYPE_RELATIONSHIP</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a5b6a542b337cf60fdfeeb14fc81df55e">TRANSLATABLE_TYPE_LAYOUT_ITEM</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a9ac77fa3c1931a962640283b55f6be2a">TRANSLATABLE_TYPE_CUSTOM_TITLE</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a4d90339e4e1360096b7b3e2cce3b6694">TRANSLATABLE_TYPE_PRINT_LAYOUT</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09acc95af040162973a318d31805618bceb">TRANSLATABLE_TYPE_REPORT</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09ae7222449dfa5a27b485267d70a587fcd">TRANSLATABLE_TYPE_TABLE</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09abb8fada243c986dc43e4795155bf1e07">TRANSLATABLE_TYPE_BUTTON</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a6174f2152734f488adfe3d572f746a66">TRANSLATABLE_TYPE_TEXTOBJECT</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a4a84bd31da6cda2d3bb4a1d522d794b3">TRANSLATABLE_TYPE_IMAGEOBJECT</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a649b6e0e9899c780f5012f0434e65fde">TRANSLATABLE_TYPE_CHOICEVALUE</a>, <br/>   <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09a24af3b3dad2a699b90c8c3bff66ca04d">TRANSLATABLE_TYPE_DATABASE_TITLE</a> <br/> }</td></tr> <tr class="separator:a42caf941e237ef5c654c2a232a272f09"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1c9755f8567b4247f4a37bb46435f4c5"><td class="memItemLeft" align="right" valign="top">typedef std::map<br class="typebreak"/> < Glib::ustring, Glib::ustring > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a1c9755f8567b4247f4a37bb46435f4c5">type_map_locale_to_translations</a></td></tr> <tr class="separator:a1c9755f8567b4247f4a37bb46435f4c5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a59d9f54952fb3953c70c3cf79e5b0397"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a59d9f54952fb3953c70c3cf79e5b0397">TranslatableItem</a> ()</td></tr> <tr class="separator:a59d9f54952fb3953c70c3cf79e5b0397"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6d86fb79fc616db7ba0ac5005d0e74c1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a6d86fb79fc616db7ba0ac5005d0e74c1">TranslatableItem</a> (const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& src)</td></tr> <tr class="separator:a6d86fb79fc616db7ba0ac5005d0e74c1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab51c8f9f14efe502dc9d3d438dcb765a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#ab51c8f9f14efe502dc9d3d438dcb765a">~TranslatableItem</a> ()</td></tr> <tr class="separator:ab51c8f9f14efe502dc9d3d438dcb765a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afdbcbf1375c65a72fde249add210f109"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#afdbcbf1375c65a72fde249add210f109">operator=</a> (const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& src)</td></tr> <tr class="separator:afdbcbf1375c65a72fde249add210f109"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae33a145dda75b7322e7a5f2a5635f8d8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#ae33a145dda75b7322e7a5f2a5635f8d8">operator==</a> (const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& src) const </td></tr> <tr class="separator:ae33a145dda75b7322e7a5f2a5635f8d8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1c80c03608eedd719b36f9e917d92bbe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a1c80c03608eedd719b36f9e917d92bbe">operator!=</a> (const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& src) const </td></tr> <tr class="separator:a1c80c03608eedd719b36f9e917d92bbe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d92c4d6473471e3a31ccfd2608f8302"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a1d92c4d6473471e3a31ccfd2608f8302">set_name</a> (const Glib::ustring& name)</td></tr> <tr class="memdesc:a1d92c4d6473471e3a31ccfd2608f8302"><td class="mdescLeft"> </td><td class="mdescRight">Set the non-translated identifier name. <a href="#a1d92c4d6473471e3a31ccfd2608f8302">More...</a><br/></td></tr> <tr class="separator:a1d92c4d6473471e3a31ccfd2608f8302"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a77169f3b9749c430de2237cfae53bd1b"><td class="memItemLeft" align="right" valign="top">virtual Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a77169f3b9749c430de2237cfae53bd1b">get_name</a> () const </td></tr> <tr class="memdesc:a77169f3b9749c430de2237cfae53bd1b"><td class="mdescLeft"> </td><td class="mdescRight">Get the non-translated identifier name. <a href="#a77169f3b9749c430de2237cfae53bd1b">More...</a><br/></td></tr> <tr class="separator:a77169f3b9749c430de2237cfae53bd1b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa1c2999c30fc5878b9c55eeaafa1d04d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#aa1c2999c30fc5878b9c55eeaafa1d04d">get_name_not_empty</a> () const </td></tr> <tr class="separator:aa1c2999c30fc5878b9c55eeaafa1d04d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1151d82f3656f24f43f5691d6c50e505"><td class="memItemLeft" align="right" valign="top">virtual Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a1151d82f3656f24f43f5691d6c50e505">get_title_or_name</a> (const Glib::ustring& locale) const </td></tr> <tr class="separator:a1151d82f3656f24f43f5691d6c50e505"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a081e678cb381005f8e126281af5fce13"><td class="memItemLeft" align="right" valign="top">virtual Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a081e678cb381005f8e126281af5fce13">get_title</a> (const Glib::ustring& locale) const </td></tr> <tr class="memdesc:a081e678cb381005f8e126281af5fce13"><td class="mdescLeft"> </td><td class="mdescRight">Get the title's translation for the specified locale, falling back to the original text if there is no translation. <a href="#a081e678cb381005f8e126281af5fce13">More...</a><br/></td></tr> <tr class="separator:a081e678cb381005f8e126281af5fce13"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac037a93ad7f0ca1b4b33df9c9a04b6c0"><td class="memItemLeft" align="right" valign="top">virtual Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#ac037a93ad7f0ca1b4b33df9c9a04b6c0">get_title_original</a> () const </td></tr> <tr class="memdesc:ac037a93ad7f0ca1b4b33df9c9a04b6c0"><td class="mdescLeft"> </td><td class="mdescRight">Get the title's original (non-translated, usually English) text. <a href="#ac037a93ad7f0ca1b4b33df9c9a04b6c0">More...</a><br/></td></tr> <tr class="separator:ac037a93ad7f0ca1b4b33df9c9a04b6c0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d9de54d4e85998c323fb505fb611dbb"><td class="memItemLeft" align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a1d9de54d4e85998c323fb505fb611dbb">get_title_translation</a> (const Glib::ustring& locale, bool fallback=true) const </td></tr> <tr class="memdesc:a1d9de54d4e85998c323fb505fb611dbb"><td class="mdescLeft"> </td><td class="mdescRight">Get the title's translation for the specified <em>locale</em>, optionally falling back to a locale of the same language, and then falling back to the original. <a href="#a1d9de54d4e85998c323fb505fb611dbb">More...</a><br/></td></tr> <tr class="separator:a1d9de54d4e85998c323fb505fb611dbb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3b45cf3c5e81775eead52c3a865af2fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a3b45cf3c5e81775eead52c3a865af2fc">set_title</a> (const Glib::ustring& title, const Glib::ustring& locale)</td></tr> <tr class="memdesc:a3b45cf3c5e81775eead52c3a865af2fc"><td class="mdescLeft"> </td><td class="mdescRight">Set the title's translation for the specified locale. <a href="#a3b45cf3c5e81775eead52c3a865af2fc">More...</a><br/></td></tr> <tr class="separator:a3b45cf3c5e81775eead52c3a865af2fc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9a6619911111f34afbb378e477366048"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a9a6619911111f34afbb378e477366048">set_title_original</a> (const Glib::ustring& title)</td></tr> <tr class="memdesc:a9a6619911111f34afbb378e477366048"><td class="mdescLeft"> </td><td class="mdescRight">Set the title's original (non-translated, usually English) text. <a href="#a9a6619911111f34afbb378e477366048">More...</a><br/></td></tr> <tr class="separator:a9a6619911111f34afbb378e477366048"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad972e58a60f9d2a7458e2abd1253b75f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#ad972e58a60f9d2a7458e2abd1253b75f">clear_title_in_all_locales</a> ()</td></tr> <tr class="memdesc:ad972e58a60f9d2a7458e2abd1253b75f"><td class="mdescLeft"> </td><td class="mdescRight">Clear the original title and any translations of the title. <a href="#ad972e58a60f9d2a7458e2abd1253b75f">More...</a><br/></td></tr> <tr class="separator:ad972e58a60f9d2a7458e2abd1253b75f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a627b76316a98caa6e84f4f12eb2e8e65"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a627b76316a98caa6e84f4f12eb2e8e65">get_has_translations</a> () const </td></tr> <tr class="separator:a627b76316a98caa6e84f4f12eb2e8e65"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ba6261adc433f183838d85ae490b39c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#a3ba6261adc433f183838d85ae490b39c">get_translatable_item_type</a> () const </td></tr> <tr class="separator:a3ba6261adc433f183838d85ae490b39c"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:af948c5c1a66dd832543f311887ba4d8c"><td class="memItemLeft" align="right" valign="top">static Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#af948c5c1a66dd832543f311887ba4d8c">get_translatable_type_name</a> (<a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> item_type)</td></tr> <tr class="separator:af948c5c1a66dd832543f311887ba4d8c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afd55350c7ad05e7be1e03de43fb83608"><td class="memItemLeft" align="right" valign="top">static Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#afd55350c7ad05e7be1e03de43fb83608">get_translatable_type_name_nontranslated</a> (<a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> item_type)</td></tr> <tr class="memdesc:afd55350c7ad05e7be1e03de43fb83608"><td class="mdescLeft"> </td><td class="mdescRight">The non-translated name is used for the context in gettext .po files. <a href="#afd55350c7ad05e7be1e03de43fb83608">More...</a><br/></td></tr> <tr class="separator:afd55350c7ad05e7be1e03de43fb83608"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:ab4ef5af7ccfc36bbf2f5feb23918b9f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlom_1_1TranslatableItem.html#ab4ef5af7ccfc36bbf2f5feb23918b9f6">m_translatable_item_type</a></td></tr> <tr class="separator:ab4ef5af7ccfc36bbf2f5feb23918b9f6"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="classGlom_1_1TranslatableItem.html" title="TranslatableItem have a map of translation strings - one string for each locale. ">TranslatableItem</a> have a map of translation strings - one string for each locale. </p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="a1c9755f8567b4247f4a37bb46435f4c5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::map<Glib::ustring, Glib::ustring> <a class="el" href="classGlom_1_1TranslatableItem.html#a1c9755f8567b4247f4a37bb46435f4c5">Glom::TranslatableItem::type_map_locale_to_translations</a></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Enumeration Documentation</h2> <a class="anchor" id="a42caf941e237ef5c654c2a232a272f09"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">Glom::TranslatableItem::enumTranslatableItemType</a></td> </tr> </table> </div><div class="memdoc"> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09aa0e068f4c925e126640b5713d30df90d"></a>TRANSLATABLE_TYPE_INVALID</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a0d44075d1d61db1c44573ee2fc1d7085"></a>TRANSLATABLE_TYPE_FIELD</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a351c7ac2e55e769d65eb352ab56d259d"></a>TRANSLATABLE_TYPE_RELATIONSHIP</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a5b6a542b337cf60fdfeeb14fc81df55e"></a>TRANSLATABLE_TYPE_LAYOUT_ITEM</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a9ac77fa3c1931a962640283b55f6be2a"></a>TRANSLATABLE_TYPE_CUSTOM_TITLE</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a4d90339e4e1360096b7b3e2cce3b6694"></a>TRANSLATABLE_TYPE_PRINT_LAYOUT</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09acc95af040162973a318d31805618bceb"></a>TRANSLATABLE_TYPE_REPORT</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09ae7222449dfa5a27b485267d70a587fcd"></a>TRANSLATABLE_TYPE_TABLE</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09abb8fada243c986dc43e4795155bf1e07"></a>TRANSLATABLE_TYPE_BUTTON</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a6174f2152734f488adfe3d572f746a66"></a>TRANSLATABLE_TYPE_TEXTOBJECT</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a4a84bd31da6cda2d3bb4a1d522d794b3"></a>TRANSLATABLE_TYPE_IMAGEOBJECT</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a649b6e0e9899c780f5012f0434e65fde"></a>TRANSLATABLE_TYPE_CHOICEVALUE</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a42caf941e237ef5c654c2a232a272f09a24af3b3dad2a699b90c8c3bff66ca04d"></a>TRANSLATABLE_TYPE_DATABASE_TITLE</em> </td><td class="fielddoc"> </td></tr> </table> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a59d9f54952fb3953c70c3cf79e5b0397"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glom::TranslatableItem::TranslatableItem </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a6d86fb79fc616db7ba0ac5005d0e74c1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glom::TranslatableItem::TranslatableItem </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& </td> <td class="paramname"><em>src</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ab51c8f9f14efe502dc9d3d438dcb765a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Glom::TranslatableItem::~TranslatableItem </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ad972e58a60f9d2a7458e2abd1253b75f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glom::TranslatableItem::clear_title_in_all_locales </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Clear the original title and any translations of the title. </p> </div> </div> <a class="anchor" id="a627b76316a98caa6e84f4f12eb2e8e65"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Glom::TranslatableItem::get_has_translations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a77169f3b9749c430de2237cfae53bd1b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Glib::ustring Glom::TranslatableItem::get_name </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the non-translated identifier name. </p> <p>Reimplemented in <a class="el" href="classGlom_1_1Field.html#aad54268166b2657723a7446947f26801">Glom::Field</a>, and <a class="el" href="classGlom_1_1LayoutItem__Field.html#aa0248c59510ec98e8b954d6ecfcb4cb1">Glom::LayoutItem_Field</a>.</p> </div> </div> <a class="anchor" id="aa1c2999c30fc5878b9c55eeaafa1d04d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Glom::TranslatableItem::get_name_not_empty </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a081e678cb381005f8e126281af5fce13"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Glib::ustring Glom::TranslatableItem::get_title </td> <td>(</td> <td class="paramtype">const Glib::ustring & </td> <td class="paramname"><em>locale</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the title's translation for the specified locale, falling back to the original text if there is no translation. </p> <p>See also <a class="el" href="classGlom_1_1TranslatableItem.html#a1d9de54d4e85998c323fb505fb611dbb" title="Get the title's translation for the specified locale, optionally falling back to a locale of the same...">get_title_translation()</a> and <a class="el" href="classGlom_1_1TranslatableItem.html#ac037a93ad7f0ca1b4b33df9c9a04b6c0" title="Get the title's original (non-translated, usually English) text. ">get_title_original()</a>, which (optionally) do not use fallbacks.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">locale</td><td>The locale whose title text should be returned. If this is empty then the original text will be returned. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The text of the title. </dd></dl> <p>Reimplemented in <a class="el" href="classGlom_1_1LayoutItem__Field.html#a22743f4bd8f4ae1a29a04dceb303f37e">Glom::LayoutItem_Field</a>, <a class="el" href="classGlom_1_1LayoutItem__FieldSummary.html#a0b4b52267f4a2aa37d3084834357da8c">Glom::LayoutItem_FieldSummary</a>, and <a class="el" href="classGlom_1_1LayoutItem__Portal.html#ac209719cb1c9d4211ad17a04eef2f271">Glom::LayoutItem_Portal</a>.</p> </div> </div> <a class="anchor" id="a1151d82f3656f24f43f5691d6c50e505"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Glib::ustring Glom::TranslatableItem::get_title_or_name </td> <td>(</td> <td class="paramtype">const Glib::ustring & </td> <td class="paramname"><em>locale</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplemented in <a class="el" href="classGlom_1_1LayoutItem__Field.html#af44e668221773b31a481011030ce0d52">Glom::LayoutItem_Field</a>, <a class="el" href="classGlom_1_1LayoutItem__FieldSummary.html#ab2d6a72c81bf705fe684823ee72bcaab">Glom::LayoutItem_FieldSummary</a>, and <a class="el" href="classGlom_1_1LayoutItem__Portal.html#af8dbd64a20f83845e866351680a315f1">Glom::LayoutItem_Portal</a>.</p> </div> </div> <a class="anchor" id="ac037a93ad7f0ca1b4b33df9c9a04b6c0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Glib::ustring Glom::TranslatableItem::get_title_original </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the title's original (non-translated, usually English) text. </p> <p>Reimplemented in <a class="el" href="classGlom_1_1ChoiceValue.html#a55f73d960c9a376bf9c8b7d33a0468ef">Glom::ChoiceValue</a>.</p> </div> </div> <a class="anchor" id="a1d9de54d4e85998c323fb505fb611dbb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::ustring Glom::TranslatableItem::get_title_translation </td> <td>(</td> <td class="paramtype">const Glib::ustring & </td> <td class="paramname"><em>locale</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>fallback</em> = <code>true</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get the title's translation for the specified <em>locale</em>, optionally falling back to a locale of the same language, and then falling back to the original. </p> <p>Calling this with the current locale is the same as calling <a class="el" href="classGlom_1_1TranslatableItem.html#ac037a93ad7f0ca1b4b33df9c9a04b6c0" title="Get the title's original (non-translated, usually English) text. ">get_title_original()</a>. </p> </div> </div> <a class="anchor" id="a3ba6261adc433f183838d85ae490b39c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> Glom::TranslatableItem::get_translatable_item_type </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="af948c5c1a66dd832543f311887ba4d8c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static Glib::ustring Glom::TranslatableItem::get_translatable_type_name </td> <td>(</td> <td class="paramtype"><a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> </td> <td class="paramname"><em>item_type</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="afd55350c7ad05e7be1e03de43fb83608"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static Glib::ustring Glom::TranslatableItem::get_translatable_type_name_nontranslated </td> <td>(</td> <td class="paramtype"><a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> </td> <td class="paramname"><em>item_type</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>The non-translated name is used for the context in gettext .po files. </p> </div> </div> <a class="anchor" id="a1c80c03608eedd719b36f9e917d92bbe"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Glom::TranslatableItem::operator!= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& </td> <td class="paramname"><em>src</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="afdbcbf1375c65a72fde249add210f109"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& Glom::TranslatableItem::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& </td> <td class="paramname"><em>src</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ae33a145dda75b7322e7a5f2a5635f8d8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Glom::TranslatableItem::operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlom_1_1TranslatableItem.html">TranslatableItem</a>& </td> <td class="paramname"><em>src</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a1d92c4d6473471e3a31ccfd2608f8302"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void Glom::TranslatableItem::set_name </td> <td>(</td> <td class="paramtype">const Glib::ustring & </td> <td class="paramname"><em>name</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set the non-translated identifier name. </p> <p>Reimplemented in <a class="el" href="classGlom_1_1Field.html#a17d91155b336c922354c48843924b9df">Glom::Field</a>, and <a class="el" href="classGlom_1_1LayoutItem__Field.html#a5e96a2b505a5729ebecc1005a9ac1a7c">Glom::LayoutItem_Field</a>.</p> </div> </div> <a class="anchor" id="a3b45cf3c5e81775eead52c3a865af2fc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glom::TranslatableItem::set_title </td> <td>(</td> <td class="paramtype">const Glib::ustring & </td> <td class="paramname"><em>title</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const Glib::ustring & </td> <td class="paramname"><em>locale</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the title's translation for the specified locale. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">title</td><td>The text of the title. </td></tr> <tr><td class="paramname">locale</td><td>The locale whose title text should be set. If this is empty then the original text will be set. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a9a6619911111f34afbb378e477366048"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glom::TranslatableItem::set_title_original </td> <td>(</td> <td class="paramtype">const Glib::ustring & </td> <td class="paramname"><em>title</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the title's original (non-translated, usually English) text. </p> <p>This is the same as calling <a class="el" href="classGlom_1_1TranslatableItem.html#a3b45cf3c5e81775eead52c3a865af2fc" title="Set the title's translation for the specified locale. ">set_title()</a> with an empty locale parameter. </p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="ab4ef5af7ccfc36bbf2f5feb23918b9f6"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlom_1_1TranslatableItem.html#a42caf941e237ef5c654c2a232a272f09">enumTranslatableItemType</a> Glom::TranslatableItem::m_translatable_item_type</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>libglom/data_structure/translatable_item.h</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Dec 15 2013 12:25:07 for libglom-1.22 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>