anoopmb
/
frappe



<!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/html; charset=utf-8" />
    
    <title>widgets Package &mdash; WNFramework v1.8 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '1.8',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="WNFramework v1.8 documentation" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="widgets-package">
<h1>widgets Package<a class="headerlink" href="#widgets-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-webnotes.widgets.auto_master">
<span id="auto-master-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">auto_master</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.auto_master" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="webnotes.widgets.auto_master.add_to_master">
<tt class="descclassname">webnotes.widgets.auto_master.</tt><tt class="descname">add_to_master</tt><big>(</big><em>fieldname</em>, <em>value</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/auto_master.html#add_to_master"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.auto_master.add_to_master" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.auto_master.create_auto_masters">
<tt class="descclassname">webnotes.widgets.auto_master.</tt><tt class="descname">create_auto_masters</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/auto_master.html#create_auto_masters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.auto_master.create_auto_masters" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.auto_master.get_master_fields">
<tt class="descclassname">webnotes.widgets.auto_master.</tt><tt class="descname">get_master_fields</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/auto_master.html#get_master_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.auto_master.get_master_fields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.auto_master.make_auto_master">
<tt class="descclassname">webnotes.widgets.auto_master.</tt><tt class="descname">make_auto_master</tt><big>(</big><em>fieldname</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/auto_master.html#make_auto_master"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.auto_master.make_auto_master" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.auto_master.update_auto_masters">
<tt class="descclassname">webnotes.widgets.auto_master.</tt><tt class="descname">update_auto_masters</tt><big>(</big><em>doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/auto_master.html#update_auto_masters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.auto_master.update_auto_masters" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.event">
<span id="event-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">event</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.event" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="webnotes.widgets.event.get_cal_events">
<tt class="descclassname">webnotes.widgets.event.</tt><tt class="descname">get_cal_events</tt><big>(</big><em>m_st</em>, <em>m_end</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/event.html#get_cal_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.event.get_cal_events" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.event.load_month_events">
<tt class="descclassname">webnotes.widgets.event.</tt><tt class="descname">load_month_events</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/event.html#load_month_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.event.load_month_events" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.follow">
<span id="follow-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">follow</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.follow" title="Permalink to this headline">¶</a></h2>
<p>Server side methods for the follower pattern (Follow button used in forms)</p>
<dl class="function">
<dt id="webnotes.widgets.follow.email_followers">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">email_followers</tt><big>(</big><em>dt</em>, <em>dn</em>, <em>msg_html=None</em>, <em>msg_text=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#email_followers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.email_followers" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an email to all followers of this object</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.follow">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">follow</tt><big>(</big><em>dt=None</em>, <em>dn=None</em>, <em>user=None</em>, <em>verbose=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#follow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.follow" title="Permalink to this definition">¶</a></dt>
<dd><p>Add as follower to a particular record. If no parameteres, then take from the http request (form)</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.get_profile_fields">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">get_profile_fields</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#get_profile_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.get_profile_fields" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list of all profile link fields from the doctype</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.has_permission">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">has_permission</tt><big>(</big><em>dt</em>, <em>user</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#has_permission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.has_permission" title="Permalink to this definition">¶</a></dt>
<dd><p>Check to see if the user has permission to follow</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.is_follower">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">is_follower</tt><big>(</big><em>dt</em>, <em>dn</em>, <em>user</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#is_follower"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.is_follower" title="Permalink to this definition">¶</a></dt>
<dd><p>returns true if given user is a follower</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.load_followers">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">load_followers</tt><big>(</big><em>dt=None</em>, <em>dn=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#load_followers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.load_followers" title="Permalink to this definition">¶</a></dt>
<dd><p>returns list of followers (Full Names) for a particular object</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.make_follower">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">make_follower</tt><big>(</big><em>dt</em>, <em>dn</em>, <em>user</em>, <em>verbose</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#make_follower"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.make_follower" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the user as a follower</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.on_docsave">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">on_docsave</tt><big>(</big><em>doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#on_docsave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.on_docsave" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the owner and all linked Profiles as followers</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.setup">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.setup" title="Permalink to this definition">¶</a></dt>
<dd><p>Make table for followers - if missing</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.unfollow">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">unfollow</tt><big>(</big><em>dt=None</em>, <em>dn=None</em>, <em>user=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#unfollow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.unfollow" title="Permalink to this definition">¶</a></dt>
<dd><p>Unfollow a particular record. If no parameteres, then take from the http request (form)</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.follow.update_followers">
<tt class="descclassname">webnotes.widgets.follow.</tt><tt class="descname">update_followers</tt><big>(</big><em>dt=None</em>, <em>dn=None</em>, <em>subject=None</em>, <em>update_by=None</em>, <em>doc=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/follow.html#update_followers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.follow.update_followers" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the timestamp and subject in follower table (for feed generation)</p>
</dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.form">
<span id="form-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">form</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.form" title="Permalink to this headline">¶</a></h2>
<p>Server side handler for &#8220;Form&#8221; events</p>
<dl class="function">
<dt id="webnotes.widgets.form.add_comment">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">add_comment</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.add_comment" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.check_guest_access">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">check_guest_access</tt><big>(</big><em>doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#check_guest_access"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.check_guest_access" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.check_integrity">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">check_integrity</tt><big>(</big><em>doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#check_integrity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.check_integrity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.get_comments">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">get_comments</tt><big>(</big><em>doctype=None</em>, <em>docname=None</em>, <em>limit=5</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#get_comments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.get_comments" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.get_fields">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">get_fields</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#get_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.get_fields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.get_print_format">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">get_print_format</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#get_print_format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.get_print_format" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.getdoc">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">getdoc</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#getdoc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.getdoc" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads a doclist for a given document. This method is called directly from the client.
Requries &#8220;doctype&#8221;, &#8220;docname&#8221; as form variables. If &#8220;from_archive&#8221; is set, it will get from archive.
Will also call the &#8220;onload&#8221; method on the document.</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.getdoctype">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">getdoctype</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#getdoctype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.getdoctype" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.load_single_doc">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">load_single_doc</tt><big>(</big><em>dt</em>, <em>dn</em>, <em>user</em>, <em>prefix</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#load_single_doc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.load_single_doc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.make_comment_table">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">make_comment_table</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#make_comment_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.make_comment_table" title="Permalink to this definition">¶</a></dt>
<dd><p>Make table for comments - if missing via import module</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.make_csv_output">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">make_csv_output</tt><big>(</big><em>res</em>, <em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#make_csv_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.make_csv_output" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.remove_attach">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">remove_attach</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#remove_attach"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.remove_attach" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.remove_comment">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">remove_comment</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#remove_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.remove_comment" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.runserverobj">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">runserverobj</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#runserverobj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.runserverobj" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.savedocs">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">savedocs</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#savedocs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.savedocs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.form.validate_link">
<tt class="descclassname">webnotes.widgets.form.</tt><tt class="descname">validate_link</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/form.html#validate_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.form.validate_link" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.menus">
<span id="menus-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">menus</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.menus" title="Permalink to this headline">¶</a></h2>
<p>Server side methods called from DocBrowser</p>
<dl class="function">
<dt id="webnotes.widgets.menus.archive_items">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">archive_items</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#archive_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.archive_items" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.can_cancel">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">can_cancel</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#can_cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.can_cancel" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.delete_items">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">delete_items</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#delete_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.delete_items" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.get_columns">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">get_columns</tt><big>(</big><em>out</em>, <em>sf</em>, <em>fl</em>, <em>dt</em>, <em>tag_fields</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#get_columns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.get_columns" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.get_dt_details">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">get_dt_details</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#get_dt_details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.get_dt_details" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns details called by DocBrowser this includes:
the filters, columns, subject and tag_fields
also if the doctype is of type &#8220;submittable&#8221;</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.get_dt_trend">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">get_dt_trend</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#get_dt_trend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.get_dt_trend" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.get_menu_items">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">get_menu_items</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#get_menu_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.get_menu_items" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of items to show in <cite>Options</cite> of the Web Notes Toolbar
List contains Pages and Single DocTypes</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.get_trend">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">get_trend</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#get_trend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.get_trend" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.has_result">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">has_result</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#has_result"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.has_result" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.menus.is_submittable">
<tt class="descclassname">webnotes.widgets.menus.</tt><tt class="descname">is_submittable</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/menus.html#is_submittable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.menus.is_submittable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.page">
<span id="page-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">page</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.page" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="webnotes.widgets.page.Page">
<em class="property">class </em><tt class="descclassname">webnotes.widgets.page.</tt><tt class="descname">Page</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page.html#Page"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page.Page" title="Permalink to this definition">¶</a></dt>
<dd><p>A page class helps in loading a Page in the system. On loading</p>
<ul class="simple">
<li>Page will import Client Script from other pages where specified by <cite>$import(page_name)</cite></li>
<li>Execute dynamic HTML if the <cite>content</cite> starts with <cite>#python</cite></li>
</ul>
<dl class="method">
<dt id="webnotes.widgets.page.Page.load">
<tt class="descname">load</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page.html#Page.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page.Page.load" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <em class="xref std std-term">doclist</em> of the <cite>Page</cite></p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.page.Page.load_stylesheet">
<tt class="descname">load_stylesheet</tt><big>(</big><em>stylesheet</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page.html#Page.load_stylesheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page.Page.load_stylesheet" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page.get">
<tt class="descclassname">webnotes.widgets.page.</tt><tt class="descname">get</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page.html#get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <em class="xref std std-term">doclist</em> of the <cite>Page</cite> specified by <cite>name</cite></p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page.getpage">
<tt class="descclassname">webnotes.widgets.page.</tt><tt class="descname">getpage</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page.html#getpage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page.getpage" title="Permalink to this definition">¶</a></dt>
<dd><p>Load the page from <cite>webnotes.form</cite> and send it via <cite>webnotes.response</cite></p>
</dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.page_body">
<span id="page-body-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">page_body</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.page_body" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="webnotes.widgets.page_body.get">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.get" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the full rendered index.cgi
Gets <cite>keywords</cite> and <cite>site_description</cite> from the <cite>Control Panel</cite></p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page_body.get_doc_content">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">get_doc_content</tt><big>(</big><em>dt</em>, <em>dn</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#get_doc_content"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.get_doc_content" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the HTML content of a document record by using the overridden or standard :method: <cite>doclist.to_html</cite></p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page_body.get_page_content">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">get_page_content</tt><big>(</big><em>page</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#get_page_content"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.get_page_content" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the HTML content from <cite>static_content</cite> or <cite>content</cite> property of a <cite>Page</cite></p>
</dd></dl>

<dl class="data">
<dt id="webnotes.widgets.page_body.index_template">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">index_template</tt><a class="headerlink" href="#webnotes.widgets.page_body.index_template" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div>HTML Template of index.cgi</div></blockquote>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page_body.load_default_properties">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">load_default_properties</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#load_default_properties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.load_default_properties" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page_body.load_page_metatags">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">load_page_metatags</tt><big>(</big><em>doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#load_page_metatags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.load_page_metatags" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page_body.load_properties">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">load_properties</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#load_properties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.load_properties" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page_body.replace_id">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">replace_id</tt><big>(</big><em>match</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#replace_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.replace_id" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.page_body.scrub_ids">
<tt class="descclassname">webnotes.widgets.page_body.</tt><tt class="descname">scrub_ids</tt><big>(</big><em>content</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/page_body.html#scrub_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.page_body.scrub_ids" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.query_builder">
<span id="query-builder-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">query_builder</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.query_builder" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="webnotes.widgets.query_builder.add_match_conditions">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">add_match_conditions</tt><big>(</big><em>q</em>, <em>tl</em>, <em>ur</em>, <em>ud</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#add_match_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.add_match_conditions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.build_description_simple">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">build_description_simple</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#build_description_simple"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.build_description_simple" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.build_description_standard">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">build_description_standard</tt><big>(</big><em>meta</em>, <em>tl</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#build_description_standard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.build_description_standard" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.exec_report">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">exec_report</tt><big>(</big><em>code</em>, <em>res</em>, <em>colnames=</em><span class="optional">[</span><span class="optional">]</span>, <em>colwidths=</em><span class="optional">[</span><span class="optional">]</span>, <em>coltypes=</em><span class="optional">[</span><span class="optional">]</span>, <em>coloptions=</em><span class="optional">[</span><span class="optional">]</span>, <em>filter_values={}</em>, <em>query=''</em>, <em>from_export=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#exec_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.exec_report" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.get_parent_dt">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">get_parent_dt</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#get_parent_dt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.get_parent_dt" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.get_search_criteria_list">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">get_search_criteria_list</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#get_search_criteria_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.get_search_criteria_list" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.get_sql_meta">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">get_sql_meta</tt><big>(</big><em>tl</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#get_sql_meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.get_sql_meta" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.get_sql_tables">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">get_sql_tables</tt><big>(</big><em>q</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#get_sql_tables"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.get_sql_tables" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.getmatchcondition">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">getmatchcondition</tt><big>(</big><em>dt</em>, <em>ud</em>, <em>ur</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#getmatchcondition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.getmatchcondition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.guess_type">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">guess_type</tt><big>(</big><em>m</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#guess_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.guess_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns fieldtype depending on the MySQLdb Description</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.load_report_list">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">load_report_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#load_report_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.load_report_list" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.runquery">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">runquery</tt><big>(</big><em>q=''</em>, <em>ret=0</em>, <em>from_export=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#runquery"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.runquery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.query_builder.runquery_csv">
<tt class="descclassname">webnotes.widgets.query_builder.</tt><tt class="descname">runquery_csv</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/query_builder.html#runquery_csv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.query_builder.runquery_csv" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.search">
<span id="search-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">search</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.search" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="webnotes.widgets.search.build_for_autosuggest">
<tt class="descclassname">webnotes.widgets.search.</tt><tt class="descname">build_for_autosuggest</tt><big>(</big><em>res</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/search.html#build_for_autosuggest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.search.build_for_autosuggest" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.search.get_std_fields_list">
<tt class="descclassname">webnotes.widgets.search.</tt><tt class="descname">get_std_fields_list</tt><big>(</big><em>dt</em>, <em>key</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/search.html#get_std_fields_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.search.get_std_fields_list" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.search.getsearchfields">
<tt class="descclassname">webnotes.widgets.search.</tt><tt class="descname">getsearchfields</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/search.html#getsearchfields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.search.getsearchfields" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.search.make_query">
<tt class="descclassname">webnotes.widgets.search.</tt><tt class="descname">make_query</tt><big>(</big><em>fields</em>, <em>dt</em>, <em>key</em>, <em>txt</em>, <em>start</em>, <em>length</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/search.html#make_query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.search.make_query" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.search.scrub_custom_query">
<tt class="descclassname">webnotes.widgets.search.</tt><tt class="descname">scrub_custom_query</tt><big>(</big><em>query</em>, <em>key</em>, <em>txt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/search.html#scrub_custom_query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.search.scrub_custom_query" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.search.search_link">
<tt class="descclassname">webnotes.widgets.search.</tt><tt class="descname">search_link</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/search.html#search_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.search.search_link" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.search.search_widget">
<tt class="descclassname">webnotes.widgets.search.</tt><tt class="descname">search_widget</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/search.html#search_widget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.search.search_widget" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.tags">
<span id="tags-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">tags</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.tags" title="Permalink to this headline">¶</a></h2>
<p>Server side functions for tagging.</p>
<ul class="simple">
<li>Tags can be added to any record (doctype, name) in the system.</li>
<li>Items are filtered by tags</li>
<li>Top tags are shown in the sidebar (?)</li>
<li>Tags are also identified by the tag_fields property of the DocType</li>
</ul>
<p>Discussion:</p>
<p>Tags are shown in the docbrowser and ideally where-ever items are searched.
There should also be statistics available for tags (like top tags etc)</p>
<p>Design:</p>
<ul class="simple">
<li>free tags (user_tags) are stored in __user_tags</li>
<li>doctype tags are set in tag_fields property of the doctype</li>
<li>top tags merges the tags from both the lists (only refreshes once an hour (max))</li>
</ul>
<dl class="class">
<dt id="webnotes.widgets.tags.DocTags">
<em class="property">class </em><tt class="descclassname">webnotes.widgets.tags.</tt><tt class="descname">DocTags</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags" title="Permalink to this definition">¶</a></dt>
<dd><p>Tags for a particular doctype</p>
<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.add">
<tt class="descname">add</tt><big>(</big><em>dn</em>, <em>tag</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.add" title="Permalink to this definition">¶</a></dt>
<dd><p>add a new user tag</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.create">
<tt class="descname">create</tt><big>(</big><em>tag</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.create" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.get_tag_fields">
<tt class="descname">get_tag_fields</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.get_tag_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.get_tag_fields" title="Permalink to this definition">¶</a></dt>
<dd><p>returns tag_fields property</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.get_tags">
<tt class="descname">get_tags</tt><big>(</big><em>dn</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.get_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.get_tags" title="Permalink to this definition">¶</a></dt>
<dd><p>returns tag for a particular item</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.remove">
<tt class="descname">remove</tt><big>(</big><em>dn</em>, <em>tag</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>remove a user tag</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.setup">
<tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.setup" title="Permalink to this definition">¶</a></dt>
<dd><p>adds the _user_tags column if not exists</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.setup_tags">
<tt class="descname">setup_tags</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.setup_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.setup_tags" title="Permalink to this definition">¶</a></dt>
<dd><p>creates the tabTag table if not exists</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.DocTags.update">
<tt class="descname">update</tt><big>(</big><em>dn</em>, <em>tl</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#DocTags.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.DocTags.update" title="Permalink to this definition">¶</a></dt>
<dd><p>updates the _user_tag column in the table</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="webnotes.widgets.tags.TagCounter">
<em class="property">class </em><tt class="descclassname">webnotes.widgets.tags.</tt><tt class="descname">TagCounter</tt><big>(</big><em>doctype</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#TagCounter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.TagCounter" title="Permalink to this definition">¶</a></dt>
<dd><p>Tag Counter stores tag count per doctype in table _tag_cnt</p>
<dl class="method">
<dt id="webnotes.widgets.tags.TagCounter.build">
<tt class="descname">build</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#TagCounter.build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.TagCounter.build" title="Permalink to this definition">¶</a></dt>
<dd><p>Builds / rebuilds the counting</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.TagCounter.load_top">
<tt class="descname">load_top</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#TagCounter.load_top"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.TagCounter.load_top" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.TagCounter.new_tag">
<tt class="descname">new_tag</tt><big>(</big><em>tag</em>, <em>cnt=0</em>, <em>dt=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#TagCounter.new_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.TagCounter.new_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new row for the tag and doctype</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.TagCounter.setup">
<tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#TagCounter.setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.TagCounter.setup" title="Permalink to this definition">¶</a></dt>
<dd><p>creates the tag cnt table from the DocType</p>
</dd></dl>

<dl class="method">
<dt id="webnotes.widgets.tags.TagCounter.update">
<tt class="descname">update</tt><big>(</big><em>tag</em>, <em>diff</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#TagCounter.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.TagCounter.update" title="Permalink to this definition">¶</a></dt>
<dd><p>updates tag cnt for a doctype and tag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.tags.add_tag">
<tt class="descclassname">webnotes.widgets.tags.</tt><tt class="descname">add_tag</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#add_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.add_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a new tag to a record, and creates the Tag master</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.tags.check_user_tags">
<tt class="descclassname">webnotes.widgets.tags.</tt><tt class="descname">check_user_tags</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#check_user_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.check_user_tags" title="Permalink to this definition">¶</a></dt>
<dd><p>if the user does not have a tags column, then it creates one</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.tags.get_top_field_tags">
<tt class="descclassname">webnotes.widgets.tags.</tt><tt class="descname">get_top_field_tags</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#get_top_field_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.get_top_field_tags" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.tags.get_top_tags">
<tt class="descclassname">webnotes.widgets.tags.</tt><tt class="descname">get_top_tags</tt><big>(</big><em>args=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#get_top_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.get_top_tags" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the top 10 tags for the doctype from fields (7) and users (3)</p>
</dd></dl>

<dl class="function">
<dt id="webnotes.widgets.tags.remove_tag">
<tt class="descclassname">webnotes.widgets.tags.</tt><tt class="descname">remove_tag</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/tags.html#remove_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.tags.remove_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>removes tag from the record</p>
</dd></dl>

</div>
<div class="section" id="module-webnotes.widgets.todo">
<span id="todo-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">todo</span></tt> Module<a class="headerlink" href="#module-webnotes.widgets.todo" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="webnotes.widgets.todo.add_todo">
<tt class="descclassname">webnotes.widgets.todo.</tt><tt class="descname">add_todo</tt><big>(</big><em>user</em>, <em>date</em>, <em>priority</em>, <em>desc</em>, <em>ref_type</em>, <em>ref_name</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/todo.html#add_todo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.todo.add_todo" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.todo.add_todo_item">
<tt class="descclassname">webnotes.widgets.todo.</tt><tt class="descname">add_todo_item</tt><big>(</big><em>user</em>, <em>date</em>, <em>priority</em>, <em>desc</em>, <em>ref_type</em>, <em>ref_name</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/todo.html#add_todo_item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.todo.add_todo_item" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.todo.get_todo_list">
<tt class="descclassname">webnotes.widgets.todo.</tt><tt class="descname">get_todo_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/todo.html#get_todo_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.todo.get_todo_list" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="webnotes.widgets.todo.remove_todo">
<tt class="descclassname">webnotes.widgets.todo.</tt><tt class="descname">remove_todo</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/webnotes/widgets/todo.html#remove_todo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.widgets.todo.remove_todo" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/wnflogo200.gif" alt="Logo"/>
            </a></p>
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">widgets Package</a><ul>
<li><a class="reference internal" href="#module-webnotes.widgets.auto_master"><tt class="docutils literal"><span class="pre">auto_master</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.event"><tt class="docutils literal"><span class="pre">event</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.follow"><tt class="docutils literal"><span class="pre">follow</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.form"><tt class="docutils literal"><span class="pre">form</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.menus"><tt class="docutils literal"><span class="pre">menus</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.page"><tt class="docutils literal"><span class="pre">page</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.page_body"><tt class="docutils literal"><span class="pre">page_body</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.query_builder"><tt class="docutils literal"><span class="pre">query_builder</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.search"><tt class="docutils literal"><span class="pre">search</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.tags"><tt class="docutils literal"><span class="pre">tags</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-webnotes.widgets.todo"><tt class="docutils literal"><span class="pre">todo</span></tt> Module</a></li>
</ul>
</li>
</ul>

  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/webnotes.widgets.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
  </body>
</html>