DTEDITORGETCONTENTS(3)

okay so welcome to DtEditorGetContents(library call) — the library call that yoinks the whole contents of a DtEditor widget out into your hands, and yes, it's a whole vibe 💖

🌸 NAME

DtEditorGetContents — retrieve the contents of a DtEditor widget. That's the whole assignment, bestie: get the contents, no cap. ✨

🦋 SYNOPSIS

       #include &<Dt/Editor.h>
       DtEditorErrorCode DtEditorGetContents(
       Widget widget,
       DtEditorContentRec *data,
       Boolean hardCarriageReturns,
       Boolean markContentsAsSaved);

💅 DESCRIPTION

okay so DtEditorGetContents grabs the entire contents of a DtEditor widget and hands it over as a string, a wide character string, or a sized buffer of data. The transfer goes through a DtEditorContentRec — that struct tells you what kind of data is moving and carries the actual data too. If you want, any soft line feeds (word wraps) can be swapped for <newline>s. 🌀

The DtEditor widget keeps receipts on whether its contents have changed since they were last saved or retrieved. If you set markContentsAsSaved to True, you get a copy of the data without messing with whether DtEditorCheckForUnsavedChanges(3) says there are unsaved changes. That's lowkey perfect when the app just needs a temporary copy. 👀

Here are the arguments, bestie:

• widget — the DtEditor widget ID. That's your main character. 👑
• data — pointer to a data structure that receives the contents of widget. It's giving "here's your data bucket" 🪣
• hardCarriageReturns — set it to True and the DtEditor widget should replace any soft line feeds (word wraps) with <newline>s when saving the data. Set it to False and any line that wrapped because it reached the right edge of the window gets saved as one complete line. No cap. 📏
• markContentsAsSaved — set it to True and the DtEditor widget marks that all changes made to date have been saved. Set it to False and the DtEditor widget does not change its status regarding unsaved changes. Periodt. ✅

For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). For a complete definition of DtEditorContentRec, see Dt/Editor.h - DtEditor(5). Go read the source of truth, bestie. 📚

🔥 RETURN VALUE

Upon successful completion, DtEditorGetContents returns DtEDITOR_NO_ERRORS. Otherwise, it returns DtEDITOR_INVALID_TYPE if the Type field is not recognized. That's the whole return vibe check — if you see DtEDITOR_INVALID_TYPE, the Type field did not pass. 💀

🎀 EXAMPLES

The following code segment retrieves the contents of a DtEditor widget, marking that all changes to date have been saved. Copied exactly, character for character, weird bits and all — no edits from me, fr fr. 🎀

       Widget                  editor;
       DtEditorContentRec      cr;
       DtEditorErrorCode       status;
       Boolean                 markContentsAsSaved = True;
       cr.type = DtEDITOR_TEXT;
       status = DtEditorGetContents(editor, &&cr, False, markContentsAsSaved);
       if (status == DtEDITOR_NO_ERRORS)
               printf("The contents are:1s0, cr.value.string);
       else
               printf("Unable to retrieve contents of the widget0);

🦋 APPLICATION USAGE

To write the data directly to a file, the application should use DtEditorSaveContentsToFile(3). That's the move — don't reinvent the file-writing arc. 🫶

🌈 SEE ALSO

Go say hi to:

• Dt/Editor.h - DtEditor(5)
• DtEditor(3)
• DtEditorAppend(3)
• DtEditorAppendFromFile(3)
• DtEditorCheckForUnsavedChanges(3)
• DtEditorInsert(3)
• DtEditorInsertFromFile(3)
• DtEditorReplace(3)
• DtEditorReplaceFromFile(3)
• DtEditorSaveContentsToFile(3)
• DtEditorSetContents(3)
• DtEditorSetContentsFromFile(3)

that's the page, bestie — source/version: DtEditorGetContents(library call); date: not listed in the original footer, so we're keeping it mysterious slay 🫶✨