CINXE.COM
API references — GNUstep
<!DOCTYPE html> <html lang="en" data-content_root="../" > <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>API references — GNUstep</title> <script data-cfasync="false"> document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; document.documentElement.dataset.theme = localStorage.getItem("theme") || ""; </script> <!-- this give us a css class that will be invisible only if js is disabled --> <noscript> <style> .pst-js-only { display: none !important; } </style> </noscript> <!-- Loaded before other Sphinx assets --> <link href="../_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" /> <link href="../_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" /> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" /> <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.1/css/all.min.css" /> <!-- So that users can add custom icons --> <script src="../_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" /> <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" /> <script src="../_static/documentation_options.js?v=f2a433a1"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/clipboard.min.js?v=a7894cd8"></script> <script src="../_static/copybutton.js?v=f281be69"></script> <script src="../_static/design-tabs.js?v=f930bc37"></script> <script>DOCUMENTATION_OPTIONS.pagename = 'APIRefs/index';</script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="GNUstep Base" href="Base/index.html" /> <link rel="prev" title="Manuals" href="../Manuals/index.html" /> <meta name="viewport" content="width=device-width, initial-scale=1"/> <meta name="docsearch:language" content="en"/> <meta name="docsearch:version" content="" /> </head> <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div> <div id="pst-scroll-pixel-helper"></div> <button type="button" class="btn rounded-pill" id="pst-back-to-top"> <i class="fa-solid fa-arrow-up"></i>Back to top</button> <dialog id="pst-search-dialog"> <form class="bd-search d-flex align-items-center" action="../search.html" method="get"> <i class="fa-solid fa-magnifying-glass"></i> <input type="search" class="form-control" name="q" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> </form> </dialog> <div class="pst-async-banner-revealer d-none"> <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside> </div> <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none"> <div class="bd-header__inner bd-page-width"> <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation"> <span class="fa-solid fa-bars"></span> </button> <div class="col-lg-3 navbar-header-items__start"> <div class="navbar-item"> <a class="navbar-brand logo" href="../index.html"> <p class="title logo__title">GNUstep</p> </a></div> </div> <div class="col-lg-9 navbar-header-items"> <div class="me-auto navbar-header-items__center"> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item "> <a class="nav-link nav-internal" href="../Guides/index.html"> Guides </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="../Manuals/index.html"> Manuals </a> </li> <li class="nav-item current active"> <a class="nav-link nav-internal" href="#"> API references </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="../About/index.html"> About </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="../Showcase/index.html"> Showcase </a> </li> </ul> </nav></div> </div> <div class="navbar-header-items__end"> <div class="navbar-item navbar-persistent--container"> <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> </div> <div class="navbar-item"> <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></div> </div> </div> <div class="navbar-persistent--mobile"> <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> </div> <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page"> <span class="fa-solid fa-outdent"></span> </button> </div> </header> <div class="bd-container"> <div class="bd-container__inner bd-page-width"> <dialog id="pst-primary-sidebar-modal"></dialog> <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar"> <div class="sidebar-header-items sidebar-primary__section"> <div class="sidebar-header-items__center"> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item "> <a class="nav-link nav-internal" href="../Guides/index.html"> Guides </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="../Manuals/index.html"> Manuals </a> </li> <li class="nav-item current active"> <a class="nav-link nav-internal" href="#"> API references </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="../About/index.html"> About </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="../Showcase/index.html"> Showcase </a> </li> </ul> </nav></div> </div> <div class="sidebar-header-items__end"> <div class="navbar-item"> <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></div> </div> </div> <div class="sidebar-primary-items__start sidebar-primary__section"> <div class="sidebar-primary-item"> <nav class="bd-docs-nav bd-links" aria-label="Section Navigation"> <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> <div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav"> <li class="toctree-l1"><a class="reference internal" href="Base/index.html">GNUstep Base</a></li> <li class="toctree-l1"><a class="reference internal" href="Gui/index.html">GNUstep Gui</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="Make/index.html">GNUstep Make</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> <li class="toctree-l2"><a class="reference internal" href="Make/Introduction.html">Introduction</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="Make/Topics/index.html">Topics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> <li class="toctree-l3"><a class="reference internal" href="Make/Topics/Subproject.html">Subprojects</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/Topics/MultipleTypes.html">Building more than one thing in the same GNUmakefile</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/Topics/Aggregate.html">Aggregate projects</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/Topics/ParallelBuilding.html">Parallel Building</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/Topics/LibraryIntroduction.html">Introduction to Libraries</a></li> </ul> </details></li> <li class="toctree-l2 has-children"><a class="reference internal" href="Make/ProjectTypes/index.html">Project Types</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> <li class="toctree-l3"><a class="reference internal" href="Make/ProjectTypes/Project.html">Project reference</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/ProjectTypes/ResourceSet.html">Resource Set reference</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/ProjectTypes/Tool.html">Tool reference</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/ProjectTypes/Application.html">Application reference</a></li> <li class="toctree-l3"><a class="reference internal" href="Make/ProjectTypes/Library.html">Library reference</a></li> </ul> </details></li> <li class="toctree-l2 has-children"><a class="reference internal" href="Make/OtherVariables/index.html">Other Variables</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul> <li class="toctree-l3"><a class="reference internal" href="Make/OtherVariables/Flags.html">Overridable Flags</a></li> </ul> </details></li> <li class="toctree-l2"><a class="reference internal" href="Make/ReleaseNotes.html">Release Notes</a></li> </ul> </details></li> </ul> </div> </nav></div> </div> <div class="sidebar-primary-items__end sidebar-primary__section"> </div> <div id="rtd-footer-container"></div> </div> <main id="main-content" class="bd-main" role="main"> <div class="bd-content"> <div class="bd-article-container"> <div class="bd-header-article d-print-none"> <div class="header-article-items header-article__inner"> <div class="header-article-items__start"> <div class="header-article-item"> <nav aria-label="Breadcrumb" class="d-print-none"> <ul class="bd-breadcrumbs"> <li class="breadcrumb-item breadcrumb-home"> <a href="../index.html" class="nav-link" aria-label="Home"> <i class="fa-solid fa-home"></i> </a> </li> <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">API references</span></li> </ul> </nav> </div> </div> </div> </div> <div id="searchbox"></div> <article class="bd-article"> <section id="api-references"> <h1>API references<a class="headerlink" href="#api-references" title="Link to this heading">#</a></h1> <div class="toctree-wrapper compound"> </div> <section id="core-gnustep-frameworks"> <h2>Core GNUstep frameworks<a class="headerlink" href="#core-gnustep-frameworks" title="Link to this heading">#</a></h2> <div class="sd-container-fluid sd-sphinx-override sd-mt-4 sd-mb-4 sd-ml-0 sd-mr-0 docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-3 sd-g-1 sd-g-xs-1 sd-g-sm-1 sd-g-md-1 sd-g-lg-1 docutils"> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> <svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-package" viewBox="0 0 16 16" aria-hidden="true"><path d="m8.878.392 5.25 3.045c.54.314.872.89.872 1.514v6.098a1.75 1.75 0 0 1-.872 1.514l-5.25 3.045a1.75 1.75 0 0 1-1.756 0l-5.25-3.045A1.75 1.75 0 0 1 1 11.049V4.951c0-.624.332-1.201.872-1.514L7.122.392a1.75 1.75 0 0 1 1.756 0ZM7.875 1.69l-4.63 2.685L8 7.133l4.755-2.758-4.63-2.685a.248.248 0 0 0-.25 0ZM2.5 5.677v5.372c0 .09.047.171.125.216l4.625 2.683V8.432Zm6.25 8.271 4.625-2.683a.25.25 0 0 0 .125-.216V5.677L8.75 8.432Z"></path></svg> Base</div> <p class="sd-card-text">The Objective-C standard library.</p> <p class="sd-card-text"><small><code class="docutils literal notranslate"><span class="pre"><Foundation/Foundation.h></span></code>, <code class="docutils literal notranslate"><span class="pre"><GNUstepBase/*.h></span></code></small></p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="Base/index.html"><span class="doc">GNUstep Base</span></a></div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> <svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-project" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.75 0h12.5C15.216 0 16 .784 16 1.75v12.5A1.75 1.75 0 0 1 14.25 16H1.75A1.75 1.75 0 0 1 0 14.25V1.75C0 .784.784 0 1.75 0ZM1.5 1.75v12.5c0 .138.112.25.25.25h12.5a.25.25 0 0 0 .25-.25V1.75a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25ZM11.75 3a.75.75 0 0 1 .75.75v7.5a.75.75 0 0 1-1.5 0v-7.5a.75.75 0 0 1 .75-.75Zm-8.25.75a.75.75 0 0 1 1.5 0v5.5a.75.75 0 0 1-1.5 0ZM8 3a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 3Z"></path></svg> GUI</div> <p class="sd-card-text">A powerful, flexible, cross-platform desktop GUI toolkit.</p> <p class="sd-card-text"><small><code class="docutils literal notranslate"><span class="pre"><AppKit/AppKit.h></span></code>, <code class="docutils literal notranslate"><span class="pre"><GNUstepGUI/*.h></span></code></small></p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="Gui/index.html"><span class="doc">GNUstep Gui</span></a></div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> <svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-tools" viewBox="0 0 16 16" aria-hidden="true"><path d="M5.433 2.304A4.492 4.492 0 0 0 3.5 6c0 1.598.832 3.002 2.09 3.802.518.328.929.923.902 1.64v.008l-.164 3.337a.75.75 0 1 1-1.498-.073l.163-3.33c.002-.085-.05-.216-.207-.316A5.996 5.996 0 0 1 2 6a5.993 5.993 0 0 1 2.567-4.92 1.482 1.482 0 0 1 1.673-.04c.462.296.76.827.76 1.423v2.82c0 .082.041.16.11.206l.75.51a.25.25 0 0 0 .28 0l.75-.51A.249.249 0 0 0 9 5.282V2.463c0-.596.298-1.127.76-1.423a1.482 1.482 0 0 1 1.673.04A5.993 5.993 0 0 1 14 6a5.996 5.996 0 0 1-2.786 5.068c-.157.1-.209.23-.207.315l.163 3.33a.752.752 0 0 1-1.094.714.75.75 0 0 1-.404-.64l-.164-3.345c-.027-.717.384-1.312.902-1.64A4.495 4.495 0 0 0 12.5 6a4.492 4.492 0 0 0-1.933-3.696c-.024.017-.067.067-.067.16v2.818a1.75 1.75 0 0 1-.767 1.448l-.75.51a1.75 1.75 0 0 1-1.966 0l-.75-.51A1.75 1.75 0 0 1 5.5 5.282V2.463c0-.092-.043-.142-.067-.159Z"></path></svg> Make</div> <p class="sd-card-text">An easy-to-use build system based on GNU Make.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="Make/index.html"><span class="doc">GNUstep Make</span></a></div> </div> </div> </div> </section> <section id="other-gnustep-and-gap-frameworks"> <h2>Other GNUstep and GAP frameworks<a class="headerlink" href="#other-gnustep-and-gap-frameworks" title="Link to this heading">#</a></h2> </section> <section id="third-party-frameworks"> <h2>Third-party frameworks<a class="headerlink" href="#third-party-frameworks" title="Link to this heading">#</a></h2> <section id="etoile"> <h3>脡toil茅<a class="headerlink" href="#etoile" title="Link to this heading">#</a></h3> </section> <section id="objective-s"> <h3>Objective-S<a class="headerlink" href="#objective-s" title="Link to this heading">#</a></h3> </section> </section> </section> </article> <footer class="prev-next-footer d-print-none"> <div class="prev-next-area"> <a class="left-prev" href="../Manuals/index.html" title="previous page"> <i class="fa-solid fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Manuals</p> </div> </a> <a class="right-next" href="Base/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">GNUstep Base</p> </div> <i class="fa-solid fa-angle-right"></i> </a> </div> </footer> </div> <dialog id="pst-secondary-sidebar-modal"></dialog> <div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> <div class="sidebar-secondary-item"> <div id="pst-page-navigation-heading-2" class="page-toc tocsection onthispage"> <i class="fa-solid fa-list"></i> On this page </div> <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#core-gnustep-frameworks">Core GNUstep frameworks</a></li> <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#other-gnustep-and-gap-frameworks">Other GNUstep and GAP frameworks</a></li> <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#third-party-frameworks">Third-party frameworks</a><ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#etoile">脡toil茅</a></li> <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#objective-s">Objective-S</a></li> </ul> </li> </ul> </nav></div> <div class="sidebar-secondary-item"> <div class="tocsection sourcelink"> <a href="../_sources/APIRefs/index.md.txt"> <i class="fa-solid fa-file-lines"></i> Show Source </a> </div> </div> </div></div> </div> <footer class="bd-footer-content"> </footer> </main> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script defer src="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script> <script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script> <footer class="bd-footer"> <div class="bd-footer__inner bd-page-width"> <div class="footer-items__start"> <div class="footer-item"> <p class="copyright"> 漏 Copyright 2024, GNUstep contributors. <br/> </p> </div> <div class="footer-item"> <p class="sphinx-version"> Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3. <br/> </p> </div> </div> <div class="footer-items__end"> <div class="footer-item"> <p class="theme-version"> Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0. </p></div> </div> </div> </footer> </body> </html>