Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DesiQuintans/dq.ahk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dq.ahk

My (Desi's) personal library for AutoHotkey 2 https://www.autohotkey.com/.

Usage

Download dq.ahk and #Include it near the top of your script:

#Requires AutoHotkey v2.0
#Include "path/to/dq.ahk"

Function documentation

Functions are documented in the script with comments in a standard format. For example:

MyFunction(RequiredArg, OptionalArg1?, OptionalArg2 := "") {
    /*
    Description of what this function does.
    
    RequiredArg    - What this parameter is for, and what it accepts.
    [OptionalArg1] - Optional arguments are shown in [square brackets].
    [OptionalArg2] - ...
    
    Return: 
        What the function returns. If it returns an array or an object with named values, then:
            1. named1  --- The contents of the array index or named value.
            2. named2  --- ...
    
    Examples:
        ; Examples of how to use the function and what it outputs.
    */

    ; ...
}

List of functions

  • ReadableHotkey(KeyName)

    • Replaces Send() hotkey symbols with human-readable key names, e.g. "#^s" to "Win+Ctrl+S".
  • ReadableFilename(Filename)

    • Takes a file's full path and returns its basename and parent folder for context, e.g. "C:\Docs\Project7\Notes.txt" to "Project7\Notes.txt".
  • Basename(Filename)

    • Returns a file's basename. E.g. "C:\Docs\Project7\Notes.txt" to "Notes.txt".
  • FlagTitle(GuiObj)

    • Put a * at the start of the GUI's window title. Usually used to indicate unsaved changes to the current file.
  • UnflagTitle(GuiObj)

    • Remove * from the start of the GUI's window title.
  • GuiToggleVisibility(GuiObj)

    • Toggles whether a GUI is hidden or not.
  • dq_SaveFile(Contents, [Filename, SuggestedName, DialogTitle, FileFilter])

    • Handles both Save and Save As functionality, as well as cases where the user cancels the operation.
  • dq_LoadFile([Filename, DialogTitle, FileFilter])

    • Handles file loading with or without a File Select dialog, and handles cases where the user cancels the operation.
  • EditWidthFromCols(Cols, [FontName, FontSizePt, Debug])

    • Calculates how wide a multiline Edit control has to be in order to fit n characters of text in one line. AHK already lets us size Edits by number of rows of text, but a matching option to size an Edit by character count is missing.

About

My personal library for AutoHotkey 2

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published