TextEdit Module Overview
========================

.. contents:: Table of Contents
   :depth: 3
   :local:

TextEdit is fully supported in PyXA.

TextEdit Tutorials
##################
There are currently no tutorials for the Shortcuts module.

TextEdit Examples
#################
The examples below provide an overview of the capabilities of the TextEdit module. For more in-depth examples that show output and provide more detailed explanations, refer to the previous section (:ref:`TextEdit Tutorials`).

Example 1 - Using TextEdit methods and attributes
*************************************************

This example utilizes most of the methods provided in the TextEdit module, and it shows how to accomplish common tasks such as retrieving the currently opened documents, opening documents, creating new documents, and editing documents.

.. code-block:: python

   import PyXA
   textedit = PyXA.Application("TextEdit")
   textedit.activate()

   # Opening existing documents
   document = textedit.open("/Users/steven/Documents/Example.txt")
   document = textedit.documents().first
   document = textedit.front_window().document

   # Creating new documents
   textedit.new_document("new_doc_1.txt", location="/Users/exampleuser/Documents/")
   new_doc_2 = textedit.make("document", {"path": "/Users/exampleuser/Documents/NewDocument2.txt"})
   textedit.documents().push(new_doc_2)

   # Accessing top-level text elements
   paragraphs = document.paragraphs()
   sentences = document.sentences()
   words = document.words()
   characters = document.characters()

   # Conducting bulk operations with XAList objects
   combined_words = paragraphs[3:8].words()
   print(paragraphs.sentences())
   textedit.documents().append("\\nA new line in each open document")

   # Text elements are parents of text elements
   # Note: Words/characters are currently children of paragraphs, not sentences.
   sentences2 = paragraphs[0].sentences()
   words2 = paragraphs[0].words()
   characters2 = words2[0].characters()

   # Saving and closing documents
   document.save()
   document.close()

Example 2 - Creating documents from text returned by other PyXA methods
***********************************************************************

The example below implements a crude yet functional automatic flashcard generator that uses the text content of a webpage to create a randomized set of flashcards. The first half of the code uses the :mod:`PyXA.Safari` module to extract the visible text of a Wikipedia page, then saves that text to the disk. The second half then uses the TextEdit module to obtain a list of paragraphs in the text, from which five are randomly selected. The first sentence of each selected paragraphs is used as the hint for the flashcard. This could have use as a study tool or as a way to quickly summarize a topic, in addition to other potential uses.

.. code-block:: python

   import os
   from pprint import pprint
   import PyXA
   import random
   from time import sleep

   # Open a URL and wait for it to load
   safari = PyXA.Application("Safari")
   safari.open("https://en.wikipedia.org/wiki/Computer")
   sleep(1)

   # Get the text of the document, then close the tab
   doc_text = safari.current_document.text
   safari.front_window().current_tab.close()

   # Create folder path if it doesn't already exist
   folder_path = "/Users/steven/Documents/articles/"
   os.makedirs(folder_path, exist_ok=True)

   # Save the document text to a file on the disk
   file_path = folder_path + "Wikipedia-Computer.txt"
   with open(file_path, "w") as file:
      file.write(doc_text)

   # Open the document and get its paragraphs
   textedit = PyXA.Application("TextEdit")
   textedit.open(file_path)
   doc = textedit.front_window().document
   paragraphs = doc.paragraphs()

   # Create 5 random (sentence, paragraph) 'flashcards'
   flashcards = []
   while len(flashcards) < 5:
      paragraph = random.choice(paragraphs)
      if len(paragraph) > 200:
         sentence = random.choice(paragraph.sentences())
         flashcards.append((sentence, paragraph))
      
   pprint(flashcards)

TextEdit Resources
##################
- `TextEdit User Guide - Apple Support <https://support.apple.com/guide/textedit/welcome/mac>`_

For all classes, methods, and inherited members of the TextEdit module, see the :ref:`TextEdit Module Reference`.