This repository has been archived on 2018-10-12. You can view files and clone it, but cannot push or open issues or pull requests.
OpenSQLManager/docs/classes/DB_tabs.html

279 lines
14 KiB
HTML
Raw Normal View History

2012-04-19 12:29:47 -04:00
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>OpenSQLManager » \DB_tabs</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">OpenSQLManager</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"></ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Create the object"><span class="description">Create the object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#add_tab" title="add_tab :: Add a new tab with the provided label"><span class="description">Add a new tab with the provided label</span><pre>add_tab()</pre></a></li>
<li class="method public "><a href="#get_db_tabs" title="get_db_tabs :: Create tabs for database aspects"><span class="description">Create tabs for database aspects</span><pre>get_db_tabs()</pre></a></li>
<li class="method public "><a href="#get_instance" title="get_instance :: Return the db tabs object if it exists, or create and return"><span class="description">Return the db tabs object if it exists, or create and return</span><pre>get_instance()</pre></a></li>
<li class="method public "><a href="#reset" title="reset :: Remove current tabs"><span class="description">Remove current tabs</span><pre>reset()</pre></a></li>
<li class="method public "><a href="#show_table_data" title="show_table_data :: Create popup window with table data"><span class="description">Create popup window with table data</span><pre>show_table_data()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#_add_row_tab" title="_add_row_tab :: Add a multidimensional array to a tab"><span class="description">Add a multidimensional array to a tab</span><pre>_add_row_tab()</pre></a></li>
<li class="method private "><a href="#_add_tab" title="_add_tab :: Simplify adding tabs to the Notebook object"><span class="description">Simplify adding tabs to the Notebook object</span><pre>_add_tab()</pre></a></li>
<li class="method private "><a href="#_get_db_info" title="_get_db_info :: Returns cached database data for the tab and connection specified"><span class="description">Returns cached database data for the tab and connection specified</span><pre>_get_db_info()</pre></a></li>
<li class="method private "><a href="#_set_db_info" title="_set_db_info :: Sets cached database data for the tab and connection specified"><span class="description">Sets cached database data for the tab and connection specified</span><pre>_set_db_info()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24data" title="$data :: Db Data cache"><span class="description">Db Data cache</span><pre>$data</pre></a></li>
<li class="property private "><a href="#%24instance" title="$instance :: Current Tab Widget object"><span class="description">Current Tab Widget object</span><pre>$instance</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CDB_tabs" id="\DB_tabs"></a><div href="../classes/DB_tabs.html" class="element class">
<p class="short_description">Tabbed Container for database properties</p>
<div class="details">
<p class="long_description"></p>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Create the object</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="add_tab" id="add_tab"></a><div class="element clickable method public add_tab" data-toggle="collapse" data-target=".add_tab .collapse">
<h2>Add a new tab with the provided label</h2>
<pre>add_tab(string $label, \GObject $widget) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$label</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$widget</h4>
<code>\GObject</code>
</div>
</div></div>
</div>
<a name="get_db_tabs" id="get_db_tabs"></a><div class="element clickable method public get_db_tabs" data-toggle="collapse" data-target=".get_db_tabs .collapse">
<h2>Create tabs for database aspects</h2>
<pre>get_db_tabs(<a href="../classes/Query_Builder.html">\Query_Builder</a> $conn) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$conn</h4>
<code><a href="../classes/Query_Builder.html">\Query_Builder</a></code>
</div>
</div></div>
</div>
<a name="get_instance" id="get_instance"></a><div class="element clickable method public get_instance" data-toggle="collapse" data-target=".get_instance .collapse">
<h2>Return the db tabs object if it exists, or create and return</h2>
<pre>get_instance() : <a href="../classes/DB_tabs.html">\DB_tabs</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/DB_tabs.html">\DB_tabs</a></code></div>
</div></div>
</div>
<a name="reset" id="reset"></a><div class="element clickable method public reset" data-toggle="collapse" data-target=".reset .collapse">
<h2>Remove current tabs</h2>
<pre>reset(string $conn_name) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$conn_name</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="show_table_data" id="show_table_data"></a><div class="element clickable method public show_table_data" data-toggle="collapse" data-target=".show_table_data .collapse">
<h2>Create popup window with table data</h2>
<pre>show_table_data(\GTKTreeView $view, array $path, \GtkTreeviewColumn $col, <a href="../classes/Query_Builder.html">\Query_Builder</a> $conn) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$view</h4>
<code>\GTKTreeView</code>
</div>
<div class="subelement argument">
<h4>$path</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$col</h4>
<code>\GtkTreeviewColumn</code>
</div>
<div class="subelement argument">
<h4>$conn</h4>
<code><a href="../classes/Query_Builder.html">\Query_Builder</a></code>
</div>
</div></div>
</div>
<a name="_add_row_tab" id="_add_row_tab"></a><div class="element clickable method private _add_row_tab" data-toggle="collapse" data-target="._add_row_tab .collapse">
<h2>Add a multidimensional array to a tab</h2>
<pre>_add_row_tab(object $conn, string $tab_name, string $method) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$conn</h4>
<code>object</code>
</div>
<div class="subelement argument">
<h4>$tab_name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="_add_tab" id="_add_tab"></a><div class="element clickable method private _add_tab" data-toggle="collapse" data-target="._add_tab .collapse">
<h2>Simplify adding tabs to the Notebook object</h2>
<pre>_add_tab(object $conn, string $tab_name, string $col_name, string $method, array $events) : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$conn</h4>
<code>object</code>
</div>
<div class="subelement argument">
<h4>$tab_name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$col_name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$method</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$events</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="_get_db_info" id="_get_db_info"></a><div class="element clickable method private _get_db_info" data-toggle="collapse" data-target="._get_db_info .collapse">
<h2>Returns cached database data for the tab and connection specified</h2>
<pre>_get_db_info(string $conn_name, string $tab_name) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$conn_name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$tab_name</h4>
<code>string</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a name="_set_db_info" id="_set_db_info"></a><div class="element clickable method private _set_db_info" data-toggle="collapse" data-target="._set_db_info .collapse">
<h2>Sets cached database data for the tab and connection specified</h2>
<pre>_set_db_info(string $conn_name, string $tab_name, mixed $data) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$conn_name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$tab_name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>mixed</code>
</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24data" id="$data"> </a><div class="element clickable property private $data" data-toggle="collapse" data-target=".$data .collapse">
<h2>Db Data cache</h2>
<pre>$data </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24instance" id="$instance"> </a><div class="element clickable property private $instance" data-toggle="collapse" data-target=".$instance .collapse">
<h2>Current Tab Widget object</h2>
<pre>$instance : \DB_Tabs</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-04-19T12:28:55-04:00.<br></footer></div>
</div>
</body>
</html>