cedlemo
/
blingbling
mirror of https://github.com/cedlemo/blingbling.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>ldoc</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><strong>blingbling.calendar</strong></li>
  <li><a href="../modules/blingbling.clock.html">blingbling.clock</a></li>
  <li><a href="../modules/blingbling.helpers.html">blingbling.helpers</a></li>
  <li><a href="../modules/blingbling.linegraph.html">blingbling.linegraph</a></li>
  <li><a href="../modules/blingbling.widget.html">blingbling.widget</a></li>
  <li><a href="../modules/blingbling.popups.html">blingbling.popups</a></li>
  <li><a href="../modules/blingbling.progress_graph.html">blingbling.progress_graph</a></li>
  <li><a href="../modules/blingbling.system.html">blingbling.system</a></li>
  <li><a href="../modules/blingbling.tagslist.html">blingbling.tagslist</a></li>
  <li><a href="../modules/blingbling.task_warrior.html">blingbling.task_warrior</a></li>
  <li><a href="../modules/blingbling.text_box.html">blingbling.text_box</a></li>
  <li><a href="../modules/blingbling.transient.html">blingbling.transient</a></li>
  <li><a href="../modules/blingbling.triangular_progress_graph.html">blingbling.triangular_progress_graph</a></li>
  <li><a href="../modules/blingbling.udisks_glue.html">blingbling.udisks_glue</a></li>
  <li><a href="../modules/blingbling.value_text_box.html">blingbling.value_text_box</a></li>
  <li><a href="../modules/blingbling.volume.html">blingbling.volume</a></li>
  <li><a href="../modules/blingbling.wlourf_circle_graph.html">blingbling.wlourf_circle_graph</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>blingbling.calendar</code></h1>
<p>Calendar widget.</p>
<p>
Show current month user can navigate through previous or next month with two button. The top centered button with current mont string allow user to reload the current month.
User can get events from remind and taskwarrior and can add their own events handler.</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#set_prev_next_widget_style">set_prev_next_widget_style (style)</a></td>
	<td class="summary">Set the style of the previous and next month button.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_current_date_widget_style">set_current_date_widget_style (style)</a></td>
	<td class="summary">Set the style of the current date text_box widget.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_days_of_week_widget_style">set_days_of_week_widget_style (style)</a></td>
	<td class="summary">Define the style of the cells that contains the week days names.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_days_of_month_widget_style">set_days_of_month_widget_style (style)</a></td>
	<td class="summary">Set the style of the days of the month widget.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_weeks_number_widget_style">set_weeks_number_widget_style (style)</a></td>
	<td class="summary">Define the style of the cells that displays the week number (left column).</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_corner_widget_style">set_corner_widget_style (style)</a></td>
	<td class="summary">Set the style of the cell used as a corner between the week days line and the week number column.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_current_day_widget_style">set_current_day_widget_style (style)</a></td>
	<td class="summary">Define the style used in order to show the current day.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_focus_widget_style">set_focus_widget_style (style)</a></td>
	<td class="summary">Define the style used when the mouse pass on a cell (only active is set_link_to_external_calendar(true)).</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_info_cell_style">set_info_cell_style (style)</a></td>
	<td class="summary">Define the style of the big widget on the right that displays information (current day or external calendar events).</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_link_to_external_calendar">set_link_to_external_calendar (boolean)</a></td>
	<td class="summary">Allow to get information from external calendar.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_locale">set_locale (locale)</a></td>
	<td class="summary">Use a specific locale for the week days.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#append_function_get_events_from">append_function_get_events_from (my_function)</a></td>
	<td class="summary">Add new function in order to get events from external application.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#clear_and_add_function_get_events_from">clear_and_add_function_get_events_from (my_function)</a></td>
	<td class="summary">Add new function in order to get events from external application and remove the existing function.</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "set_prev_next_widget_style"></a>
    <strong>set_prev_next_widget_style (style)</strong>
    </dt>
    <dd>
    Set the style of the previous and next month button.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_prev_next_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_current_date_widget_style"></a>
    <strong>set_current_date_widget_style (style)</strong>
    </dt>
    <dd>
    Set the style of the current date text_box widget.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_current_date_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_days_of_week_widget_style"></a>
    <strong>set_days_of_week_widget_style (style)</strong>
    </dt>
    <dd>
    Define the style of the cells that contains the week days names.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_days_of_week_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_days_of_month_widget_style"></a>
    <strong>set_days_of_month_widget_style (style)</strong>
    </dt>
    <dd>
    Set the style of the days of the month widget.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_days_of_month_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_weeks_number_widget_style"></a>
    <strong>set_weeks_number_widget_style (style)</strong>
    </dt>
    <dd>
    Define the style of the cells that displays the week number (left column).


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_weeks_number_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_corner_widget_style"></a>
    <strong>set_corner_widget_style (style)</strong>
    </dt>
    <dd>
    Set the style of the cell used as a corner between the week days line and the week number column.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_corner_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_current_day_widget_style"></a>
    <strong>set_current_day_widget_style (style)</strong>
    </dt>
    <dd>
    Define the style used in order to show the current day.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_current_day_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_focus_widget_style"></a>
    <strong>set_focus_widget_style (style)</strong>
    </dt>
    <dd>
    Define the style used when the mouse pass on a cell (only active is set_link_to_external_calendar(true)).


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_focus_widget_style(style)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_info_cell_style"></a>
    <strong>set_info_cell_style (style)</strong>
    </dt>
    <dd>
    Define the style of the big widget on the right that displays information (current day or external calendar events).


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">style</span>
         a table of parameters (see text_box widget in order to find which ones are available)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_info_cell_style</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_link_to_external_calendar"></a>
    <strong>set_link_to_external_calendar (boolean)</strong>
    </dt>
    <dd>
    Allow to get information from external calendar.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">boolean</span>
         true or false
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_link_to_external_calendar(boolean)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_locale"></a>
    <strong>set_locale (locale)</strong>
    </dt>
    <dd>
    Use a specific locale for the week days.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">locale</span>
         a string
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:set_locale(locale)</pre>
    </ul>

</dd>
    <dt>
    <a name = "append_function_get_events_from"></a>
    <strong>append_function_get_events_from (my_function)</strong>
    </dt>
    <dd>
    Add new function in order to get events from external application.
This method let the taskwarrior and remind links intact and add your founction.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">my_function</span>
         a function that you write
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example"> mycalendar:append_function_get_events_from(<span class="keyword">function</span>(day, month, year)
s=<span class="string">"third function "</span>.. <span class="string">" "</span> .. day .. <span class="string">" "</span> .. month ..<span class="string">" "</span> ..year
<span class="keyword">return</span> s
<span class="keyword">end</span>)
This  <span class="keyword">function</span> display <span class="keyword">in</span> the menu the <span class="global">string</span> <span class="string">"third function 26 11 2011"</span> <span class="keyword">for</span> example.</pre>
    </ul>

</dd>
    <dt>
    <a name = "clear_and_add_function_get_events_from"></a>
    <strong>clear_and_add_function_get_events_from (my_function)</strong>
    </dt>
    <dd>
    Add new function in order to get events from external application and remove the existing function.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">my_function</span>
         a function that you write
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mycalendar:clear_and_add_function_get_events_from(my_function)</pre>
    </ul>

</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2015-08-04 10:16:50 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>