diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ee1a591 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,40 @@ +name: Bug report +description: Something is not working as expected. +title: Description of the bug +labels: bug + +body: + - type: textarea + attributes: + label: Describe the bug + description: >- + A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: To Reproduce + description: >- + Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + attributes: + label: Expected behavior + description: >- + A clear and concise description of what you expected to happen. + validations: + required: true + + - type: textarea + attributes: + label: Additional context + description: >- + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/component_request.yml b/.github/ISSUE_TEMPLATE/component_request.yml new file mode 100644 index 0000000..cca6a9a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/component_request.yml @@ -0,0 +1,37 @@ +name: Components request +description: Suggest an idea for a new component +title: Description of the component request +labels: enhancement + +body: + - type: textarea + attributes: + label: Why would you like to add a new component? + placeholder: >- + A clear and concise description of why the component should be added. + validations: + required: false + + - type: textarea + attributes: + label: Name the native widgets. + placeholder: >- + A list of the native widgets of Gtk/Libadwaita or AppKit, if you know them. + validations: + required: true + + - type: textarea + attributes: + label: Describe your idea for the implementation. + placeholder: >- + What could the implementation be like in Dvandva? + validations: + required: false + + - type: textarea + attributes: + label: Additional context + placeholder: >- + Add any other context about the component request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..c244dbb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature request +description: Suggest an idea for this project +title: Description of the feature request +labels: enhancement + +body: + - type: input + attributes: + label: Is your feature request related to a problem? Please describe. + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + + - type: textarea + attributes: + label: Describe the solution you'd like + placeholder: >- + A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + attributes: + label: Describe alternatives you've considered + placeholder: >- + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + + - type: textarea + attributes: + label: Additional context + placeholder: >- + Add any other context or screenshots about the feature request here. + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f0ed3f3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +## Steps +- [ ] Add your name or username and a link to your GitHub profile into the [Contributors.md][1] file. +- [ ] Build the project on your machine. If it does not compile, fix the errors. +- [ ] Describe the purpose and approach of your pull request below. +- [ ] Submit the pull request. Thank you very much for your contribution! + +## Purpose +_Describe the problem or feature._ +_If there is a related issue, add the link._ + +## Approach +_Describe how this pull request solves the problem or adds the feature._ + +[1]: /Contributors.md diff --git a/.github/workflows/swiftlint.yml b/.github/workflows/swiftlint.yml new file mode 100644 index 0000000..5348bdb --- /dev/null +++ b/.github/workflows/swiftlint.yml @@ -0,0 +1,30 @@ +name: SwiftLint + +on: + push: + paths: + - '.github/workflows/swiftlint.yml' + - '.swiftlint.yml' + - '**/*.swift' + pull_request: + paths: + - '.github/workflows/swiftlint.yml' + - '.swiftlint.yml' + - '**/*.swift' + workflow_dispatch: + paths: + - '.github/workflows/swiftlint.yml' + - '.swiftlint.yml' + - '**/*.swift' + +jobs: + SwiftLint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: SwiftLint + uses: norio-nomura/action-swiftlint@3.2.1 + with: + args: --strict + env: + WORKING_DIRECTORY: Source diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..831c525 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.DS_Store +/.build +/Packages +/*.xcodeproj +xcuserdata/ +DerivedData/ +/.swiftpm +.netrc +/Package.resolved +.Ulysses-Group.plist diff --git a/.swiftlint.yml b/.swiftlint.yml new file mode 100644 index 0000000..9494f5c --- /dev/null +++ b/.swiftlint.yml @@ -0,0 +1,162 @@ +# Opt-In Rules +opt_in_rules: + - anonymous_argument_in_multiline_closure + - array_init + - attributes + - closure_body_length + - closure_end_indentation + - closure_spacing + - collection_alignment + - comma_inheritance + - conditional_returns_on_newline + - contains_over_filter_count + - contains_over_filter_is_empty + - contains_over_first_not_nil + - contains_over_range_nil_comparison + - convenience_type + - discouraged_none_name + - discouraged_object_literal + - discouraged_optional_boolean + - discouraged_optional_collection + - empty_collection_literal + - empty_count + - empty_string + - enum_case_associated_values_count + - explicit_init + - fallthrough + - file_header + - file_name + - file_name_no_space + - first_where + - flatmap_over_map_reduce + - force_unwrapping + - function_default_parameter_at_end + - identical_operands + - implicit_return + - implicitly_unwrapped_optional + - joined_default_parameter + - last_where + - legacy_multiple + - let_var_whitespace + - literal_expression_end_indentation + - local_doc_comment + - lower_acl_than_parent + - missing_docs + - modifier_order + - multiline_arguments + - multiline_arguments_brackets + - multiline_function_chains + - multiline_literal_brackets + - multiline_parameters + - multiline_parameters_brackets + - no_extension_access_modifier + - no_grouping_extension + - no_magic_numbers + - number_separator + - operator_usage_whitespace + - optional_enum_case_matching + - prefer_self_in_static_references + - prefer_self_type_over_type_of_self + - prefer_zero_over_explicit_init + - prohibited_interface_builder + - redundant_nil_coalescing + - redundant_type_annotation + - return_value_from_void_function + - shorthand_optional_binding + - sorted_first_last + - sorted_imports + - static_operator + - strict_fileprivate + - switch_case_on_newline + - toggle_bool + - trailing_closure + - type_contents_order + - unneeded_parentheses_in_closure_argument + - yoda_condition + +# Disabled Rules +disabled_rules: + - block_based_kvo + - class_delegate_protocol + - dynamic_inline + - is_disjoint + - no_fallthrough_only + - notification_center_detachment + - ns_number_init_as_function_reference + - nsobject_prefer_isequal + - private_over_fileprivate + - redundant_objc_attribute + - self_in_property_initialization + - todo + - unavailable_condition + - valid_ibinspectable + - xctfail_message + +# Custom Rules +custom_rules: + github_issue: + name: 'GitHub Issue' + regex: '//.(TODO|FIXME):.(?!.*(https://github\.com/david-swift/Dvandva/issues/\d))' + message: 'The related GitHub issue must be included in a TODO or FIXME.' + severity: warning + + fatal_error: + name: 'Fatal Error' + regex: 'fatalError.*\(.*\)' + message: 'Fatal error should not be used.' + severity: error + + enum_case_parameter: + name: 'Enum Case Parameter' + regex: 'case [a-zA-Z0-9]*\([a-zA-Z0-9\.<>?,\n\t =]+\)' + message: 'The associated values of an enum case should have parameters.' + severity: warning + + tab: + name: 'Whitespaces Instead of Tab' + regex: '\t' + message: 'Spaces should be used instead of tabs.' + severity: warning + + # Thanks to the creator of the SwiftLint rule + # "empty_first_line" + # https://github.com/coteditor/CotEditor/blob/main/.swiftlint.yml + # in the GitHub repository + # "CotEditor" + # https://github.com/coteditor/CotEditor + empty_first_line: + name: 'Empty First Line' + regex: '(^[ a-zA-Z ]*(?:protocol|extension|class|struct) (?!(?:var|let))[ a-zA-Z:]*\{\n *\S+)' + message: 'There should be an empty line after a declaration' + severity: error + +# Analyzer Rules +analyzer_rules: + - unused_declaration + - unused_import + +# Options +file_header: + required_pattern: '(// swift-tools-version: .+)?//\n// .*.swift\n// Dvandva\n//\n// Created by .* on .*\.(\n// Edited by (.*,)+\.)*\n(\n// Thanks to .* for the .*:\n// ".*"\n// https://.* \(\d\d.\d\d.\d\d\))*//\n' +missing_docs: + warning: [internal, private] + error: [open, public] + excludes_extensions: false + excludes_inherited_types: false +type_contents_order: + order: + - case + - type_alias + - associated_type + - type_property + - instance_property + - ib_inspectable + - ib_outlet + - subscript + - initializer + - deinitializer + - subtype + - type_method + - view_life_cycle_method + - ib_action + - other_method diff --git a/Bundler.toml b/Bundler.toml new file mode 100644 index 0000000..6dac645 --- /dev/null +++ b/Bundler.toml @@ -0,0 +1,3 @@ +[apps.Test] +product = 'Test' +version = '0.1.0' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9e75fcf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing + +Thank you very much for taking the time for contributing to this project. + +## Report a Bug +Just open a new issue on GitHub and describe the bug. It helps if your description is detailed. Thank you very much for your contribution! + +## Suggest a New Feature +Just open a new issue on GitHub and describe the idea. Thank you very much for your contribution! + +### Suggest a New Component +If you want to add a component, just open an issue. + +## Pull Requests +I am happy for every pull request, you do not have to follow these guidelines. However, it might help you to understand the project structure and make it easier for me to merge your pull request. Thank you very much for your contribution! + +### 1. Fork & Clone this Project +Start by clicking on the `Fork` button at the top of the page. Then, clone this repository to your computer. + +### 2. Open the Project +Open the project folder in GNOME Builder, Xcode or another IDE. + +### 3. Understand the Project Structure +- The `README.md` file contains a description of the app or package. +- The `Contributors.md` file contains the names or user names of all the contributors with a link to their GitHub profile. +- The `LICENSE.md` contains an GPL-3.0 license. +- `CONTRIBUTING.md` is this file. +- `Bundler.toml` contains information for the test app on macOS. +- Directory `Icons` that contains PNG and PXD (Pixelmator Pro) files for the images used in the app and guides. +- Directory `Documentation` that contains the documentation generated with [SourceDocs][1]. +- `Sources` contains the source code of the project. + - `Dvandva` contains the source code of the project. + - `Extensions` contains extensions for existing types. + - `Swift` contains representations of simple types, often enumerations, in Swift. + - `Widgets` contains the actual widgets. +- `Tests` contains an example application. + +### 4. Edit the Code +Edit the code. If you add a new type, add documentation in the code. + +### 5. Commit to the Fork +Commit and push the fork. + +### 6. Pull Request +Open GitHub to submit a pull request. Thank you very much for your contribution! + +[1]: https://github.com/SourceDocs/SourceDocs diff --git a/Contributors.md b/Contributors.md new file mode 100644 index 0000000..3cf3f03 --- /dev/null +++ b/Contributors.md @@ -0,0 +1,3 @@ +# Contributors + +- [david-swift](https://github.com/david-swift) diff --git a/Documentation/Reference/README.md b/Documentation/Reference/README.md new file mode 100644 index 0000000..c75f22a --- /dev/null +++ b/Documentation/Reference/README.md @@ -0,0 +1,41 @@ +# Reference Documentation + +## Structs + +- [KeyboardShortcut](structs/KeyboardShortcut.md) + +## Classes + +- [Application](classes/Application.md) +- [Application.GTUIApp](classes/Application.GTUIApp.md) +- [Box](classes/Box.md) +- [Button](classes/Button.md) +- [Label](classes/Label.md) +- [List](classes/List.md) +- [List.ViewController](classes/List.ViewController.md) +- [Menu](classes/Menu.md) +- [MenuButton](classes/MenuButton.md) +- [NativeWrapper](classes/NativeWrapper.md) +- [PaddingWrapper](classes/PaddingWrapper.md) +- [ScrollView](classes/ScrollView.md) +- [Widget](classes/Widget.md) +- [Window](classes/Window.md) +- [Window](classes/Window.md) +- [Window.NavigationSplitViewController](classes/Window.NavigationSplitViewController.md) + +## Enums + +- [ButtonStyle](enums/ButtonStyle.md) +- [Edge](enums/Edge.md) +- [Font](enums/Font.md) +- [Icon](enums/Icon.md) +- [KeyboardShortcut.ShortcutCharacter](enums/KeyboardShortcut.ShortcutCharacter.md) + +## Extensions + +- [NSView](extensions/NSView.md) +- [Set](extensions/Set.md) +- [String](extensions/String.md) +- [Window](extensions/Window.md) + +This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) \ No newline at end of file diff --git a/Documentation/Reference/classes/Application.GTUIApp.md b/Documentation/Reference/classes/Application.GTUIApp.md new file mode 100644 index 0000000..6f9a02e --- /dev/null +++ b/Documentation/Reference/classes/Application.GTUIApp.md @@ -0,0 +1,15 @@ +**CLASS** + +# `Application.GTUIApp` + +The GTUI Application type for an application in Dvandva. + +## Properties +### `actions` + +Actions to run when being activated. + +## Methods +### `onActivate()` + +Run this function when being activated before being executed. diff --git a/Documentation/Reference/classes/Application.md b/Documentation/Reference/classes/Application.md new file mode 100644 index 0000000..b0504c5 --- /dev/null +++ b/Documentation/Reference/classes/Application.md @@ -0,0 +1,287 @@ +**CLASS** + +# `Application` + +```swift +public class Application +``` + +The application. + +Do not initialize multiple apps per target. + +## Properties +### `application` + +```swift +let application: NSApplication = .shared +``` + +The shared NSApplication for macOS. + +### `mainMenu` + +```swift +let mainMenu: NSMenu = .init() +``` + +The app's main menu for macOS. + +### `windowsItem` + +```swift +let windowsItem = NSMenuItem(title: "Window", action: nil, keyEquivalent: "") +``` + +The "Windows" menu for macOS. + +### `helpItem` + +```swift +let helpItem = NSMenuItem(title: "Help", action: nil, keyEquivalent: "") +``` + +The "Help" menu for macOS. + +### `menuItemHandlers` + +```swift +var menuItemHandlers: [NSMenuItem: () -> Void] = [:] +``` + +The handlers for menus for macOS. + +### `actionIdentifiers` + +```swift +var actionIdentifiers: [String: NSMenuItem] = [:] +``` + +Identifiers of the actions. + +### `keyWindow` + +```swift +public var keyWindow: Window? +``` + +The currently active window. + +### `application` + +The application for Linux. + +### `keyWindow` + +The currently active window. + +### `appName` + +```swift +public var appName: String +``` + +The application's name. + +### `appVersion` + +```swift +public var appVersion: String +``` + +The application's version string. + +### `developer` + +```swift +var developer: String +``` + +The application's developer. + +### `helpURL` + +```swift +var helpURL: URL? +``` + +The application's website for help. + +### `issue` + +```swift +var issue: URL? +``` + +The website for suggesting new features. + +### `windows` + +```swift +var windows: [Window] = [] +``` + +The available application windows. + +## Methods +### `init(_:version:id:developer:)` + +```swift +public init(_ appName: String, version: String, id: String, developer: String) +``` + +Initialize a new application. +- Parameters: + - appName: The application's name. + - version: The application's version string. + - id: The application's identifier conforming to the GNOME app ID guidelines. + - developer: The application's developer. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| appName | The application’s name. | +| version | The application’s version string. | +| id | The application’s identifier conforming to the GNOME app ID guidelines. | +| developer | The application’s developer. | + +### `addMenu(_:menu:)` + +```swift +public func addMenu(_ title: String, menu: Menu) +``` + +Add a menu. +On macOS, it appears in the menu bar. +On Linux, its actions are added to the app with the keyboard shortcuts. +You can use an action in any button in a menu +by setting `id` to the label of the button holding the action in the menu bar instead of a closure. +- Parameters: + - title: The title of the menu in the menu bar. + - menu: The menu. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| title | The title of the menu in the menu bar. | +| menu | The menu. | + +### `setHelp(url:)` + +```swift +public func setHelp(url: URL) +``` + +Set the URL displayed in the "Help" menu on macOS or in the "About" window on Linux. +- Parameter url: The help URL. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| url | The help URL. | + +### `setIssue(url:)` + +```swift +public func setIssue(url: URL) +``` + +Set the URL displayed in the "Help" menu on macOS +or in the "About" window on Linux for suggesting new features and reporting bugs. +- Parameter url: The issue URL. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| url | The issue URL. | + +### `run(_:)` + +```swift +public func run(_ modify: @escaping () -> Void) +``` + +Run the application. +- Parameter modify: Every modification on the application should happen in this closure. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| modify | Every modification on the application should happen in this closure. | + +### `createDefaultMenus()` + +```swift +private func createDefaultMenus() +``` + +Add the default menus to the menu bar. + +### `about(_:)` + +```swift +func about(_ sender: Any?) +``` + +Open the about window. +- Parameter sender: The sender. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| sender | The sender. | + +### `help(_:)` + +```swift +func help(_ sender: Any?) +``` + +Open the help URL. +- Parameter sender: The sender. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| sender | The sender. | + +### `issue(_:)` + +```swift +func issue(_ sender: Any?) +``` + +Open the issue URL. +- Parameter sender: The sender. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| sender | The sender. | + +### `menuAction(_:)` + +```swift +func menuAction(_ sender: NSMenuItem?) +``` + +Execute an action in a menu. +- Parameter sender: The menu item that calls the action. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| sender | The menu item that calls the action. | + +### `addDefaultShortcuts()` + +Add the default keyboard shortcuts on Linux. diff --git a/Documentation/Reference/classes/Box.md b/Documentation/Reference/classes/Box.md new file mode 100644 index 0000000..995d6f6 --- /dev/null +++ b/Documentation/Reference/classes/Box.md @@ -0,0 +1,93 @@ +**CLASS** + +# `Box` + +```swift +public class Box: Widget +``` + +A widget containing multiple items either aligned horizontally or vertically. + +## Properties +### `box` + +```swift +private var box: NSStackView? +``` + +The widget for macOS. + +### `box` + +The widget for Linux. + +### `content` + +```swift +var content: [Widget] = [] +``` + +The widgets being arranged by the box widget. + +## Methods +### `init(horizontal:)` + +```swift +public init(horizontal: Bool = false) +``` + +Initialize a box. +- Parameter horizontal: Whether the box aligns its children horizontally or vertically. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| horizontal | Whether the box aligns its children horizontally or vertically. | + +### `append(_:)` + +```swift +public func append(_ widget: Widget) -> Self +``` + +Add a widget to the trailing or bottom of the box. +- Parameter widget: The widget. +- Returns: The box. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The widget. | + +### `prepend(_:)` + +```swift +public func prepend(_ widget: Widget) -> Self +``` + +Add a widget to the leading or top of the box. +- Parameter widget: The widget. +- Returns: The box. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The widget. | + +### `removeWidget(_:)` + +```swift +public func removeWidget(_ widget: Widget) +``` + +Remove a certain widget from the view. +- Parameter widget: The widget. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The widget. | \ No newline at end of file diff --git a/Documentation/Reference/classes/Button.md b/Documentation/Reference/classes/Button.md new file mode 100644 index 0000000..cefbdfc --- /dev/null +++ b/Documentation/Reference/classes/Button.md @@ -0,0 +1,177 @@ +**CLASS** + +# `Button` + +```swift +public class Button: Widget +``` + +A widget executing an action when being clicked. + +## Properties +### `button` + +```swift +private var button: NSButton? +``` + +The widget for macOS. + +### `button` + +The widget for Linux. + +### `action` + +```swift +var action: () -> Void = { } +``` + +The action that gets executed when the button gets pressed. + +## Methods +### `init(_:)` + +```swift +public init(_ title: String) +``` + +Initialize a button. +- Parameter title: The label of the button. + +Note that after initializing a button without an icon, you cannot add an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| title | The label of the button. | + +### `init(_:title:)` + +```swift +public init(_ icon: Icon, title: String? = nil) +``` + +Initialize a button. +- Parameters: + - icon: The icon of the button. + - title: The label of the button, or nil. + +Note that after initializing a button with an icon, you cannot get rid of it. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| icon | The icon of the button. | +| title | The label of the button, or nil. | + +### `initializeButton()` + +```swift +func initializeButton() +``` + +Initialize the button on macOS. + +### `setLabel(_:)` + +```swift +public func setLabel(_ title: String) -> Self +``` + +Set the button's label. +- Parameter title: The button's label. +- Returns: The button. + +Note that this only has an effect when the button has been initialized without an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| title | The button’s label. | + +### `setLabel(_:title:)` + +```swift +public func setLabel(_ icon: Icon, title: String? = nil) -> Self +``` + +Set the button's label and icon. +- Parameters: + - icon: The button's icon. + - title: The button's label, or nil. + +Note that this only has an effect when the button has been initialized with an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| icon | The button’s icon. | +| title | The button’s label, or nil. | + +### `buttonStyle(_:)` + +```swift +public func buttonStyle(_ style: ButtonStyle) -> Self +``` + +Set the button's style. +- Parameter style: The button's style. +- Returns: The button. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| style | The button’s style. | + +### `setAction(_:)` + +```swift +public func setAction(_ action: @escaping () -> Void) -> Self +``` + +Set the action that gets called when the button gets pressed. +- Parameter action: The action. +- Returns: The button. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| action | The action. | + +### `disabled(_:)` + +```swift +public func disabled(_ disabled: Bool = true) -> Self +``` + +Disable a button so that it cannot be clicked. +- Parameter disabled: Whether the button is disabled. +- Returns: The button. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| disabled | Whether the button is disabled. | + +### `buttonPressed(_:)` + +```swift +func buttonPressed(_ sender: Any?) +``` + +This function gets called when a button is pressed under macOS. +- Parameter sender: The sender or nil. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| sender | The sender or nil. | \ No newline at end of file diff --git a/Documentation/Reference/classes/Label.md b/Documentation/Reference/classes/Label.md new file mode 100644 index 0000000..4530718 --- /dev/null +++ b/Documentation/Reference/classes/Label.md @@ -0,0 +1,71 @@ +**CLASS** + +# `Label` + +```swift +public class Label: Widget +``` + +A widget showing a piece of text. + +## Properties +### `label` + +```swift +private var label: NSTextField? +``` + +The widget for macOS. + +### `content` + +```swift +var content: [(NSMenuItem, Menu?)] = [] +``` + +The content in macOS. + +### `label` + +The widget for Linux. + +## Methods +### `init()` + +```swift +override public init() +``` + +Initialize a label. + +### `setText(_:)` + +```swift +public func setText(_ text: String) -> Self +``` + +Set the label's text. +- Parameter text: The new text. +- Returns: The label. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| text | The new text. | + +### `setFont(_:)` + +```swift +public func setFont(_ font: Font) -> Self +``` + +Set the label's font. +- Parameter font: The label's font. +- Returns: The label. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| font | The label’s font. | \ No newline at end of file diff --git a/Documentation/Reference/classes/List.ViewController.md b/Documentation/Reference/classes/List.ViewController.md new file mode 100644 index 0000000..a2b96ab --- /dev/null +++ b/Documentation/Reference/classes/List.ViewController.md @@ -0,0 +1,180 @@ +**CLASS** + +# `List.ViewController` + +```swift +class ViewController: NSObject, NSOutlineViewDelegate, NSOutlineViewDataSource +``` + +A list view controller. + +## Properties +### `outlineView` + +```swift +let outlineView: NSOutlineView = .init() +``` + +The list. + +### `items` + +```swift +var items: [Widget] = [] +``` + +The widgets in the list. + +### `selectionObservers` + +```swift +var selectionObservers: [(Int) -> Void] = [] +``` + +The functions observing changes in the selection. + +## Methods +### `setup()` + +```swift +func setup() +``` + +Execute when the view is set up. + +### `outlineView(_:numberOfChildrenOfItem:)` + +```swift +func outlineView(_ outlineView: NSOutlineView, numberOfChildrenOfItem item: Any?) -> Int +``` + +Get the number of widgets in a list. +- Parameters: + - outlineView: The list. + - item: Number of children. +- Returns: Returns the number of widgets. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| outlineView | The list. | +| item | Number of children. | + +### `outlineView(_:isItemExpandable:)` + +```swift +func outlineView(_ outlineView: NSOutlineView, isItemExpandable item: Any) -> Bool +``` + +Get the information that a list is not expandable. +- Parameters: + - outlineView: The list. + - item: Is expandable. +- Returns: Returns always false. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| outlineView | The list. | +| item | Is expandable. | + +### `outlineView(_:child:ofItem:)` + +```swift +func outlineView(_ outlineView: NSOutlineView, child index: Int, ofItem item: Any?) -> Any +``` + +Get the item at a certain index. +- Parameters: + - outlineView: The list. + - index: The index. + - item: Get an item. +- Returns: The item. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| outlineView | The list. | +| index | The index. | +| item | Get an item. | + +### `outlineView(_:viewFor:item:)` + +```swift +func outlineView(_ outlineView: NSOutlineView, viewFor tableColumn: NSTableColumn?, item: Any) -> NSView? +``` + +Get the view for a certain widget. +- Parameters: + - outlineView: The list. + - tableColumn: The list column. + - item: The widget. +- Returns: The widget's view. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| outlineView | The list. | +| tableColumn | The list column. | +| item | The widget. | + +### `outlineView(_:heightOfRowByItem:)` + +```swift +func outlineView(_ outlineView: NSOutlineView, heightOfRowByItem item: Any) -> CGFloat +``` + +Get the height a widget needs. +- Parameters: + - outlineView: The list. + - item: The widget. +- Returns: The widget's height. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| outlineView | The list. | +| item | The widget. | + +### `selectionDidChange()` + +```swift +func selectionDidChange() +``` + +Handle selection changes. + +### `setSelectedIndex(_:)` + +```swift +func setSelectedIndex(_ index: Int) +``` + +Set the selection manually to a specific index. +- Parameter index: The index. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| index | The index. | + +### `removeAtIndex(_:)` + +```swift +func removeAtIndex(_ index: Int) +``` + +Remove an item at a certain index. +- Parameter index: The index. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| index | The index. | \ No newline at end of file diff --git a/Documentation/Reference/classes/List.md b/Documentation/Reference/classes/List.md new file mode 100644 index 0000000..1b850b6 --- /dev/null +++ b/Documentation/Reference/classes/List.md @@ -0,0 +1,170 @@ +**CLASS** + +# `List` + +```swift +public class List: Widget +``` + +A widget containing multiple items arranged in a list. + +## Properties +### `controller` + +```swift +private let controller = ViewController() +``` + +The list controller. + +### `list` + +The widget for Linux. + +## Methods +### `init()` + +```swift +override public init() +``` + +Initialize a list. + +### `append(_:)` + +```swift +public func append(_ widget: Widget) -> Self +``` + +Add a widget to the bottom of the list. +- Parameter widget: The widget. +- Returns: The list. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The widget. | + +### `append(label:icon:)` + +```swift +public func append(label: String, icon: Icon?) -> Self +``` + +Add a standard widget to the bottom of the list. +- Parameters: + - label: The widget's label. + - icon: The widget's icon. +- Returns: The list. + +A standard widget is a widget consisting of a label, and, on macOS, optionally an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| label | The widget’s label. | +| icon | The widget’s icon. | + +### `prepend(_:)` + +```swift +public func prepend(_ widget: Widget) -> Self +``` + +Add a widget to the top of the list. +- Parameter widget: The widget. +- Returns: The list. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The widget. | + +### `prepend(label:icon:)` + +```swift +public func prepend(label: String, icon: Icon?) -> Self +``` + +Add a standard widget to the top of the list. +- Parameters: + - label: The widget's label. + - icon: The widget's icon. +- Returns: The list. + +A standard widget is a widget consisting of a label, and, on macOS, optionally an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| label | The widget’s label. | +| icon | The widget’s icon. | + +### `remove(at:)` + +```swift +public func remove(at index: Int) -> Self +``` + +Remove the widget at a certain index. +- Parameter index: The index. +- Returns: The list. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| index | The index. | + +### `select(index:)` + +```swift +public func select(index: Int) +``` + +Select the widget at a certain index. +- Parameter index: The index. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| index | The index. | + +### `observeSelection(observer:)` + +```swift +public func observeSelection(observer: @escaping (Int) -> Void) +``` + +Add a closure that gets called when the selection changes. +- Parameter observer: The function taking the selection index as a parameter. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| observer | The function taking the selection index as a parameter. | + +### `label(_:icon:)` + +```swift +func label(_ label: String, icon: Icon?) -> Widget +``` + +Get a standard widget consisting of a label and optionally an icon. +- Parameters: + - label: The label. + - icon: The icon. +- Returns: The widget. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| label | The label. | +| icon | The icon. | \ No newline at end of file diff --git a/Documentation/Reference/classes/Menu.md b/Documentation/Reference/classes/Menu.md new file mode 100644 index 0000000..a7c78a3 --- /dev/null +++ b/Documentation/Reference/classes/Menu.md @@ -0,0 +1,141 @@ +**CLASS** + +# `Menu` + +```swift +public class Menu +``` + +A menu is a collection of buttons, organized in sections and submenus. + +## Properties +### `menu` + +```swift +private let menu: NSMenu = .init() +``` + +The menu for macOS. + +### `content` + +```swift +var content: [(NSMenuItem, Menu?)] = [] +``` + +The menu's content for macOS. + +### `menu` + +The menu for Linux. + +### `content` + +The menu's content for Linux. + +## Methods +### `init()` + +```swift +public init() +``` + +Initialize a menu. + +### `addButton(_:app:shortcut:handler:)` + +```swift +public func addButton( + _ label: String, + app: Application, + shortcut: KeyboardShortcut? = nil, + handler: @escaping () -> Void +) -> Self +``` + +Add a button to a menu. +- Parameters: + - label: The button's label. + - app: The application. + - shortcut: The button's keyboard shortcut. + - handler: Handle the action when the button is clicked or the shortcut is pressed. +- Returns: The menu. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| label | The button’s label. | +| app | The application. | +| shortcut | The button’s keyboard shortcut. | +| handler | Handle the action when the button is clicked or the shortcut is pressed. | + +### `addButton(_:app:id:)` + +```swift +public func addButton(_ label: String, app: Application, id: String) -> Self +``` + +Add a button to a menu that runs an action specified in the menu bar or the app's actions. +- Parameters: + - label: The button's label. + - app: The application. + - id: The label of the button that holds the original action. +- Returns: The menu. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| label | The button’s label. | +| app | The application. | +| id | The label of the button that holds the original action. | + +### `addSection(_:)` + +```swift +public func addSection(_ menu: Menu) -> Self +``` + +Add a section to a menu. +- Parameter menu: The menu in the section. +- Returns: The menu. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| menu | The menu in the section. | + +### `addSubmenu(_:_:)` + +```swift +public func addSubmenu(_ label: String, _ menu: Menu) -> Self +``` + +Add another menu inside this menu. +- Parameters: + - label: The child menu's title. + - menu: The child menu. +- Returns: The parent menu. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| label | The child menu’s title. | +| menu | The child menu. | + +### `getMenu()` + +```swift +func getMenu() -> NSMenu +``` + +Get the `NSMenu`. +- Returns: The `NSMenu`. + +### `getMenu()` + +Get the `GTUI.Menu`. +- Returns: The `GTUI.Menu`. diff --git a/Documentation/Reference/classes/MenuButton.md b/Documentation/Reference/classes/MenuButton.md new file mode 100644 index 0000000..bc95f6a --- /dev/null +++ b/Documentation/Reference/classes/MenuButton.md @@ -0,0 +1,146 @@ +**CLASS** + +# `MenuButton` + +```swift +public class MenuButton: Widget +``` + +A button that opens a menu when being pressed. + +## Properties +### `button` + +```swift +let button: Button +``` + +The widget for macOS. + +### `button` + +The widget for Linux. + +### `menu` + +```swift +let menu: Menu = .init() +``` + +The content. + +## Methods +### `init(_:)` + +```swift +public init(_ title: String) +``` + +Initialize a menu button. +- Parameter title: The label of the button. + +Note that after initializing a button without an icon, you cannot add an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| title | The label of the button. | + +### `init(_:title:)` + +```swift +public init(_ icon: Icon, title: String? = nil) +``` + +Initialize a menu button. +- Parameters: + - icon: The icon of the button. + - title: The label of the button, or nil. + +Note that after initializing a button with an icon, you cannot get rid of it. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| icon | The icon of the button. | +| title | The label of the button, or nil. | + +### `initButton()` + +```swift +func initButton() +``` + +Initialize the button. + +### `setLabel(_:)` + +```swift +public func setLabel(_ title: String) -> Self +``` + +Set the menu button's label. +- Parameter title: The button's label. +- Returns: The button. + +Note that this only has an effect when the button has been initialized without an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| title | The button’s label. | + +### `setLabel(_:title:)` + +```swift +public func setLabel(_ icon: Icon, title: String? = nil) -> Self +``` + +Set the menu button's label and icon. +- Parameters: + - icon: The button's icon. + - title: The button's label, or nil. + +Note that this only has an effect when the button has been initialized with an icon. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| icon | The button’s icon. | +| title | The button’s label, or nil. | + +### `buttonStyle(_:)` + +```swift +public func buttonStyle(_ style: ButtonStyle) -> Self +``` + +Set the button's style. +- Parameter style: The button's style. +- Returns: The button. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| style | The button’s style. | + +### `editMenu(_:)` + +```swift +public func editMenu(_ menu: (Menu) -> Void) -> Self +``` + +Edit the menu of the menu button. +- Parameter menu: The closure for editing the menu. +- Returns: The menu button. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| menu | The closure for editing the menu. | \ No newline at end of file diff --git a/Documentation/Reference/classes/NativeWrapper.md b/Documentation/Reference/classes/NativeWrapper.md new file mode 100644 index 0000000..3734404 --- /dev/null +++ b/Documentation/Reference/classes/NativeWrapper.md @@ -0,0 +1,34 @@ +**CLASS** + +# `NativeWrapper` + +```swift +public class NativeWrapper: Widget +``` + +A wrapper around native widgets. + +On macOS, it accepts an NSView, +and on Linux, you can use SwiftGui +(https://github.com/david-swift/SwiftGui). + +## Methods +### `init(_:)` + +```swift +public init(_ nativeView: NSView) +``` + +Initialize a native wrapper for macOS. +- Parameter nativeView: The NSView. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| nativeView | The NSView. | + +### `init(_:)` + +Initialize a native wrapper for Linux. +- Parameter nativeView: The class conforming to `GTUI.NativeWidgetPeer`. diff --git a/Documentation/Reference/classes/PaddingWrapper.md b/Documentation/Reference/classes/PaddingWrapper.md new file mode 100644 index 0000000..943d6d9 --- /dev/null +++ b/Documentation/Reference/classes/PaddingWrapper.md @@ -0,0 +1,52 @@ +**CLASS** + +# `PaddingWrapper` + +```swift +public class PaddingWrapper: Widget +``` + +A wrapper around a widget adding padding. + +## Properties +### `content` + +```swift +private var content: Widget +``` + +The content widget. + +## Methods +### `init(_:)` + +```swift +public init(_ content: Widget) +``` + +Initialize a padding wrapper around a widget. +- Parameter content: The widget. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| content | The widget. | + +### `setPadding(_:edges:)` + +```swift +public func setPadding(_ padding: Int, edges: Set = .all) -> Self +``` + +Customize the padding's size and the affected edges. +- Parameters: + - padding: The padding's size. + - edges: The edges being affected by the padding wrapper. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| padding | The padding’s size. | +| edges | The edges being affected by the padding wrapper. | \ No newline at end of file diff --git a/Documentation/Reference/classes/ScrollView.md b/Documentation/Reference/classes/ScrollView.md new file mode 100644 index 0000000..e08d238 --- /dev/null +++ b/Documentation/Reference/classes/ScrollView.md @@ -0,0 +1,55 @@ +**CLASS** + +# `ScrollView` + +```swift +public class ScrollView: Widget +``` + +A scrollable widget containing a child widget. + +## Properties +### `view` + +```swift +private var view: NSScrollView? +``` + +The widget for macOS. + +### `child` + +```swift +var child: Widget? +``` + +The child widget. + +### `view` + +The scroll view. + +## Methods +### `init()` + +```swift +override public init() +``` + +Initialize the scrollable widget. + +### `setChild(_:)` + +```swift +public func setChild(_ widget: Widget) -> Self +``` + +Set the `ScrollView`'s child. +- Parameter widget: The child. +- Returns: The scrollable widget. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The child. | \ No newline at end of file diff --git a/Documentation/Reference/classes/Widget.md b/Documentation/Reference/classes/Widget.md new file mode 100644 index 0000000..40548b3 --- /dev/null +++ b/Documentation/Reference/classes/Widget.md @@ -0,0 +1,22 @@ +**CLASS** + +# `Widget` + +```swift +public class Widget +``` + +A widget is a view in a window. + +## Properties +### `widget` + +```swift +public var widget: NSView = .init() +``` + +The widget as an `NSView`. + +### `widget` + +The widget as a `GTUI.NativeWidgetPeer`. diff --git a/Documentation/Reference/classes/Window.NavigationSplitViewController.md b/Documentation/Reference/classes/Window.NavigationSplitViewController.md new file mode 100644 index 0000000..db72881 --- /dev/null +++ b/Documentation/Reference/classes/Window.NavigationSplitViewController.md @@ -0,0 +1,68 @@ +**CLASS** + +# `Window.NavigationSplitViewController` + +```swift +class NavigationSplitViewController: NSSplitViewController +``` + +A controller for a window's content with a sidebar. + +## Properties +### `sidebar` + +```swift +var sidebar: NSView = .init() +``` + +The sidebar view. + +### `content` + +```swift +var content: NSView = .init() +``` + +The content view. + +## Methods +### `init(sidebar:content:)` + +```swift +init(sidebar: NSView, content: NSView) +``` + +Initialize a controller for a window window's content with a sidebar. +- Parameters: + - sidebar: The sidebar view. + - content: The content view. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| sidebar | The sidebar view. | +| content | The content view. | + +### `init(coder:)` + +```swift +required init?(coder: NSCoder) +``` + +This initializer always fails. +- Parameter coder: An `NSCoder`. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| coder | An `NSCoder`. | + +### `viewDidLoad()` + +```swift +override func viewDidLoad() +``` + +Execute after the view has been loaded. diff --git a/Documentation/Reference/classes/Window.md b/Documentation/Reference/classes/Window.md new file mode 100644 index 0000000..c69a8ca --- /dev/null +++ b/Documentation/Reference/classes/Window.md @@ -0,0 +1,43 @@ +**CLASS** + +# `Window` + +A window is a container for widgets. + +## Properties +### `window` + +The window for Linux. + +### `content` + +The window's content is an overlay split view. + +### `subContent` + +The "sub content" is the split view's content. + +### `headerBar` + +The window's header bar. + +### `app` + +The parent application. + +### `title` + +The window's title. + +### `data` + +A storage for custom data associated with the window. + +## Methods +### `init(_:id:app:)` + +Initialize a window. +- Parameters: + - title: The window's title. + - id: The window's identifier. + - app: The app. diff --git a/Documentation/Reference/enums/ButtonStyle.md b/Documentation/Reference/enums/ButtonStyle.md new file mode 100644 index 0000000..bd0d396 --- /dev/null +++ b/Documentation/Reference/enums/ButtonStyle.md @@ -0,0 +1,55 @@ +**ENUM** + +# `ButtonStyle` + +```swift +public enum ButtonStyle +``` + +The style of a button or another widget based on a button. + +## Cases +### `pill` + +```swift +case pill +``` + +A pill shape. + +### `circular` + +```swift +case circular +``` + +A circular shape. + +### `flat` + +```swift +case flat +``` + +The border is only available when being hovered. + +## Properties +### `styleName` + +The name of the style for Linux. + +## Methods +### `buttonStyle(_:)` + +```swift +func buttonStyle(_ button: NSButton) +``` + +Set the style of a button in macOS. +- Parameter button: The button + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| button | The button | \ No newline at end of file diff --git a/Documentation/Reference/enums/Edge.md b/Documentation/Reference/enums/Edge.md new file mode 100644 index 0000000..ed133ee --- /dev/null +++ b/Documentation/Reference/enums/Edge.md @@ -0,0 +1,47 @@ +**ENUM** + +# `Edge` + +```swift +public enum Edge +``` + +The edge of e.g. a widget. + +## Cases +### `top` + +```swift +case top +``` + +The top edge. + +### `bottom` + +```swift +case bottom +``` + +The bottom edge. + +### `leading` + +```swift +case leading +``` + +The leading edge. + +### `trailing` + +```swift +case trailing +``` + +The trailing edge. + +## Properties +### `gtuiEdge` + +Get the edge as a GTUI Edge for Linux. diff --git a/Documentation/Reference/enums/Font.md b/Documentation/Reference/enums/Font.md new file mode 100644 index 0000000..5234f29 --- /dev/null +++ b/Documentation/Reference/enums/Font.md @@ -0,0 +1,47 @@ +**ENUM** + +# `Font` + +```swift +public enum Font +``` + +A text style. + +## Cases +### `body` + +```swift +case body +``` + +The body text style. + +### `title1` + +```swift +case title1 +``` + +The title text style of a certain level. + +### `caption` + +```swift +case caption +``` + +The caption text style. + +## Properties +### `nsFont` + +```swift +var nsFont: NSFont +``` + +Get the font for macOS. + +### `styleName` + +Get the name of the font for Linux. diff --git a/Documentation/Reference/enums/Icon.md b/Documentation/Reference/enums/Icon.md new file mode 100644 index 0000000..fe73d2a --- /dev/null +++ b/Documentation/Reference/enums/Icon.md @@ -0,0 +1,83 @@ +**ENUM** + +# `Icon` + +```swift +public enum Icon +``` + +An icon for widgets displaying icons. + +## Cases +### `plus` + +```swift +case plus +``` + +### `menu` + +```swift +case menu +``` + +### `avatar` + +```swift +case avatar +``` + +### `warning` + +```swift +case warning +``` + +### `find` + +```swift +case find +``` + +### `sidebar` + +```swift +case sidebar +``` + +### `reload` + +```swift +case reload +``` + +### `number` + +```swift +case number +``` + +### `platformDependent(linux:mac:)` + +```swift +case platformDependent(linux: String, mac: String) +``` + +An icon which has a different string for Linux and macOS. + +### `platformIndependent(name:)` + +```swift +case platformIndependent(name: String) +``` + +An icon which has the same string for Linux and macOS. + +## Properties +### `iconName` + +```swift +var iconName: String +``` + +A string representing an icon. diff --git a/Documentation/Reference/enums/KeyboardShortcut.ShortcutCharacter.md b/Documentation/Reference/enums/KeyboardShortcut.ShortcutCharacter.md new file mode 100644 index 0000000..da216f5 --- /dev/null +++ b/Documentation/Reference/enums/KeyboardShortcut.ShortcutCharacter.md @@ -0,0 +1,91 @@ +**ENUM** + +# `KeyboardShortcut.ShortcutCharacter` + +```swift +public enum ShortcutCharacter +``` + +The special characters available for shortcuts. + +## Cases +### `backspace` + +```swift +case backspace +``` + +The ⌫ character. + +### `delete` + +```swift +case delete +``` + +The ⌦ character. + +### `tab` + +```swift +case tab +``` + +The ⇥ character. + +### `enter` + +```swift +case enter +``` + +The ⏎ character. + +### `escape` + +```swift +case escape +``` + +The ⎋ character. + +### `space` + +```swift +case space +``` + +The ␣ character. + +### `up` + +```swift +case up +``` + +An arrow key. + +### `character(_:)` + +```swift +case character(_ character: Character) +``` + +A custom character. + +## Properties +### `macOSRepresentation` + +```swift +var macOSRepresentation: String +``` + +A representation of the keys for macOS. + +### `linuxRepresentation` + +```swift +var linuxRepresentation: String +``` + +A representation of the keys for Linux. diff --git a/Documentation/Reference/extensions/NSView.md b/Documentation/Reference/extensions/NSView.md new file mode 100644 index 0000000..9467ec3 --- /dev/null +++ b/Documentation/Reference/extensions/NSView.md @@ -0,0 +1,37 @@ +**EXTENSION** + +# `NSView` +```swift +extension NSView +``` + +## Methods +### `equalConstraints(_:)` + +```swift +func equalConstraints(_ view: NSView?) +``` + +Equalize the top, bottom, leading and trailing anchors of two views. +- Parameter view: Another view. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| view | Another view. | + +### `center(_:)` + +```swift +func center(_ view: NSView?) +``` + +Center a view inside of another. +- Parameter view: One of the views. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| view | One of the views. | \ No newline at end of file diff --git a/Documentation/Reference/extensions/Set.md b/Documentation/Reference/extensions/Set.md new file mode 100644 index 0000000..cc2bb3f --- /dev/null +++ b/Documentation/Reference/extensions/Set.md @@ -0,0 +1,80 @@ +**EXTENSION** + +# `Set` +```swift +extension Set where Element == Edge +``` + +## Properties +### `all` + +```swift +public static var all: Self +``` + +A set of the vertical and horizontal edges. + +### `vertical` + +```swift +public static var vertical: Self +``` + +A set of the top and bottom edge. + +### `horizontal` + +```swift +public static var horizontal: Self +``` + +A set of the leading and trailing edge. + +### `top` + +```swift +public static var top: Self +``` + +A set of the top edge. + +### `bottom` + +```swift +public static var bottom: Self +``` + +A set of the bottom edge. + +### `leading` + +```swift +public static var leading: Self +``` + +A set of the leading edge. + +### `trailing` + +```swift +public static var trailing: Self +``` + +A set of the trailing edge. + +## Methods +### `add(_:)` + +```swift +public func add(_ edges: Self) -> Self +``` + +Combine two sets of edges. +- Parameter edges: The edges. +- Returns: The combined set of edges. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| edges | The edges. | \ No newline at end of file diff --git a/Documentation/Reference/extensions/String.md b/Documentation/Reference/extensions/String.md new file mode 100644 index 0000000..be2c6d5 --- /dev/null +++ b/Documentation/Reference/extensions/String.md @@ -0,0 +1,8 @@ +**EXTENSION** + +# `String` + +## Properties +### `linuxID` + +Convert a string into a valid action ID. diff --git a/Documentation/Reference/extensions/Window.md b/Documentation/Reference/extensions/Window.md new file mode 100644 index 0000000..9b85342 --- /dev/null +++ b/Documentation/Reference/extensions/Window.md @@ -0,0 +1,225 @@ +**EXTENSION** + +# `Window` +```swift +extension Window: NSToolbarDelegate +``` + +## Methods +### `toolbarDefaultItemIdentifiers(_:)` + +```swift +public func toolbarDefaultItemIdentifiers(_ toolbar: NSToolbar) -> [NSToolbarItem.Identifier] +``` + +The identifier of the toolbar items. +- Parameter toolbar: The toolbar. +- Returns: The identifiers. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| toolbar | The toolbar. | + +### `toolbarAllowedItemIdentifiers(_:)` + +```swift +public func toolbarAllowedItemIdentifiers(_ toolbar: NSToolbar) -> [NSToolbarItem.Identifier] +``` + +The identifier of the toolbar items. +- Parameter toolbar: The toolbar. +- Returns: The identifiers. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| toolbar | The toolbar. | + +### `toolbar(_:itemForItemIdentifier:willBeInsertedIntoToolbar:)` + +```swift +public func toolbar( + _ toolbar: NSToolbar, + itemForItemIdentifier itemIdentifier: NSToolbarItem.Identifier, + willBeInsertedIntoToolbar flag: Bool +) -> NSToolbarItem? +``` + +Get the toolbar item with a specific identifier. +- Parameters: + - toolbar: The toolbar. + - itemIdentifier: The toolbar item's identifier. + - flag: Whether it will be inserted into the toolbar. +- Returns: The toolbar item. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| toolbar | The toolbar. | +| itemIdentifier | The toolbar item’s identifier. | +| flag | Whether it will be inserted into the toolbar. | + +### `addToolbarItem(_:label:navigational:)` + +```swift +public func addToolbarItem(_ widget: Widget, label: String, navigational: Bool = false) +``` + +Add a toolbar item to the window. +- Parameters: + - widget: The widget. + - label: The label for macOS. + - navigational: Whether it is added to the left of the toolbar. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The widget. | +| label | The label for macOS. | +| navigational | Whether it is added to the left of the toolbar. | + +### `setSidebar(_:)` + +```swift +public func setSidebar(_ widget: Widget) +``` + +Add a sidebar to the window. +- Parameter widget: The sidebar's content. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| widget | The sidebar’s content. | + +### `makeSimpleWindow(title:backgroundEffect:)` + +```swift +public func makeSimpleWindow(title: Bool = true, backgroundEffect: Bool = false) +``` + +Transform the window into a "simple" window that is not resizable. +- Parameters: + - title: Whether the title is visible on macOS. + - backgroundEffect: Whether the background is blurry on macOS. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| title | Whether the title is visible on macOS. | +| backgroundEffect | Whether the background is blurry on macOS. | + +### `makeNormalWindow()` + +```swift +public func makeNormalWindow() +``` + +Transform a window into a "normal", resizable window. + +### `makeNotBlurryWindow()` + +```swift +func makeNotBlurryWindow() +``` + +Remove the blur effect from a window. + +### `setContent()` + +```swift +func setContent() +``` + +Update the window's content. + +### `addChild(_:)` + +```swift +public func addChild(_ child: Widget) +``` + +Add a child to the window's content view. +- Parameter child: The child. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| child | The child. | + +### `setDefaultSize(width:height:)` + +```swift +public func setDefaultSize(width: Int, height: Int) +``` + +Set the default size of the window. +- Parameters: + - width: The window's width. + - height: The window's height. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| width | The window’s width. | +| height | The window’s height. | + +### `setMinimumSize(width:height:)` + +```swift +public func setMinimumSize(width: Int, height: Int) +``` + +Set the window's minimum size for macOS. +- Parameters: + - width: The window's minimum width. + - height: The window's minimum height. + +On Linux, the window can shrink to the content's size. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| width | The window’s minimum width. | +| height | The window’s minimum height. | + +### `setMainMenu(_:)` + +```swift +public func setMainMenu(_ menu: Menu) +``` + +Set the main menu of the window which is visible in the toolbar in GNOME. +- Parameter menu: The main menu. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| menu | The main menu. | + +### `show()` + +```swift +public func show() +``` + +Present the window. + +### `close()` + +```swift +public func close() +``` + +Close the window. diff --git a/Documentation/Reference/structs/KeyboardShortcut.md b/Documentation/Reference/structs/KeyboardShortcut.md new file mode 100644 index 0000000..e5eed01 --- /dev/null +++ b/Documentation/Reference/structs/KeyboardShortcut.md @@ -0,0 +1,111 @@ +**STRUCT** + +# `KeyboardShortcut` + +```swift +public struct KeyboardShortcut +``` + +A keyboard shortcut used e.g. in menus. + +## Properties +### `deleteShortcut` + +```swift +public static var deleteShortcut: Self +``` + +A shortcut often use for "Delete" actions which is the "Delete" key on Linux and ⌘⌫ on macOS. + +### `character` + +```swift +public var character: ShortcutCharacter +``` + +The character or a sequence representing a letter or symbol. + +### `ctrl` + +```swift +public var ctrl: Bool +``` + +Whether the Ctrl key is part of the shortcut. + +### `shift` + +```swift +public var shift: Bool +``` + +Whether the Shift key is part of the shortcut. + +### `alt` + +```swift +public var alt: Bool +``` + +Whether the Alt key is part of the shortcut. + +### `macModifiers` + +```swift +var macModifiers: NSEvent.ModifierFlags +``` + +The modifiers for the macOS shortcut. + +### `linuxShortcut` + +```swift +var linuxShortcut: String +``` + +The shortcut in a representation for Linux. + +## Methods +### `init(_:ctrl:shift:alt:)` + +```swift +public init(_ character: Character, ctrl: Bool = true, shift: Bool = false, alt: Bool = false) +``` + +Initialize a keyboard shortcut. +- Parameters: + - character: A letter. + - ctrl: Whether Ctrl is part of the shortcut. + - shift: Whether Shift is part of the shortcut. + - alt: Whether Alt is part of the shortcut. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| character | A letter. | +| ctrl | Whether Ctrl is part of the shortcut. | +| shift | Whether Shift is part of the shortcut. | +| alt | Whether Alt is part of the shortcut. | + +### `init(symbol:ctrl:shift:alt:)` + +```swift +public init(symbol: ShortcutCharacter, ctrl: Bool = true, shift: Bool = false, alt: Bool = false) +``` + +Initialize a keyboard shortcut. +- Parameters: + - symbol: A character. + - ctrl: Whether Ctrl is part of the shortcut. + - shift: Whether Shift is part of the shortcut. + - alt: Whether Alt is part of the shortcut. + +#### Parameters + +| Name | Description | +| ---- | ----------- | +| symbol | A character. | +| ctrl | Whether Ctrl is part of the shortcut. | +| shift | Whether Shift is part of the shortcut. | +| alt | Whether Alt is part of the shortcut. | \ No newline at end of file diff --git a/Icons/DvandvaIcon.png b/Icons/DvandvaIcon.png new file mode 100644 index 0000000..5d2fbab Binary files /dev/null and b/Icons/DvandvaIcon.png differ diff --git a/Icons/DvandvaIcon.pxd b/Icons/DvandvaIcon.pxd new file mode 100644 index 0000000..079773e Binary files /dev/null and b/Icons/DvandvaIcon.pxd differ diff --git a/Icons/GitHubBanner.png b/Icons/GitHubBanner.png new file mode 100644 index 0000000..17eceb9 Binary files /dev/null and b/Icons/GitHubBanner.png differ diff --git a/Icons/GitHubBanner.pxd b/Icons/GitHubBanner.pxd new file mode 100644 index 0000000..9e80ae1 Binary files /dev/null and b/Icons/GitHubBanner.pxd differ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..10926e8 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..082f5a4 --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +docs: + @sourcedocs generate --min-acl private -r --spm-module Dvandva + +swiftlint: + @swiftlint --autocorrect + +run: + @mint run swift-bundler run + +run-linux: + @swift run + +clean: + @swift package clean diff --git a/Package.swift b/Package.swift new file mode 100644 index 0000000..5ba2620 --- /dev/null +++ b/Package.swift @@ -0,0 +1,55 @@ +// swift-tools-version: 5.8 +// +// Package.swift +// Dvandva +// +// Created by david-swift on 28.10.23. +// + +import PackageDescription + +/// The dependencies for the Swift package. +let dependencies: [Package.Dependency] + +#if os(macOS) +dependencies = [] +#else +dependencies = [.package(url: "https://github.com/david-swift/SwiftGui", from: "0.1.1")] +#endif + +/// The dependencies for the "Dvandva" target. +let targetDependencies: [Target.Dependency] + +#if os(macOS) +targetDependencies = [] +#else +targetDependencies = [ + .product(name: "GTUI", package: "SwiftGui", condition: .when(platforms: [.linux, .openbsd, .windows])) +] +#endif + +/// The Dvandva package. +let package = Package( + name: "Dvandva", + platforms: [ + .macOS(.v11) + ], + products: [ + .library( + name: "Dvandva", + targets: ["Dvandva"] + ) + ], + dependencies: dependencies, + targets: [ + .target( + name: "Dvandva", + dependencies: targetDependencies + ), + .executableTarget( + name: "Test", + dependencies: ["Dvandva"], + path: "Tests" + ) + ] +) diff --git a/README.md b/README.md new file mode 100644 index 0000000..bbc1a99 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +

+ Dvandva Icon +

Dvandva

+

+ +

+ + GitHub + + · + + Contributor Docs + +

+ +_Dvandva_ is a framework for creating user interfaces for GNOME and macOS with one shared code. + +![GitHub Banner](Icons/GitHubBanner.png) + +## Table of Contents + +- [Goals](#Goals) +- [Installation](#Installation) +- [Usage](#Usage) +- [Thanks](#Thanks) + +## Goals + +_Dvandva_’s goal is not to provide bindings for every widget on both platforms, but to make the creation of cross-platform apps easier. It’s always possible to add any widget to an app using the `NativeWrapper` widget. + +If you find yourself using `NativeWrapper` for a widget that is available on both platforms in a similar form, consider opening an issue [here](https://github.com/david-swift/Dvandva/issues). + +## Installation +### Dependencies +If you are using a Linux distribution, install `libadwaita-devel` or `libadwaita` (or something similar, based on the package manager) as well as `gtk4-devel`, `gtk4` or similar. + +On macOS, I recommend installing [Swift Bundler](https://github.com/stackotter/swift-bundler?tab=readme-ov-file#installation-). + +### Swift Package +1. Open your Swift package in GNOME Builder, Xcode, or any other IDE. +2. Open the `Package.swift` file. +3. Into the `Package` initializer, under `dependencies`, paste: +```swift +.package(url: "https://github.com/david-swift/Dvandva", from: "0.1.0") +``` + +## Usage + +Create an executable target in the Swift package and add the following code: +```swift +import Dvandva + +let app = Application("AppName", version: "0.1.0", id: "id.for.Gnome", developer: "Developer") + +app.run { + let window = Window(id: "main", app: app) + window.setChild( + PaddingWrapper( + Label().setText("Hello, world!") + ) + .setPadding(20) + ) + window.show() +} +``` + +Now, you can modify the windows. Take a look at the [sample app](Tests/main.swift) and the [docs](Documentation/Reference/README.md) for help. + +### Run the App +On macOS, I recommend using [Swift Bundler](https://github.com/stackotter/swift-bundler) for building the app. When building the app simply with `swift run`, the menu bar and therefore keyboard shortcuts are not supported. + +On Linux, you can simply use `swift run`. In certain scenarios, setting up a Flatpak with the [Swift extension](https://github.com/david-swift/org.freedesktop.Sdk.Extension.swift) may be sensible. [This tutorial](https://docs.flatpak.org/en/latest/getting-started.html) is very helpful. + +## Thanks + +### Dependencies +- [SwiftGui](https://github.com/david-swift/SwiftGui) licensed under the [GPL-3.0 license](https://github.com/david-swift/SwiftGui/blob/main/COPYING) + +### Other Thanks +- The [contributors](Contributors.md) +- [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated +- The programming language [Swift](https://github.com/apple/swift) +- [SourceDocs](https://github.com/SourceDocs/SourceDocs) used for generating the [docs](Documentation/Reference/README.md) +- [AppKit](https://developer.apple.com/documentation/appkit/#) and [Libadwaita](https://gitlab.gnome.org/GNOME/libadwaita) for the widgets diff --git a/Sources/Dvandva/Application.swift b/Sources/Dvandva/Application.swift new file mode 100644 index 0000000..64154c5 --- /dev/null +++ b/Sources/Dvandva/Application.swift @@ -0,0 +1,252 @@ +// +// Application.swift +// Dvandva +// +// Created by david-swift on 01.11.2023. +// + +#if os(macOS) +import AppKit +#else +import Foundation +import GTUI +#endif + +/// The application. +/// +/// Do not initialize multiple apps per target. +public class Application { + +#if os(macOS) + /// The shared NSApplication for macOS. + let application: NSApplication = .shared + /// The app's main menu for macOS. + let mainMenu: NSMenu = .init() + /// The "Windows" menu for macOS. + let windowsItem = NSMenuItem(title: "Window", action: nil, keyEquivalent: "") + /// The "Help" menu for macOS. + let helpItem = NSMenuItem(title: "Help", action: nil, keyEquivalent: "") + /// The handlers for menus for macOS. + var menuItemHandlers: [NSMenuItem: () -> Void] = [:] + /// Identifiers of the actions. + var actionIdentifiers: [String: NSMenuItem] = [:] + /// The currently active window. + public var keyWindow: Window? { + windows.first { $0.window == application.keyWindow } + } +#else + /// The application for Linux. + public let application: GTUIApp + /// The currently active window. + public var keyWindow: Window? { + windows.first { $0.window.nativePtr == application.getActiveWindow() } + } +#endif + /// The application's name. + public var appName: String + /// The application's version string. + public var appVersion: String + /// The application's developer. + var developer: String + /// The application's website for help. + var helpURL: URL? + /// The website for suggesting new features. + var issue: URL? + /// The available application windows. + var windows: [Window] = [] + + /// Initialize a new application. + /// - Parameters: + /// - appName: The application's name. + /// - version: The application's version string. + /// - id: The application's identifier conforming to the GNOME app ID guidelines. + /// - developer: The application's developer. + public init(_ appName: String, version: String, id: String, developer: String) { + self.appName = appName + appVersion = version + self.developer = developer + #if !os(macOS) + self.application = .init(name: id) + #endif + #if os(macOS) + createDefaultMenus() + #else + application.actions.append(addDefaultShortcuts) + #endif + } + + #if !os(macOS) + /// The GTUI Application type for an application in Dvandva. + public class GTUIApp: GTUI.Application { + + /// Actions to run when being activated. + var actions: [() -> Void] = [] + + /// Run this function when being activated before being executed. + override public func onActivate() { + for action in actions { + action() + } + } + + } + #endif + + /// Add a menu. + /// On macOS, it appears in the menu bar. + /// On Linux, its actions are added to the app with the keyboard shortcuts. + /// You can use an action in any button in a menu + /// by setting `id` to the label of the button holding the action in the menu bar instead of a closure. + /// - Parameters: + /// - title: The title of the menu in the menu bar. + /// - menu: The menu. + public func addMenu(_ title: String, menu: Menu) { + #if os(macOS) + let item = NSMenuItem(title: title, action: nil, keyEquivalent: "") + mainMenu.addItem(item) + mainMenu.setSubmenu(menu.getMenu(), for: item) + mainMenu.removeItem(windowsItem) + mainMenu.addItem(windowsItem) + mainMenu.removeItem(helpItem) + mainMenu.addItem(helpItem) + #else + for action in menu.content { + application.addKeyboardShortcut( + action.value.0?.linuxShortcut ?? "", + id: action.key.linuxID, + handler: action.value.1 + ) + } + #endif + } + + /// Set the URL displayed in the "Help" menu on macOS or in the "About" window on Linux. + /// - Parameter url: The help URL. + public func setHelp(url: URL) { + helpURL = url + } + + /// Set the URL displayed in the "Help" menu on macOS + /// or in the "About" window on Linux for suggesting new features and reporting bugs. + /// - Parameter url: The issue URL. + public func setIssue(url: URL) { + issue = url + } + + /// Run the application. + /// - Parameter modify: Every modification on the application should happen in this closure. + public func run(_ modify: @escaping () -> Void) { + #if os(macOS) + modify() + #else + application.actions.append(modify) + #endif + application.run() + } + + #if os(macOS) + /// Add the default menus to the menu bar. + private func createDefaultMenus() { + let appMenu = NSMenu() + let helpMenu = NSMenu() + let windowsMenu = NSMenu() + + let aboutButton = NSMenuItem(title: "About \(appName)", action: #selector(self.about(_:)), keyEquivalent: "") + aboutButton.target = self + appMenu.addItem(aboutButton) + + appMenu.addItem(NSMenuItem.separator()) + appMenu.addItem(withTitle: "Hide \(appName)", action: #selector(NSApplication.hide(_:)), keyEquivalent: "h") + appMenu.addItem( + withTitle: "Hide Others", + action: #selector(NSApplication.hideOtherApplications(_:)), + keyEquivalent: "H" + ) + appMenu.addItem( + withTitle: "Show All", + action: #selector(NSApplication.unhideAllApplications(_:)), + keyEquivalent: "" + ) + appMenu.addItem(NSMenuItem.separator()) + appMenu.addItem( + withTitle: "Quit \(appName)", + action: #selector(NSApplication.terminate(_:)), + keyEquivalent: "q" + ) + + let helpButton = NSMenuItem(title: "\(appName) Help", action: #selector(help(_:)), keyEquivalent: "") + helpButton.target = self + helpMenu.addItem(helpButton) + + let issueButton = NSMenuItem(title: "Report an Issue", action: #selector(issue(_:)), keyEquivalent: "") + issueButton.target = self + helpMenu.addItem(issueButton) + + let appItem = NSMenuItem(title: appName, action: nil, keyEquivalent: "") + mainMenu.addItem(appItem) + mainMenu.setSubmenu(appMenu, for: appItem) + + mainMenu.addItem(windowsItem) + mainMenu.setSubmenu(windowsMenu, for: windowsItem) + + mainMenu.addItem(helpItem) + mainMenu.setSubmenu(helpMenu, for: helpItem) + + application.mainMenu = mainMenu + application.helpMenu = helpMenu + application.windowsMenu = windowsMenu + } + + /// Open the about window. + /// - Parameter sender: The sender. + @objc + func about(_ sender: Any?) { + let aboutWindow = Window("About \(appName)", id: "about", app: self) + aboutWindow.makeSimpleWindow(title: false, backgroundEffect: true) + let view = NSImageView(image: NSApp.applicationIconImage ?? .init()) + let box = Box() + .append(NativeWrapper(view)) + .append(Label().setText(appName).setFont(.title1)) + .append(Label().setText(developer)) + .append(Button(appVersion).buttonStyle(.pill).disabled()) + let padding = 20 + aboutWindow.addChild(PaddingWrapper(box).setPadding(padding)) + aboutWindow.show() + } + + /// Open the help URL. + /// - Parameter sender: The sender. + @objc + func help(_ sender: Any?) { + if let helpURL { + NSWorkspace.shared.open(helpURL) + } + } + + /// Open the issue URL. + /// - Parameter sender: The sender. + @objc + func issue(_ sender: Any?) { + if let issue { + NSWorkspace.shared.open(issue) + } + } + + /// Execute an action in a menu. + /// - Parameter sender: The menu item that calls the action. + @objc + func menuAction(_ sender: NSMenuItem?) { + if let sender { + menuItemHandlers[sender]?() + } + } + #else + /// Add the default keyboard shortcuts on Linux. + private func addDefaultShortcuts() { + application.addKeyboardShortcut("q".ctrl(), id: "quit") { + self.application.quit() + } + } + #endif + +} diff --git a/Sources/Dvandva/Extensions/NSView.swift b/Sources/Dvandva/Extensions/NSView.swift new file mode 100644 index 0000000..70f80e3 --- /dev/null +++ b/Sources/Dvandva/Extensions/NSView.swift @@ -0,0 +1,38 @@ +// +// NSView.swift +// Dvandva +// +// Created by david-swift on 19.11.2023. +// + +#if os(macOS) +import AppKit + +extension NSView { + + /// Equalize the top, bottom, leading and trailing anchors of two views. + /// - Parameter view: Another view. + func equalConstraints(_ view: NSView?) { + if let view { + NSLayoutConstraint.activate([ + topAnchor.constraint(equalTo: view.topAnchor), + bottomAnchor.constraint(equalTo: view.bottomAnchor), + leadingAnchor.constraint(equalTo: view.leadingAnchor), + trailingAnchor.constraint(equalTo: view.trailingAnchor) + ]) + } + } + + /// Center a view inside of another. + /// - Parameter view: One of the views. + func center(_ view: NSView?) { + if let view { + NSLayoutConstraint.activate([ + centerXAnchor.constraint(equalTo: view.centerXAnchor), + centerYAnchor.constraint(equalTo: view.centerYAnchor) + ]) + } + } + +} +#endif diff --git a/Sources/Dvandva/Extensions/Set.swift b/Sources/Dvandva/Extensions/Set.swift new file mode 100644 index 0000000..60f1074 --- /dev/null +++ b/Sources/Dvandva/Extensions/Set.swift @@ -0,0 +1,54 @@ +// +// Set.swift +// Dvandva +// +// Created by david-swift on 12.11.2023. +// + +import Foundation + +extension Set where Element == Edge { + + /// A set of the vertical and horizontal edges. + public static var all: Self { + vertical.union(horizontal) + } + + /// A set of the top and bottom edge. + public static var vertical: Self { + top.union(bottom) + } + + /// A set of the leading and trailing edge. + public static var horizontal: Self { + leading.union(trailing) + } + + /// A set of the top edge. + public static var top: Self { + [.top] + } + + /// A set of the bottom edge. + public static var bottom: Self { + [.bottom] + } + + /// A set of the leading edge. + public static var leading: Self { + [.leading] + } + + /// A set of the trailing edge. + public static var trailing: Self { + [.trailing] + } + + /// Combine two sets of edges. + /// - Parameter edges: The edges. + /// - Returns: The combined set of edges. + public func add(_ edges: Self) -> Self { + self.union(edges) + } + +} diff --git a/Sources/Dvandva/Extensions/String.swift b/Sources/Dvandva/Extensions/String.swift new file mode 100644 index 0000000..721f61f --- /dev/null +++ b/Sources/Dvandva/Extensions/String.swift @@ -0,0 +1,19 @@ +// +// String.swift +// Dvandva +// +// Created by david-swift on 16.11.2023. +// + +#if !os(macOS) +import GTUI + +extension String { + + /// Convert a string into a valid action ID. + var linuxID: String { + replacingOccurrences(of: " ", with: "_") + } + +} +#endif diff --git a/Sources/Dvandva/Extensions/Window+.swift b/Sources/Dvandva/Extensions/Window+.swift new file mode 100644 index 0000000..9afebdb --- /dev/null +++ b/Sources/Dvandva/Extensions/Window+.swift @@ -0,0 +1,42 @@ +// +// Window+.swift +// Dvandva +// +// Created by david-swift on 19.11.2023. +// + +#if os(macOS) +import AppKit + +extension Window: NSToolbarDelegate { + + /// The identifier of the toolbar items. + /// - Parameter toolbar: The toolbar. + /// - Returns: The identifiers. + public func toolbarDefaultItemIdentifiers(_ toolbar: NSToolbar) -> [NSToolbarItem.Identifier] { + toolbarItems.map { $0.itemIdentifier } + } + + /// The identifier of the toolbar items. + /// - Parameter toolbar: The toolbar. + /// - Returns: The identifiers. + public func toolbarAllowedItemIdentifiers(_ toolbar: NSToolbar) -> [NSToolbarItem.Identifier] { + toolbarItems.map { $0.itemIdentifier } + } + + /// Get the toolbar item with a specific identifier. + /// - Parameters: + /// - toolbar: The toolbar. + /// - itemIdentifier: The toolbar item's identifier. + /// - flag: Whether it will be inserted into the toolbar. + /// - Returns: The toolbar item. + public func toolbar( + _ toolbar: NSToolbar, + itemForItemIdentifier itemIdentifier: NSToolbarItem.Identifier, + willBeInsertedIntoToolbar flag: Bool + ) -> NSToolbarItem? { + toolbarItems.first { $0.itemIdentifier == itemIdentifier } + } + +} +#endif diff --git a/Sources/Dvandva/Menu.swift b/Sources/Dvandva/Menu.swift new file mode 100644 index 0000000..6e14fde --- /dev/null +++ b/Sources/Dvandva/Menu.swift @@ -0,0 +1,130 @@ +// +// Menu.swift +// Dvandva +// +// Created by david-swift on 01.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A menu is a collection of buttons, organized in sections and submenus. +public class Menu { + +#if os(macOS) + /// The menu for macOS. + private let menu: NSMenu = .init() + /// The menu's content for macOS. + var content: [(NSMenuItem, Menu?)] = [] +#else + /// The menu for Linux. + private let menu: GTUI.Menu = .init() + /// The menu's content for Linux. + var content: [String: (KeyboardShortcut?, () -> Void)] = [:] +#endif + + /// Initialize a menu. + public init() { } + + /// Add a button to a menu. + /// - Parameters: + /// - label: The button's label. + /// - app: The application. + /// - shortcut: The button's keyboard shortcut. + /// - handler: Handle the action when the button is clicked or the shortcut is pressed. + /// - Returns: The menu. + public func addButton( + _ label: String, + app: Application, + shortcut: KeyboardShortcut? = nil, + handler: @escaping () -> Void + ) -> Self { + #if os(macOS) + let menuItem = NSMenuItem( + title: label, + action: #selector(app.menuAction(_:)), + keyEquivalent: shortcut?.character.macOSRepresentation ?? "" + ) + menuItem.keyEquivalentModifierMask = shortcut?.macModifiers ?? [] + menuItem.target = app + content.append((menuItem, nil)) + app.menuItemHandlers[menuItem] = handler + app.actionIdentifiers[label] = menuItem + #else + _ = menu.append(label, app: app.application, shortcut: shortcut?.linuxShortcut ?? "", handler: handler) + content[label] = (shortcut, handler) + #endif + return self + } + + /// Add a button to a menu that runs an action specified in the menu bar or the app's actions. + /// - Parameters: + /// - label: The button's label. + /// - app: The application. + /// - id: The label of the button that holds the original action. + /// - Returns: The menu. + public func addButton(_ label: String, app: Application, id: String) -> Self { + #if os(macOS) + if let item = app.actionIdentifiers[id], let handler = app.menuItemHandlers[item] { + _ = addButton(label, app: app, handler: handler) + } + #else + _ = menu.append(label, id: "app.\(id.linuxID)") + #endif + return self + } + + /// Add a section to a menu. + /// - Parameter menu: The menu in the section. + /// - Returns: The menu. + public func addSection(_ menu: Menu) -> Self { + #if os(macOS) + content.append((NSMenuItem.separator(), nil)) + content += menu.content + #else + _ = self.menu.append("", section: menu.menu) + content.merge(menu.content) { first, _ in first } + #endif + return self + } + + /// Add another menu inside this menu. + /// - Parameters: + /// - label: The child menu's title. + /// - menu: The child menu. + /// - Returns: The parent menu. + public func addSubmenu(_ label: String, _ menu: Menu) -> Self { + #if os(macOS) + let menuItem = NSMenuItem(title: label, action: nil, keyEquivalent: "") + content.append((menuItem, menu)) + #else + _ = self.menu.append(label, submenu: menu.menu) + content.merge(menu.content) { first, _ in first } + #endif + return self + } + + #if os(macOS) + /// Get the `NSMenu`. + /// - Returns: The `NSMenu`. + func getMenu() -> NSMenu { + menu.items = content.map { $0.0 } + for item in content { + if let menu = item.1 { + self.menu.setSubmenu(menu.getMenu(), for: item.0) + } + } + return menu + } + #else + /// Get the `GTUI.Menu`. + /// - Returns: The `GTUI.Menu`. + func getMenu() -> GTUI.Menu { + menu + } + #endif + +} diff --git a/Sources/Dvandva/Swift/ButtonStyle.swift b/Sources/Dvandva/Swift/ButtonStyle.swift new file mode 100644 index 0000000..753f76f --- /dev/null +++ b/Sources/Dvandva/Swift/ButtonStyle.swift @@ -0,0 +1,49 @@ +// +// ButtonStyle.swift +// Dvandva +// +// Created by david-swift on 12.11.2023. +// + +#if os(macOS) +import AppKit +#endif + +/// The style of a button or another widget based on a button. +public enum ButtonStyle { + + /// A pill shape. + case pill + /// A circular shape. + case circular + /// The border is only available when being hovered. + case flat + + #if !os(macOS) + /// The name of the style for Linux. + var styleName: String { + switch self { + case .pill: + return "pill" + case .circular: + return "circular" + case .flat: + return "flat" + } + } + #else + /// Set the style of a button in macOS. + /// - Parameter button: The button + func buttonStyle(_ button: NSButton) { + switch self { + case .pill: + button.bezelStyle = .badge + case .circular: + button.bezelStyle = .circular + case .flat: + button.bezelStyle = .toolbar + } + } + #endif + +} diff --git a/Sources/Dvandva/Swift/Edge.swift b/Sources/Dvandva/Swift/Edge.swift new file mode 100644 index 0000000..9f7e41a --- /dev/null +++ b/Sources/Dvandva/Swift/Edge.swift @@ -0,0 +1,40 @@ +// +// Edge.swift +// Dvandva +// +// Created by david-swift on 12.11.2023. +// + +#if !os(macOS) +import GTUI +#endif + +/// The edge of e.g. a widget. +public enum Edge { + + /// The top edge. + case top + /// The bottom edge. + case bottom + /// The leading edge. + case leading + /// The trailing edge. + case trailing + + #if !os(macOS) + /// Get the edge as a GTUI Edge for Linux. + var gtuiEdge: GTUI.Edge { + switch self { + case .top: + return .top + case .bottom: + return .bottom + case .leading: + return .leading + case .trailing: + return .trailing + } + } + #endif + +} diff --git a/Sources/Dvandva/Swift/Font.swift b/Sources/Dvandva/Swift/Font.swift new file mode 100644 index 0000000..ddbbe5c --- /dev/null +++ b/Sources/Dvandva/Swift/Font.swift @@ -0,0 +1,58 @@ +// +// Font.swift +// Dvandva +// +// Created by david-swift on 08.11.2023. +// + +#if os(macOS) +import AppKit +#endif + +/// A text style. +public enum Font { + + /// The body text style. + case body + /// The title text style of a certain level. + case title1, title2, title3 + /// The caption text style. + case caption + + #if os(macOS) + /// Get the font for macOS. + var nsFont: NSFont { + let font: NSFont + switch self { + case .body: + font = .preferredFont(forTextStyle: .body) + case .title1: + font = .preferredFont(forTextStyle: .title1) + case .title2: + font = .preferredFont(forTextStyle: .title2) + case .title3: + font = .preferredFont(forTextStyle: .title3) + case .caption: + font = .preferredFont(forTextStyle: .caption2) + } + return self == .body || self == .caption ? font : NSFontManager.shared.convert(font, toHaveTrait: .boldFontMask) + } + #else + /// Get the name of the font for Linux. + var styleName: String { + switch self { + case .body: + return "body" + case .title1: + return "title-1" + case .title2: + return "title-2" + case .title3: + return "title-3" + case .caption: + return "caption" + } + } + #endif + +} diff --git a/Sources/Dvandva/Swift/Icon.swift b/Sources/Dvandva/Swift/Icon.swift new file mode 100644 index 0000000..56b99d1 --- /dev/null +++ b/Sources/Dvandva/Swift/Icon.swift @@ -0,0 +1,77 @@ +// +// Icon.swift +// Dvandva +// +// Created by david-swift on 12.11.2023. +// + +/// An icon for widgets displaying icons. +public enum Icon { + + // swiftlint:disable missing_docs + case plus + case menu + case avatar + case warning + case find + case sidebar + case reload + case number + // swiftlint:enable missing_docs + /// An icon which has a different string for Linux and macOS. + case platformDependent(linux: String, mac: String) + /// An icon which has the same string for Linux and macOS. + case platformIndependent(name: String) + + /// A string representing an icon. + var iconName: String { + #if os(macOS) + switch self { + case .plus: + return "plus" + case .menu: + return "menucard" + case .avatar: + return "person.fill" + case .warning: + return "exclamationmark.triangle.fill" + case .find: + return "magnifyingglass" + case .sidebar: + return "sidebar.left" + case .reload: + return "arrow.clockwise" + case .number: + return "number" + case let .platformDependent(linux: _, mac: mac): + return mac + case let .platformIndependent(name: name): + return name + } + #else + switch self { + case .plus: + return "list-add-symbolic" + case .menu: + return "open-menu-symbolic" + case .avatar: + return "avatar-default-symbolic" + case .warning: + return "dialog-warning-symbolic" + case .find: + return "edit-find-symbolic" + case .sidebar: + return "sidebar-show-symbolic" + case .reload: + return "view-refresh-symbolic" + case .number: + return "lang-include-symbolic" + case let .platformDependent(linux: linux, mac: _): + return linux + case let .platformIndependent(name: name): + return name + } + #endif + } + +} diff --git a/Sources/Dvandva/Swift/KeyboardShortcut.swift b/Sources/Dvandva/Swift/KeyboardShortcut.swift new file mode 100644 index 0000000..643d96a --- /dev/null +++ b/Sources/Dvandva/Swift/KeyboardShortcut.swift @@ -0,0 +1,172 @@ +// +// KeyboardShortcut.swift +// Dvandva +// +// Created by david-swift on 16.11.2023. +// + +#if os(macOS) +import AppKit +#endif + +/// A keyboard shortcut used e.g. in menus. +public struct KeyboardShortcut { + + /// A shortcut often use for "Delete" actions which is the "Delete" key on Linux and ⌘⌫ on macOS. + public static var deleteShortcut: Self { + #if os(macOS) + .init(symbol: .backspace) + #else + .init(symbol: .delete, ctrl: false) + #endif + } + + /// The character or a sequence representing a letter or symbol. + public var character: ShortcutCharacter + /// Whether the Ctrl key is part of the shortcut. + public var ctrl: Bool + /// Whether the Shift key is part of the shortcut. + public var shift: Bool + /// Whether the Alt key is part of the shortcut. + public var alt: Bool + + #if os(macOS) + /// The modifiers for the macOS shortcut. + var macModifiers: NSEvent.ModifierFlags { + var flags: NSEvent.ModifierFlags = [] + if ctrl { + flags.insert(.command) + } + if shift { + flags.insert(.shift) + } + if alt { + flags.insert(.option) + } + return flags + } + #endif + + /// The shortcut in a representation for Linux. + var linuxShortcut: String { + var string = "" + if ctrl { + string += "" + } + if shift { + string += "" + } + if alt { + string += "" + } + string += character.linuxRepresentation + return string + } + + /// Initialize a keyboard shortcut. + /// - Parameters: + /// - character: A letter. + /// - ctrl: Whether Ctrl is part of the shortcut. + /// - shift: Whether Shift is part of the shortcut. + /// - alt: Whether Alt is part of the shortcut. + public init(_ character: Character, ctrl: Bool = true, shift: Bool = false, alt: Bool = false) { + self.character = .character(character) + self.ctrl = ctrl + self.shift = shift + self.alt = alt + } + + /// Initialize a keyboard shortcut. + /// - Parameters: + /// - symbol: A character. + /// - ctrl: Whether Ctrl is part of the shortcut. + /// - shift: Whether Shift is part of the shortcut. + /// - alt: Whether Alt is part of the shortcut. + public init(symbol: ShortcutCharacter, ctrl: Bool = true, shift: Bool = false, alt: Bool = false) { + self.character = symbol + self.ctrl = ctrl + self.shift = shift + self.alt = alt + } + + /// The special characters available for shortcuts. + public enum ShortcutCharacter { + + /// The ⌫ character. + case backspace + /// The ⌦ character. + case delete + /// The ⇥ character. + case tab + /// The ⏎ character. + case enter + /// The ⎋ character. + case escape + /// The ␣ character. + case space + // swiftlint:disable identifier_name + /// An arrow key. + case up, down, left, right + // swiftlint:enable identifier_name + /// A custom character. + case character(_ character: Character) + + /// A representation of the keys for macOS. + var macOSRepresentation: String { + switch self { + case .backspace: + return "\u{8}" + case .delete: + return "\u{7F}" + case .tab: + return "\u{9}" + case .enter: + return "\u{A}" + case .escape: + return "\u{1B}" + case .space: + return " " + case .up: + return "↑" + case .down: + return "↓" + case .left: + return "←" + case .right: + return "→" + case let .character(character): + return "\(character)" + } + } + + /// A representation of the keys for Linux. + var linuxRepresentation: String { + switch self { + case .backspace: + return "BackSpace" + case .delete: + return "Delete" + case .tab: + return "Tab" + case .enter: + return "Return" + case .escape: + return "Escape" + case .space: + return "space" + case .up: + return "Up" + case .down: + return "Down" + case .left: + return "Left" + case .right: + return "Right" + case let .character(character): + return "\(character)" + } + } + + } + +} diff --git a/Sources/Dvandva/Widget.swift b/Sources/Dvandva/Widget.swift new file mode 100644 index 0000000..f58c418 --- /dev/null +++ b/Sources/Dvandva/Widget.swift @@ -0,0 +1,31 @@ +// +// Widget.swift +// Dvandva +// +// Created by david-swift on 03.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A widget is a view in a window. +public class Widget { + +#if os(macOS) + /// The widget as an `NSView`. + public var widget: NSView = .init() { + didSet { + widget.translatesAutoresizingMaskIntoConstraints = false + } + } +#else + // swiftlint:disable implicitly_unwrapped_optional + /// The widget as a `GTUI.NativeWidgetPeer`. + public var widget: NativeWidgetPeer! + // swiftlint:enable implicitly_unwrapped_optional +#endif + +} diff --git a/Sources/Dvandva/Widgets/Box.swift b/Sources/Dvandva/Widgets/Box.swift new file mode 100644 index 0000000..51a80df --- /dev/null +++ b/Sources/Dvandva/Widgets/Box.swift @@ -0,0 +1,93 @@ +// +// Box.swift +// Dvandva +// +// Created by david-swift on 08.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A widget containing multiple items either aligned horizontally or vertically. +public class Box: Widget { + +#if os(macOS) + /// The widget for macOS. + private var box: NSStackView? { + get { + widget as? NSStackView + } + set { + if let newValue { + widget = newValue + } + } + } +#else + /// The widget for Linux. + private var box: GTUI.Box? { + get { + widget as? GTUI.Box + } + set { + if let newValue { + widget = newValue + } + } + } +#endif + /// The widgets being arranged by the box widget. + var content: [Widget] = [] + + /// Initialize a box. + /// - Parameter horizontal: Whether the box aligns its children horizontally or vertically. + public init(horizontal: Bool = false) { + super.init() + #if os(macOS) + box = .init() + box?.orientation = horizontal ? .horizontal : .vertical + #else + box = .init(horizontal: horizontal) + #endif + } + + /// Add a widget to the trailing or bottom of the box. + /// - Parameter widget: The widget. + /// - Returns: The box. + public func append(_ widget: Widget) -> Self { + content.append(widget) + #if os(macOS) + box?.addArrangedSubview(widget.widget) + #else + _ = box?.append(widget.widget) + #endif + return self + } + + /// Add a widget to the leading or top of the box. + /// - Parameter widget: The widget. + /// - Returns: The box. + public func prepend(_ widget: Widget) -> Self { + content.insert(widget, at: 0) + #if os(macOS) + box?.insertArrangedSubview(widget.widget, at: 0) + #else + _ = box?.prepend(widget.widget) + #endif + return self + } + + /// Remove a certain widget from the view. + /// - Parameter widget: The widget. + public func removeWidget(_ widget: Widget) { + #if os(macOS) + box?.removeView(widget.widget) + #else + _ = box?.removeWidgets([widget.widget]) + #endif + } + +} diff --git a/Sources/Dvandva/Widgets/Button.swift b/Sources/Dvandva/Widgets/Button.swift new file mode 100644 index 0000000..9e64789 --- /dev/null +++ b/Sources/Dvandva/Widgets/Button.swift @@ -0,0 +1,170 @@ +// +// Button.swift +// Dvandva +// +// Created by david-swift on 12.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A widget executing an action when being clicked. +public class Button: Widget { + +#if os(macOS) + /// The widget for macOS. + private var button: NSButton? { + get { + widget as? NSButton + } + set { + if let newValue { + widget = newValue + } + } + } +#else + /// The widget for Linux. + private var button: GTUI.Button? { + get { + widget as? GTUI.Button + } + set { + if let newValue { + widget = newValue + } + } + } +#endif + /// The action that gets executed when the button gets pressed. + var action: () -> Void = { } + + /// Initialize a button. + /// - Parameter title: The label of the button. + /// + /// Note that after initializing a button without an icon, you cannot add an icon. + public init(_ title: String) { + super.init() + #if os(macOS) + initializeButton() + _ = setLabel(title) + #else + button = .init(title) + _ = button?.handler { self.action() } + #endif + } + + /// Initialize a button. + /// - Parameters: + /// - icon: The icon of the button. + /// - title: The label of the button, or nil. + /// + /// Note that after initializing a button with an icon, you cannot get rid of it. + public init(_ icon: Icon, title: String? = nil) { + super.init() + #if os(macOS) + initializeButton() + _ = setLabel(icon, title: title) + #else + button = .init(title, icon: .custom(name: icon.iconName)) + _ = button?.handler { self.action() } + #endif + } + + #if os(macOS) + /// Initialize the button on macOS. + func initializeButton() { + button = .init() + button?.action = #selector(buttonPressed(_:)) + button?.target = self + } + #endif + + /// Set the button's label. + /// - Parameter title: The button's label. + /// - Returns: The button. + /// + /// Note that this only has an effect when the button has been initialized without an icon. + public func setLabel(_ title: String) -> Self { + #if os(macOS) + button?.title = title + #else + button?.setLabel(title) + #endif + return self + } + + /// Set the button's label and icon. + /// - Parameters: + /// - icon: The button's icon. + /// - title: The button's label, or nil. + /// + /// Note that this only has an effect when the button has been initialized with an icon. + public func setLabel(_ icon: Icon, title: String? = nil) -> Self { + #if os(macOS) + button?.title = title ?? "" + button?.image = .init(systemSymbolName: icon.iconName, accessibilityDescription: nil) + button?.imagePosition = .imageLeading + #else + let content = button?.getContent() + if let title { + content?.setLabel(title) + } + content?.setIcon(.custom(name: icon.iconName)) + #endif + return self + } + + /// Set the button's style. + /// - Parameter style: The button's style. + /// - Returns: The button. + public func buttonStyle(_ style: ButtonStyle) -> Self { + if let button { + #if os(macOS) + style.buttonStyle(button) + #else + _ = button.addStyle(style.styleName) + #endif + } + return self + } + + /// Set the action that gets called when the button gets pressed. + /// - Parameter action: The action. + /// - Returns: The button. + public func setAction(_ action: @escaping () -> Void) -> Self { + self.action = action + return self + } + + /// Disable a button so that it cannot be clicked. + /// - Parameter disabled: Whether the button is disabled. + /// - Returns: The button. + public func disabled(_ disabled: Bool = true) -> Self { + #if os(macOS) + if disabled { + button?.isEnabled = false + } else { + button?.isEnabled = true + } + #else + _ = button?.sensitive(!disabled) + #endif + return self + } + + #if os(macOS) + /// This function gets called when a button is pressed under macOS. + /// - Parameter sender: The sender or nil. + @objc + func buttonPressed(_ sender: Any?) { + Task { @MainActor in + action() + } + } + #endif + +} diff --git a/Sources/Dvandva/Widgets/Label.swift b/Sources/Dvandva/Widgets/Label.swift new file mode 100644 index 0000000..0f07a05 --- /dev/null +++ b/Sources/Dvandva/Widgets/Label.swift @@ -0,0 +1,82 @@ +// +// Label.swift +// Dvandva +// +// Created by david-swift on 03.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A widget showing a piece of text. +public class Label: Widget { + +#if os(macOS) + /// The widget for macOS. + private var label: NSTextField? { + get { + widget as? NSTextField + } + set { + if let newValue { + widget = newValue + } + } + } + /// The content in macOS. + var content: [(NSMenuItem, Menu?)] = [] +#else + /// The widget for Linux. + private var label: GTUI.Label? { + get { + widget as? GTUI.Label + } + set { + if let newValue { + widget = newValue + } + } + } +#endif + + /// Initialize a label. + override public init() { + super.init() + #if os(macOS) + label = .init() + label?.isEditable = false + label?.isBezeled = false + label?.drawsBackground = false + #else + label = .init("") + #endif + } + + /// Set the label's text. + /// - Parameter text: The new text. + /// - Returns: The label. + public func setText(_ text: String) -> Self { + #if os(macOS) + label?.stringValue = text + #else + label?.setText(text) + #endif + return self + } + + /// Set the label's font. + /// - Parameter font: The label's font. + /// - Returns: The label. + public func setFont(_ font: Font) -> Self { + #if os(macOS) + label?.font = font.nsFont + #else + _ = label?.addStyle(font.styleName) + #endif + return self + } + +} diff --git a/Sources/Dvandva/Widgets/List.swift b/Sources/Dvandva/Widgets/List.swift new file mode 100644 index 0000000..a11bb71 --- /dev/null +++ b/Sources/Dvandva/Widgets/List.swift @@ -0,0 +1,259 @@ +// +// List.swift +// Dvandva +// +// Created by david-swift on 18.11.2023. +// + +#if os(macOS) +import AppKit +import SwiftUI +#else +import GTUI +#endif + +/// A widget containing multiple items arranged in a list. +public class List: Widget { + + #if os(macOS) + /// The list controller. + private let controller = ViewController() + #else + /// The widget for Linux. + private var list: ListBox? { + get { + widget as? ListBox + } + set { + if let newValue { + widget = newValue + } + } + } + #endif + + /// Initialize a list. + override public init() { + super.init() + #if os(macOS) + widget = controller.outlineView + controller.setup() + #else + list = .init() + #endif + } + + #if os(macOS) + /// A list view controller. + class ViewController: NSObject, NSOutlineViewDelegate, NSOutlineViewDataSource { + + /// The list. + let outlineView: NSOutlineView = .init() + /// The widgets in the list. + var items: [Widget] = [] { + didSet { + outlineView.reloadData() + } + } + /// The functions observing changes in the selection. + var selectionObservers: [(Int) -> Void] = [] + + /// Execute when the view is set up. + func setup() { + outlineView.delegate = self + outlineView.dataSource = self + + let col1 = NSTableColumn(identifier: NSUserInterfaceItemIdentifier("Column1")) + col1.title = "List" + outlineView.headerView = nil + outlineView.addTableColumn(col1) + outlineView.translatesAutoresizingMaskIntoConstraints = false + + // Add notification observer for selection changes + NotificationCenter.default.addObserver( + self, + selector: #selector(selectionDidChange), + name: NSOutlineView.selectionDidChangeNotification, + object: outlineView + ) + } + + /// Get the number of widgets in a list. + /// - Parameters: + /// - outlineView: The list. + /// - item: Number of children. + /// - Returns: Returns the number of widgets. + func outlineView(_ outlineView: NSOutlineView, numberOfChildrenOfItem item: Any?) -> Int { + items.count + } + + /// Get the information that a list is not expandable. + /// - Parameters: + /// - outlineView: The list. + /// - item: Is expandable. + /// - Returns: Returns always false. + func outlineView(_ outlineView: NSOutlineView, isItemExpandable item: Any) -> Bool { + false + } + + /// Get the item at a certain index. + /// - Parameters: + /// - outlineView: The list. + /// - index: The index. + /// - item: Get an item. + /// - Returns: The item. + func outlineView(_ outlineView: NSOutlineView, child index: Int, ofItem item: Any?) -> Any { + items[index] + } + + /// Get the view for a certain widget. + /// - Parameters: + /// - outlineView: The list. + /// - tableColumn: The list column. + /// - item: The widget. + /// - Returns: The widget's view. + func outlineView(_ outlineView: NSOutlineView, viewFor tableColumn: NSTableColumn?, item: Any) -> NSView? { + (item as? Widget)?.widget ?? .init() + } + + /// Get the height a widget needs. + /// - Parameters: + /// - outlineView: The list. + /// - item: The widget. + /// - Returns: The widget's height. + func outlineView(_ outlineView: NSOutlineView, heightOfRowByItem item: Any) -> CGFloat { + if let widget = item as? Widget { + return widget.widget.fittingSize.height + } + return .zero + } + + /// Handle selection changes. + @objc + func selectionDidChange() { + if let selectedIndex = outlineView.selectedRowIndexes.first { + for selectionObserver in selectionObservers { + selectionObserver(selectedIndex) + } + } + } + + /// Set the selection manually to a specific index. + /// - Parameter index: The index. + func setSelectedIndex(_ index: Int) { + outlineView.selectRowIndexes(IndexSet(integer: index), byExtendingSelection: false) + } + + /// Remove an item at a certain index. + /// - Parameter index: The index. + func removeAtIndex(_ index: Int) { + outlineView.removeItems(at: [index], inParent: nil) + items.remove(at: index) + } + } + #endif + + /// Add a widget to the bottom of the list. + /// - Parameter widget: The widget. + /// - Returns: The list. + public func append(_ widget: Widget) -> Self { + #if os(macOS) + controller.items.append(widget) + #else + _ = list?.append(widget.widget) + #endif + return self + } + + /// Add a standard widget to the bottom of the list. + /// - Parameters: + /// - label: The widget's label. + /// - icon: The widget's icon. + /// - Returns: The list. + /// + /// A standard widget is a widget consisting of a label, and, on macOS, optionally an icon. + public func append(label: String, icon: Icon?) -> Self { + append(self.label(label, icon: icon)) + } + + /// Add a widget to the top of the list. + /// - Parameter widget: The widget. + /// - Returns: The list. + public func prepend(_ widget: Widget) -> Self { + #if os(macOS) + controller.items.insert(widget, at: 0) + #else + _ = list?.prepend(widget.widget) + #endif + return self + } + + /// Add a standard widget to the top of the list. + /// - Parameters: + /// - label: The widget's label. + /// - icon: The widget's icon. + /// - Returns: The list. + /// + /// A standard widget is a widget consisting of a label, and, on macOS, optionally an icon. + public func prepend(label: String, icon: Icon?) -> Self { + prepend(self.label(label, icon: icon)) + } + + /// Remove the widget at a certain index. + /// - Parameter index: The index. + /// - Returns: The list. + public func remove(at index: Int) -> Self { + #if os(macOS) + controller.removeAtIndex(index) + #else + _ = list?.remove(at: index) + #endif + return self + } + + /// Select the widget at a certain index. + /// - Parameter index: The index. + public func select(index: Int) { + #if os(macOS) + controller.setSelectedIndex(index) + #else + list?.selectRow(at: index) + #endif + } + + /// Add a closure that gets called when the selection changes. + /// - Parameter observer: The function taking the selection index as a parameter. + public func observeSelection(observer: @escaping (Int) -> Void) { + #if os(macOS) + controller.selectionObservers.append(observer) + #else + _ = list?.handler { + if let index = self.list?.getSelectedRow() { + observer(index) + } + } + #endif + } + + /// Get a standard widget consisting of a label and optionally an icon. + /// - Parameters: + /// - label: The label. + /// - icon: The icon. + /// - Returns: The widget. + func label(_ label: String, icon: Icon?) -> Widget { + let box = Box(horizontal: true) + #if os(macOS) + if let icon { + let symbol = NSImageView( + image: .init(systemSymbolName: icon.iconName, accessibilityDescription: nil) ?? .init() + ) + symbol.contentTintColor = .controlAccentColor + _ = box.append(NativeWrapper(symbol)) + } + #endif + let padding = 6 + return PaddingWrapper(box.append(Label().setText(label))) + .setPadding(padding) + } + +} diff --git a/Sources/Dvandva/Widgets/MenuButton.swift b/Sources/Dvandva/Widgets/MenuButton.swift new file mode 100644 index 0000000..d1f94bc --- /dev/null +++ b/Sources/Dvandva/Widgets/MenuButton.swift @@ -0,0 +1,147 @@ +// +// MenuButton.swift +// Dvandva +// +// Created by david-swift on 16.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A button that opens a menu when being pressed. +public class MenuButton: Widget { + +#if os(macOS) + /// The widget for macOS. + let button: Button +#else + /// The widget for Linux. + private var button: GTUI.MenuButton? { + get { + widget as? GTUI.MenuButton + } + set { + if let newValue { + widget = newValue + } + } + } +#endif + /// The content. + let menu: Menu = .init() + + /// Initialize a menu button. + /// - Parameter title: The label of the button. + /// + /// Note that after initializing a button without an icon, you cannot add an icon. + public init(_ title: String) { + #if os(macOS) + button = .init(title) + #endif + super.init() + #if os(macOS) + initButton() + #else + button = .init(title) + #endif + } + + /// Initialize a menu button. + /// - Parameters: + /// - icon: The icon of the button. + /// - title: The label of the button, or nil. + /// + /// Note that after initializing a button with an icon, you cannot get rid of it. + public init(_ icon: Icon, title: String? = nil) { + #if os(macOS) + button = .init(icon, title: title) + #endif + super.init() + #if os(macOS) + initButton() + #else + button = .init(title, icon: .custom(name: icon.iconName)) + #endif + } + + /// Initialize the button. + func initButton() { + #if os(macOS) + widget = button.widget + _ = button.setAction { + self.menu + .getMenu() + .popUp( + positioning: nil, + at: .init( + x: self.button.widget.frame.origin.x, + y: self.button.widget.frame.origin.y + self.button.widget.frame.size.height + ), + in: self.button.widget + ) + } + #else + _ = button?.menu(menu.getMenu()) + #endif + } + + /// Set the menu button's label. + /// - Parameter title: The button's label. + /// - Returns: The button. + /// + /// Note that this only has an effect when the button has been initialized without an icon. + public func setLabel(_ title: String) -> Self { + #if os(macOS) + _ = button.setLabel(title) + #else + button?.setLabel(title) + #endif + return self + } + + /// Set the menu button's label and icon. + /// - Parameters: + /// - icon: The button's icon. + /// - title: The button's label, or nil. + /// + /// Note that this only has an effect when the button has been initialized with an icon. + public func setLabel(_ icon: Icon, title: String? = nil) -> Self { + #if os(macOS) + _ = button.setLabel(icon, title: title) + #else + let content = button?.getContent() + if let title { + content?.setLabel(title) + } + content?.setIcon(.custom(name: icon.iconName)) + #endif + return self + } + + /// Set the button's style. + /// - Parameter style: The button's style. + /// - Returns: The button. + public func buttonStyle(_ style: ButtonStyle) -> Self { + #if os(macOS) + _ = button.buttonStyle(style) + #else + _ = button?.addStyle(style.styleName) + #endif + return self + } + + /// Edit the menu of the menu button. + /// - Parameter menu: The closure for editing the menu. + /// - Returns: The menu button. + public func editMenu(_ menu: (Menu) -> Void) -> Self { + menu(self.menu) + #if !os(macOS) + _ = button?.menu(self.menu.getMenu()) + #endif + return self + } + +} diff --git a/Sources/Dvandva/Widgets/NativeWrapper.swift b/Sources/Dvandva/Widgets/NativeWrapper.swift new file mode 100644 index 0000000..9c83251 --- /dev/null +++ b/Sources/Dvandva/Widgets/NativeWrapper.swift @@ -0,0 +1,39 @@ +// +// NativeWrapper.swift +// Dvandva +// +// Created by david-swift on 08.11.2023. +// + +import Foundation + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A wrapper around native widgets. +/// +/// On macOS, it accepts an NSView, +/// and on Linux, you can use SwiftGui +/// (https://github.com/david-swift/SwiftGui). +public class NativeWrapper: Widget { + +#if os(macOS) + /// Initialize a native wrapper for macOS. + /// - Parameter nativeView: The NSView. + public init(_ nativeView: NSView) { + super.init() + widget = nativeView + } +#else + /// Initialize a native wrapper for Linux. + /// - Parameter nativeView: The class conforming to `GTUI.NativeWidgetPeer`. + public init(_ nativeView: NativeWidgetPeer) { + super.init() + widget = nativeView + } +#endif + +} diff --git a/Sources/Dvandva/Widgets/PaddingWrapper.swift b/Sources/Dvandva/Widgets/PaddingWrapper.swift new file mode 100644 index 0000000..16e686c --- /dev/null +++ b/Sources/Dvandva/Widgets/PaddingWrapper.swift @@ -0,0 +1,71 @@ +// +// PaddingWrapper.swift +// Dvandva +// +// Created by david-swift on 09.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A wrapper around a widget adding padding. +public class PaddingWrapper: Widget { + +#if os(macOS) + /// The content widget. + private var content: Widget +#endif + + /// Initialize a padding wrapper around a widget. + /// - Parameter content: The widget. + public init(_ content: Widget) { + #if os(macOS) + self.content = content + content.widget.wantsLayer = true + content.widget.translatesAutoresizingMaskIntoConstraints = false + #endif + super.init() + #if os(macOS) + widget = .init() + widget.addSubview(content.widget) + #else + widget = content.widget + #endif + _ = setPadding(0) + } + + /// Customize the padding's size and the affected edges. + /// - Parameters: + /// - padding: The padding's size. + /// - edges: The edges being affected by the padding wrapper. + public func setPadding(_ padding: Int, edges: Set = .all) -> Self { + #if os(macOS) + NSLayoutConstraint.deactivate(content.widget.constraints) + NSLayoutConstraint.deactivate(widget.constraints) + let padding = CGFloat(padding) + let leading = content.widget.leadingAnchor.constraint(equalTo: widget.leadingAnchor, constant: padding) + let trailing = content.widget.trailingAnchor.constraint(equalTo: widget.trailingAnchor, constant: -padding) + let top = content.widget.topAnchor.constraint(equalTo: widget.topAnchor, constant: padding) + let bottom = content.widget.bottomAnchor.constraint(equalTo: widget.bottomAnchor, constant: -padding) + NSLayoutConstraint.activate(edges.map { edge in + switch edge { + case .top: + return top + case .leading: + return leading + case .bottom: + return bottom + case .trailing: + return trailing + } + }) + #else + _ = widget.padding(padding, .init(edges.map { $0.gtuiEdge })) + #endif + return self + } + +} diff --git a/Sources/Dvandva/Widgets/ScrollView.swift b/Sources/Dvandva/Widgets/ScrollView.swift new file mode 100644 index 0000000..bc52f46 --- /dev/null +++ b/Sources/Dvandva/Widgets/ScrollView.swift @@ -0,0 +1,69 @@ +// +// ScrollView.swift +// Dvandva +// +// Created by david-swift on 19.11.2023. +// + +import Foundation + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +/// A scrollable widget containing a child widget. +public class ScrollView: Widget { + + #if os(macOS) + /// The widget for macOS. + private var view: NSScrollView? { + get { + widget as? NSScrollView + } + set { + if let newValue { + widget = newValue + } + } + } + /// The child widget. + var child: Widget? + #else + /// The scroll view. + private var view: Scrolled? { + get { + widget as? Scrolled + } + set { + if let newValue { + widget = newValue + } + } + } + #endif + + /// Initialize the scrollable widget. + override public init() { + super.init() + view = .init() + #if os(macOS) + view?.drawsBackground = false + #endif + } + + /// Set the `ScrollView`'s child. + /// - Parameter widget: The child. + /// - Returns: The scrollable widget. + public func setChild(_ widget: Widget) -> Self { + #if os(macOS) + child = widget + view?.documentView = widget.widget + #else + _ = view?.setChild(widget.widget) + #endif + return self + } + +} diff --git a/Sources/Dvandva/Window.swift b/Sources/Dvandva/Window.swift new file mode 100644 index 0000000..bf82c91 --- /dev/null +++ b/Sources/Dvandva/Window.swift @@ -0,0 +1,388 @@ +// +// Window.swift +// Dvandva +// +// Created by david-swift on 02.11.2023. +// + +#if os(macOS) +import AppKit +#else +import GTUI +#endif + +// swiftlint:disable no_grouping_extension + +#if os(macOS) + +/// A window is a container for widgets. +public class Window: NSObject, NSWindowDelegate { + + /// The window for macOS. + let window: NSWindow = .init() + /// The parent app for macOS. + private let app: Application + /// The window's toolbar for macOS. + private let toolbar: NSToolbar + /// The window's title. + var title: String + /// The widgets in the toolbar. + var toolbarItemWidgets: [(String, (Widget, Bool))] = [] + /// Whether the window has a blurry background. + var blurryBackground = false + /// The window's content. + var content: Box = .init() + /// A view containing the window's content for macOS. + let contentView: NSView = .init() + /// The navigation split view for macOS. + var splitView: NavigationSplitViewController? + /// Whether the window's size has been set manually. + var sizeSet = false + /// A storage for custom data associated with the window. + public var data: [String: Any] = [:] + + /// The toolbar items as `NSToolbarItem` for macOS. + var toolbarItems: [NSToolbarItem] { + toolbarItemWidgets.map { label, info in + let toolbarItem = NSToolbarItem(itemIdentifier: .init(label)) + toolbarItem.isBordered = true + toolbarItem.view = info.0.widget + toolbarItem.isNavigational = info.1 + toolbarItem.label = label + return toolbarItem + } + } + + // swiftlint:disable function_default_parameter_at_end + /// Initialize a window. + /// - Parameters: + /// - title: The window's title. + /// - id: The window's identifier. + /// - app: The app. + public init(_ title: String? = nil, id: String, app: Application) { + self.app = app + let title = title ?? app.appName + self.title = title + self.toolbar = .init(identifier: id) + super.init() + app.windows.append(self) + window.title = title + window.delegate = self + window.isReleasedWhenClosed = false + contentView.addSubview(content.widget) + window.contentView = contentView + contentView.center(content.widget) + makeNormalWindow() + } + // swiftlint:enable function_default_parameter_at_end + + /// A controller for a window's content with a sidebar. + class NavigationSplitViewController: NSSplitViewController { + + /// The sidebar view. + var sidebar: NSView = .init() + /// The content view. + var content: NSView = .init() + + /// Initialize a controller for a window window's content with a sidebar. + /// - Parameters: + /// - sidebar: The sidebar view. + /// - content: The content view. + init(sidebar: NSView, content: NSView) { + self.sidebar.addSubview(sidebar) + self.content.addSubview(content) + super.init(nibName: nil, bundle: nil) + sidebar.center(self.sidebar) + content.center(self.content) + self.sidebar.equalConstraints(sidebar) + self.content.equalConstraints(content) + } + + /// This initializer always fails. + /// - Parameter coder: An `NSCoder`. + required init?(coder: NSCoder) { + nil + } + + /// Execute after the view has been loaded. + override func viewDidLoad() { + super.viewDidLoad() + + let navigationViewController = NSViewController() + navigationViewController.view = sidebar + + let detailViewController = NSViewController() + detailViewController.view = content + + let splitViewItem1 = NSSplitViewItem(sidebarWithViewController: navigationViewController) + let splitViewItem2 = NSSplitViewItem(viewController: detailViewController) + + addSplitViewItem(splitViewItem1) + addSplitViewItem(splitViewItem2) + } + + } + +} + +#else + +/// A window is a container for widgets. +public class Window { + + /// The window for Linux. + let window: GTUI.ApplicationWindow + /// The window's content is an overlay split view. + let content: GTUI.OverlaySplitView = .init() + /// The "sub content" is the split view's content. + let subContent: GTUI.Box = .init(horizontal: false) + /// The window's header bar. + let headerBar: GTUI.HeaderBar = .init() + /// The parent application. + let app: Application + /// The window's title. + var title: String + /// A storage for custom data associated with the window. + public var data: [String: Any] = [:] + + // swiftlint:disable function_default_parameter_at_end + /// Initialize a window. + /// - Parameters: + /// - title: The window's title. + /// - id: The window's identifier. + /// - app: The app. + public init(_ title: String? = nil, id: String, app: Application) { + window = .init(app: app.application) + _ = content.content(ToolbarView(subContent).addTopBar(headerBar)) + content.hideSidebar() + window.setChild(content) + self.title = title ?? "" + self.app = app + app.windows.append(self) + makeNormalWindow() + _ = subContent.valign(.center) + if let title { + window.setTitle(title) + } + } + // swiftlint:enable function_default_parameter_at_end + +} + +#endif + +extension Window { + + /// Add a toolbar item to the window. + /// - Parameters: + /// - widget: The widget. + /// - label: The label for macOS. + /// - navigational: Whether it is added to the left of the toolbar. + public func addToolbarItem(_ widget: Widget, label: String, navigational: Bool = false) { + #if os(macOS) + if toolbarItemWidgets.isEmpty { + window.toolbar = toolbar + toolbar.displayMode = .iconOnly + toolbar.delegate = self + } + toolbarItemWidgets.append((label, (widget, navigational))) + toolbar.insertItem(withItemIdentifier: .init(label), at: toolbar.items.count) + #else + if navigational { + _ = headerBar.packStart(widget.widget) + } else { + _ = headerBar.packEnd(widget.widget) + } + #endif + } + + /// Add a sidebar to the window. + /// - Parameter widget: The sidebar's content. + public func setSidebar(_ widget: Widget) { + #if os(macOS) + window.styleMask.insert(.fullSizeContentView) + splitView = .init(sidebar: ScrollView().setChild(widget).widget, content: contentView) + window.contentViewController = splitView + #else + _ = content.sidebar( + ToolbarView(Scrolled().setChild(widget.widget.addStyle("navigation-sidebar"))).addTopBar(HeaderBar()) + ) + content.showSidebar() + _ = headerBar.titleWidget(GTUI.Label("")) + #endif + } + + /// Transform the window into a "simple" window that is not resizable. + /// - Parameters: + /// - title: Whether the title is visible on macOS. + /// - backgroundEffect: Whether the background is blurry on macOS. + public func makeSimpleWindow(title: Bool = true, backgroundEffect: Bool = false) { + #if os(macOS) + if title { + window.titleVisibility = .visible + } else { + window.titleVisibility = .hidden + } + window.styleMask = [.titled, .closable, .fullSizeContentView] + if backgroundEffect { + window.standardWindowButton(.miniaturizeButton)?.isHidden = true + window.standardWindowButton(.zoomButton)?.isHidden = true + window.isMovableByWindowBackground = true + } else { + makeNotBlurryWindow() + } + window.titlebarAppearsTransparent = true + blurryBackground = backgroundEffect + setContent() + #else + window.setResizability(false) + #endif + } + + /// Transform a window into a "normal", resizable window. + public func makeNormalWindow() { + #if os(macOS) + window.styleMask = [.titled, .closable, .miniaturizable, .resizable] + window.titlebarAppearsTransparent = false + window.titleVisibility = .visible + blurryBackground = false + setContent() + #else + window.setResizability(true) + #endif + makeNotBlurryWindow() + } + + /// Remove the blur effect from a window. + func makeNotBlurryWindow() { + #if os(macOS) + window.standardWindowButton(.miniaturizeButton)?.isHidden = false + window.standardWindowButton(.zoomButton)?.isHidden = false + window.isMovableByWindowBackground = false + #endif + } + + #if os(macOS) + /// Update the window's content. + func setContent() { + if let splitView { + window.contentViewController = splitView + splitView.content.subviews = [] + splitView.content.addSubview(contentView) + window.setContentSize(splitView.splitView.fittingSize) + } else { + if blurryBackground { + let blurView = NSVisualEffectView() + blurView.material = .menu + blurView.blendingMode = .behindWindow + window.contentView = blurView + window.contentView?.addSubview(content.widget) + } else { + window.contentView = contentView + } + window.setContentSize(content.widget.fittingSize) + } + window.contentView?.wantsLayer = true + window.contentView?.translatesAutoresizingMaskIntoConstraints = true + } + #endif + + /// Add a child to the window's content view. + /// - Parameter child: The child. + public func addChild(_ child: Widget) { + #if os(macOS) + _ = content.append(child) + setContent() + #else + _ = subContent.append(child.widget) + #endif + } + + /// Set the default size of the window. + /// - Parameters: + /// - width: The window's width. + /// - height: The window's height. + public func setDefaultSize(width: Int, height: Int) { + #if os(macOS) + let frame = CGRect(x: 0, y: 0, width: width, height: height) + window.setFrame(frame, display: true) + sizeSet = true + #else + window.setDefaultSize(width: width, height: height) + #endif + } + + /// Set the window's minimum size for macOS. + /// - Parameters: + /// - width: The window's minimum width. + /// - height: The window's minimum height. + /// + /// On Linux, the window can shrink to the content's size. + public func setMinimumSize(width: Int, height: Int) { + #if os(macOS) + window.minSize = .init(width: width, height: height) + #endif + } + + /// Set the main menu of the window which is visible in the toolbar in GNOME. + /// - Parameter menu: The main menu. + public func setMainMenu(_ menu: Menu) { + #if !os(macOS) + _ = headerBar + .append( + GTUI.MenuButton(icon: .default(icon: .openMenu)) + .menu( + menu.getMenu().append( + "", + section: .init() + .append("About \(app.appName)", app: app.application) { + let about = AboutWindow(parent: self.window) + _ = about.generalData( + title: self.app.appName, + icon: .custom(name: ""), + developer: self.app.developer, + version: self.app.appVersion + ) + if let help = self.app.helpURL?.absoluteString { + _ = about.support(url: help) + } + if let issue = self.app.issue?.absoluteString { + _ = about.issue(url: issue) + } + about.show() + } + .append("Quit", id: "app.quit") + ) + ) + ) + #endif + } + + /// Present the window. + public func show() { + #if os(macOS) + if !sizeSet && splitView != nil { + let defaultWidth = 500 + let defaultHeight = 350 + setDefaultSize(width: defaultWidth, height: defaultHeight) + } + window.makeKeyAndOrderFront(nil) + app.application.run() + #else + window.show() + #endif + } + + /// Close the window. + public func close() { + window.close() + #if os(macOS) + app.windows = app.windows.filter { $0.window != window } + #else + app.windows = app.windows.filter { $0.window.nativePtr != window.nativePtr } + #endif + } + +} + +// swiftlint:enable no_grouping_extension diff --git a/Tests/main.swift b/Tests/main.swift new file mode 100644 index 0000000..2fd74ac --- /dev/null +++ b/Tests/main.swift @@ -0,0 +1,124 @@ +// +// main.swift +// Dvandva +// +// Created by david-swift on 01.11.23. +// + +// swiftlint:disable no_magic_numbers missing_docs force_unwrapping + +import Dvandva +import Foundation + +let app = Application("Test", version: "test", id: "io.github.david_swift.Dice", developer: "david-swift") + +class DiceModel { + + var entries: [Int] = [] { + didSet { + _ = self.averageLabel.setLabel("\(average)") + list.select(index: 0) + } + } + var average: Float { + Float(entries.reduce(0) { $0 + $1 }) / Float(entries.count) + } + var index = 0 + let list: List = .init() + let label: Label = .init().setFont(.title1) + #if os(macOS) + let attemptLabel: MenuButton = .init("") + .buttonStyle(.pill) + .editMenu { _ = $0.addButton("Delete", app: app, id: "Delete Selection") } + #else + let attemptLabel: Label = .init().setFont(.caption) + #endif + let averageLabel: Button = .init("") + + init() { + list.observeSelection { index in + self.index = index + let attemptNumber = self.entries.count - index + _ = self.label.setText("\(self.entries[attemptNumber - 1])") + let text = "Attempt #\(attemptNumber)" + #if os(macOS) + _ = self.attemptLabel.setLabel(text) + #else + _ = self.attemptLabel.setText(text) + #endif + } + rollDice() + } + + func rollDice() { + let random = Int.random(in: 1...6) + _ = list.prepend(label: "\(random)", icon: .number) + entries.append(random) + } + + func deleteSelection() { + if !entries.isEmpty { + _ = list.remove(at: index) + entries.remove(at: entries.count - index - 1) + } + } + +} + +func generateWindow() { + let model = DiceModel() + + let newWindow = Window(id: UUID().uuidString, app: app) + newWindow.setSidebar(model.list) + newWindow.addChild(Box().append(model.label).append(model.attemptLabel)) + newWindow.data["model"] = model + + newWindow.setMainMenu( + .init() + .addButton("New Window", app: app, id: "New Window") + .addButton("Close Window", app: app, id: "Close Window") + .addSection( + .init() + .addButton("Roll the Dice", app: app, id: "Roll the Dice") + .addButton("Delete Selection", app: app, id: "Delete Selection") + ) + ) + newWindow.addToolbarItem(model.averageLabel, label: "Average", navigational: true) + newWindow.addToolbarItem(Button(.reload).setAction { model.rollDice() }, label: "Roll the Dice") + + newWindow.setDefaultSize(width: 500, height: 350) + newWindow.setMinimumSize(width: 380, height: 250) + newWindow.show() +} + +app.run { + app.addMenu( + "File", + menu: .init() + .addButton("New Window", app: app, shortcut: .init("n", shift: true)) { + generateWindow() + } + .addButton("Close Window", app: app, shortcut: .init("w")) { + app.keyWindow?.close() + } + ) + app.addMenu( + "Dice", + menu: .init() + .addButton("Roll the Dice", app: app, shortcut: .init("n")) { + if let model = app.keyWindow?.data["model"] as? DiceModel { + model.rollDice() + } + } + .addButton("Delete Selection", app: app, shortcut: .deleteShortcut) { + if let model = app.keyWindow?.data["model"] as? DiceModel { + model.deleteSelection() + } + } + ) + app.setHelp(url: .init(string: "https://github.com/david-swift/Dvandva/")!) + app.setIssue(url: .init(string: "https://github.com/david-swift/Dvandva/issues/")!) + generateWindow() +} + +// swiftlint:enable no_magic_numbers missing_docs force_unwrapping