Skip to content

Commit

Permalink
Modified styles
Browse files Browse the repository at this point in the history
  • Loading branch information
@maximalmaxx
maximalmaxx committed Oct 25, 2024
1 parent bc2f9c7 commit 21889a0
Show file tree
Hide file tree
Showing 2 changed files with 149 additions and 131 deletions.
278 changes: 148 additions & 130 deletions dev_info/docs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h2>Contents</h2>
<ul>
<li><a href="#devdocs">DevDocs</a></li>
<li><a href="#roadmap">Functions</a></li>
<li><a href="#features">Roadmap</a></li>
<li><a href="#roadmap">Roadmap</a></li>
</ul>
</nav>
</aside>
Expand All @@ -33,152 +33,165 @@ <h1>DevDocs</h1>
</section>

<section id="functions">
<h1>Clipboardy Functions</h1>
<p>This section provides details on all functions defined within the Clipboardy application, covering
their purposes, parameters, and usage.</p>

<div class="function">
<h2>load_settings()</h2>
<p><strong>Purpose:</strong> Loads the autosave setting from a settings file.</p>
<p><strong>Returns:</strong> <code>bool</code> - the autosave setting (defaults to
<code>False</code> if settings file is absent or corrupted).
</p>
<p><strong>Description:</strong> Reads the <code>settings.json</code> file to retrieve the autosave
setting and handles errors if the file is corrupted.</p>
</div>
<<<<<<< Updated upstream <h1>Clipboardy Functions</h1>
<p>This section provides details on all functions defined within the Clipboardy application,
covering
their purposes, parameters, and usage.</p>

<div class="function">
<h2>save_settings()</h2>
<p><strong>Purpose:</strong> Saves the current autosave setting to a settings file.</p>
<p><strong>Description:</strong> Writes the autosave value as a JSON object to
<code>settings.json</code>.
</p>
</div>
<div class="function">
<h2>load_settings()</h2>
<p><strong>Purpose:</strong> Loads the autosave setting from a settings file.</p>
<p><strong>Returns:</strong> <code>bool</code> - the autosave setting (defaults to
<code>False</code> if settings file is absent or corrupted).
</p>
<p><strong>Description:</strong> Reads the <code>settings.json</code> file to retrieve the
autosave
setting and handles errors if the file is corrupted.</p>
</div>

<div class="function">
<h2>generate_key()</h2>
<p><strong>Purpose:</strong> Generates a new encryption key.</p>
<p><strong>Returns:</strong> <code>bytes</code> - the generated encryption key.</p>
<p><strong>Description:</strong> Creates and saves an encryption key using
<code>cryptography.Fernet</code> if none exists.
</p>
</div>
<div class="function">
<h2>save_settings()</h2>
<p><strong>Purpose:</strong> Saves the current autosave setting to a settings file.</p>
<p><strong>Description:</strong> Writes the autosave value as a JSON object to
<code>settings.json</code>.
</p>
</div>

<div class="function">
<h2>load_key()</h2>
<p><strong>Purpose:</strong> Loads the encryption key from the file.</p>
<p><strong>Returns:</strong> <code>bytes</code> - the encryption key.</p>
<p><strong>Description:</strong> Reads the encryption key from <code>key.key</code> to facilitate
encryption/decryption.</p>
</div>
<div class="function">
<h2>generate_key()</h2>
<p><strong>Purpose:</strong> Generates a new encryption key.</p>
<p><strong>Returns:</strong> <code>bytes</code> - the generated encryption key.</p>
<p><strong>Description:</strong> Creates and saves an encryption key using
<code>cryptography.Fernet</code> if none exists.
</p>
</div>

<div class="function">
<h2>load_clips()</h2>
<p><strong>Purpose:</strong> Loads saved clipboard entries.</p>
<p><strong>Returns:</strong> <code>list</code> - a list of saved clipboard objects.</p>
<p><strong>Description:</strong> Reads <code>clips.json</code> and returns clipboard data,
initializing it if the file is empty or corrupted.</p>
</div>
<div class="function">
<h2>load_key()</h2>
<p><strong>Purpose:</strong> Loads the encryption key from the file.</p>
<p><strong>Returns:</strong> <code>bytes</code> - the encryption key.</p>
<p><strong>Description:</strong> Reads the encryption key from <code>key.key</code> to
facilitate
encryption/decryption.</p>
</div>

<div class="function">
<h2>save_clips()</h2>
<p><strong>Purpose:</strong> Saves the current clipboard entries to a file.</p>
<p><strong>Description:</strong> Writes <code>clipsObj</code>, containing clipboard entries, to
<code>clips.json</code> in JSON format.
</p>
</div>
<div class="function">
<h2>load_clips()</h2>
<p><strong>Purpose:</strong> Loads saved clipboard entries.</p>
<p><strong>Returns:</strong> <code>list</code> - a list of saved clipboard objects.</p>
<p><strong>Description:</strong> Reads <code>clips.json</code> and returns clipboard data,
initializing it if the file is empty or corrupted.</p>
</div>

<div class="function">
<h2>encrypt_clip(clip)</h2>
<p><strong>Parameters:</strong> <code>clip</code> (str) - the text to be encrypted.</p>
<p><strong>Returns:</strong> <code>str</code> - base64-encoded encrypted text.</p>
<p><strong>Description:</strong> Uses the encryption key to encode clipboard data.</p>
</div>
<div class="function">
<h2>save_clips()</h2>
<p><strong>Purpose:</strong> Saves the current clipboard entries to a file.</p>
<p><strong>Description:</strong> Writes <code>clipsObj</code>, containing clipboard entries, to
<code>clips.json</code> in JSON format.
</p>
</div>

<div class="function">
<h2>decrypt_clip(encrypted_clip)</h2>
<p><strong>Parameters:</strong> <code>encrypted_clip</code> (str) - the encrypted clipboard entry.
</p>
<p><strong>Returns:</strong> <code>str</code> - the decrypted text.</p>
<p><strong>Description:</strong> Decodes the encrypted clipboard data using the encryption key.</p>
</div>
<div class="function">
<h2>encrypt_clip(clip)</h2>
<p><strong>Parameters:</strong> <code>clip</code> (str) - the text to be encrypted.</p>
<p><strong>Returns:</strong> <code>str</code> - base64-encoded encrypted text.</p>
<p><strong>Description:</strong> Uses the encryption key to encode clipboard data.</p>
</div>

<div class="function">
<h2>populate_clips_table(frame, clips_to_display=None)</h2>
<p><strong>Parameters:</strong> <code>frame</code> - UI frame where clips are displayed;
<code>clips_to_display</code> (list) - optional list of clips to display (defaults to all
clips).
</p>
<p><strong>Description:</strong> Updates the UI table with decrypted clipboard entries and allows
users to copy or delete individual entries.</p>
</div>
<div class="function">
<h2>decrypt_clip(encrypted_clip)</h2>
<p><strong>Parameters:</strong> <code>encrypted_clip</code> (str) - the encrypted clipboard
entry.
</p>
<p><strong>Returns:</strong> <code>str</code> - the decrypted text.</p>
<p><strong>Description:</strong> Decodes the encrypted clipboard data using the encryption key.
</p>
</div>

<div class="function">
<h2>delete_clip_from_ui(index)</h2>
<p><strong>Parameters:</strong> <code>index</code> (int) - position of the clip in
<code>clipsObj</code>.
</p>
<p><strong>Description:</strong> Removes the clip from both <code>clipsObj</code> and the UI, then
saves the updated list.</p>
</div>
<div class="function">
<h2>populate_clips_table(frame, clips_to_display=None)</h2>
<p><strong>Parameters:</strong> <code>frame</code> - UI frame where clips are displayed;
<code>clips_to_display</code> (list) - optional list of clips to display (defaults to all
clips).
</p>
<p><strong>Description:</strong> Updates the UI table with decrypted clipboard entries and
allows
users to copy or delete individual entries.</p>
</div>

<div class="function">
<h2>UI()</h2>
<p><strong>Purpose:</strong> Initializes and displays the main UI for Clipboardy.</p>
<p><strong>Description:</strong> Sets up the main window with sections for searching, displaying,
and managing clips.</p>
</div>
<div class="function">
<h2>delete_clip_from_ui(index)</h2>
<p><strong>Parameters:</strong> <code>index</code> (int) - position of the clip in
<code>clipsObj</code>.
</p>
<p><strong>Description:</strong> Removes the clip from both <code>clipsObj</code> and the UI,
then
saves the updated list.</p>
</div>

<div class="function">
<h2>toggle_autosave()</h2>
<p><strong>Purpose:</strong> Enables or disables autosave and saves the updated setting.</p>
<p><strong>Description:</strong> Switches the <code>autosave</code> state and calls
<code>save_settings()</code> to save it.
</p>
</div>
<div class="function">
<h2>UI()</h2>
<p><strong>Purpose:</strong> Initializes and displays the main UI for Clipboardy.</p>
<p><strong>Description:</strong> Sets up the main window with sections for searching,
displaying,
and managing clips.</p>
</div>

<div class="function">
<h2>save_clip()</h2>
<p><strong>Purpose:</strong> Saves the current clipboard content, if available.</p>
<p><strong>Description:</strong> Encrypts the clipboard entry, detects its content type, and appends
it to <code>clipsObj</code>, followed by updating the UI.</p>
</div>
<div class="function">
<h2>toggle_autosave()</h2>
<p><strong>Purpose:</strong> Enables or disables autosave and saves the updated setting.</p>
<p><strong>Description:</strong> Switches the <code>autosave</code> state and calls
<code>save_settings()</code> to save it.
</p>
</div>

<div class="function">
<h2>determine_content_type(current_clip)</h2>
<p><strong>Parameters:</strong> <code>current_clip</code> (str) - clipboard text to classify.</p>
<p><strong>Returns:</strong> <code>str</code> - detected content type (URL, Email, Text, etc.).</p>
<p><strong>Description:</strong> Detects if the clipboard content matches specific types using
validation.</p>
</div>
<div class="function">
<h2>save_clip()</h2>
<p><strong>Purpose:</strong> Saves the current clipboard content, if available.</p>
<p><strong>Description:</strong> Encrypts the clipboard entry, detects its content type, and
appends
it to <code>clipsObj</code>, followed by updating the UI.</p>
</div>

<div class="function">
<h2>delete_all_clips()</h2>
<p><strong>Purpose:</strong> Clears all saved clipboard entries and updates the UI.</p>
<p><strong>Description:</strong> Empties <code>clipsObj</code>, then saves and refreshes the
clipboard display.</p>
</div>
<div class="function">
<h2>determine_content_type(current_clip)</h2>
<p><strong>Parameters:</strong> <code>current_clip</code> (str) - clipboard text to classify.
</p>
<p><strong>Returns:</strong> <code>str</code> - detected content type (URL, Email, Text, etc.).
</p>
<p><strong>Description:</strong> Detects if the clipboard content matches specific types using
validation.</p>
</div>

<div class="function">
<h2>search_clips(event=None)</h2>
<p><strong>Purpose:</strong> Filters displayed clips based on user input.</p>
<p><strong>Description:</strong> Searches through <code>clipsObj</code> to show only entries that
match the search term.</p>
</div>
<div class="function">
<h2>delete_all_clips()</h2>
<p><strong>Purpose:</strong> Clears all saved clipboard entries and updates the UI.</p>
<p><strong>Description:</strong> Empties <code>clipsObj</code>, then saves and refreshes the
clipboard display.</p>
</div>

<div class="function">
<h2>main()</h2>
<p><strong>Purpose:</strong> Initializes the application and starts clipboard monitoring.</p>
<p><strong>Description:</strong> Sets up encryption, loads settings, and starts the UI, while
running clipboard monitoring in a separate thread.</p>
</div>
<div class="function">
<h2>search_clips(event=None)</h2>
<p><strong>Purpose:</strong> Filters displayed clips based on user input.</p>
<p><strong>Description:</strong> Searches through <code>clipsObj</code> to show only entries
that
match the search term.</p>
</div>

<div class="function">
<h2>monitor_clipboard()</h2>
<p><strong>Purpose:</strong> Continuously monitors the clipboard for changes.</p>
<p><strong>Description:</strong> Checks the clipboard every second, saving new entries if autosave
is enabled and the content is unique.</p>
</div>
<div class="function">
<h2>main()</h2>
<p><strong>Purpose:</strong> Initializes the application and starts clipboard monitoring.</p>
<p><strong>Description:</strong> Sets up encryption, loads settings, and starts the UI, while
running clipboard monitoring in a separate thread.</p>
</div>

<div class="function">
<h2>monitor_clipboard()</h2>
<p><strong>Purpose:</strong> Continuously monitors the clipboard for changes.</p>
<p><strong>Description:</strong> Checks the clipboard every second, saving new entries if
autosave
is enabled and the content is unique.</p>
</div>
</section>

<section id="roadmap">
Expand Down Expand Up @@ -245,6 +258,11 @@ <h2>Milestone 4: Collaborative and Community Features</h2>
</div>
</section>

=======
<h1>Clipboardys functions</h1>
<p>Here we will discuss the functions defined in the script of Clipboardy.</p>
</section>
>>>>>>> Stashed changes
</main>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ <h2>Advancing clipboards to infinity and beyond</h2>
<button class="btn" onclick="goto('documentation/docs.html')">Documentation</button>
<button class="btn" onclick="goto('#contribute')">Contribute</button>
<button class="btn" onclick="goto('#download')">Download</button>
<button class="btn" onclick="goto('documentation/docs.html#features')">Features</button>
<button class="btn" onclick="goto('dev_info/docs.html')">Developer info</button>
</div>
</div>

Expand Down

0 comments on commit 21889a0

Please sign in to comment.