File indexing completed on 2024-05-12 03:53:40
0001 <!DOCTYPE html> 0002 <html lang="en"> 0003 <head> 0004 <meta charset="utf-8"> 0005 <meta http-equiv="X-UA-Compatible" content="IE=edge"> 0006 <meta name="viewport" content="width=device-width, initial-scale=1"> 0007 <title>{% block page_title %}{% endblock %}</title> 0008 <link rel="meta" href="https://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" /> 0009 <meta name="trademark" content="KDE e.V." /> 0010 <meta name="description" content="KDE products API documentation" /> 0011 <meta name="MSSmartTagsPreventParsing" content="true" /> 0012 <meta name="robots" content="all" /> 0013 <meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" /> 0014 {% if kapidox_version %} 0015 <meta name="generator" content="kapidox {{ kapidox_version }}" /> 0016 {% endif %} 0017 <link rel="shortcut icon" href="{{resources}}/favicon.ico" /> 0018 <link rel="icon" href="{{resources}}/favicon.ico" /> 0019 {% if doxygencss %} 0020 <link rel="stylesheet" type="text/css" href="{{doxygencss}}" /> 0021 {% endif %} 0022 <!-- CSS can be edited in https://invent.kde.org/websites/aether-sass --> 0023 <link href="https://cdn.kde.org/aether-devel/aether-docsy.css" rel="stylesheet"> 0024 <link href="https://cdn.kde.org/breeze-icons/icons.css" rel="stylesheet"> 0025 <link href="{{resources}}/css/customdoxygen.css" rel="stylesheet"> 0026 {% block head %}{% endblock %} 0027 <style> 0028 .td-content .header, #nav-path { 0029 display: none; 0030 } 0031 div.contents { 0032 margin-top: 0 !important; 0033 margin-right: 0 !important; 0034 margin-left: 0 !important; 0035 } 0036 </style> 0037 </head> 0038 0039 <body> 0040 <ul class="sr-only"> 0041 <li><a href="#cp-content" accesskey="2">Skip to content</a></li> 0042 <li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li> 0043 </ul> 0044 <div class="container-fluid td-outer"> 0045 <header class="header row"> 0046 <nav class="col-12 col-md-9 col-xl-8 offset-md-3 offset-xl-2 js-navbar-scroll navbar navbar-expand flex-column flex-md-row td-navbar"> 0047 <a class="navbar-brand kde-logo active d-none d-lg-flex" href="/">Developer</a> 0048 <div class="td-navbar-nav-scroll" id="main_navbar"> 0049 <ul class="navbar-nav"> 0050 <li class="nav-item"> 0051 <a class="nav-link kde-logo active d-lg-none d-flex active" href="/">API</a> 0052 </li> 0053 <li class="nav-item"> 0054 <a class="nav-link" href="https://develop.kde.org/docs/"><span>Documentation</span></a> 0055 </li> 0056 <li class="nav-item"> 0057 <a class="nav-link active" href="https://api.kde.org" target="_blank"><span class="active">API</span></a> 0058 </li> 0059 <li class="nav-item"> 0060 <a class="nav-link" href="https://develop.kde.org/hig/"><span>KDE Human Interface Guidelines</span></a> 0061 </li> 0062 </ul> 0063 </div> 0064 </nav> 0065 </header> 0066 <div class="td-main"> 0067 <div class="row flex-xl-nowrap"> 0068 <!-- left sidebar --> 0069 <div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none"> 0070 <div id="td-sidebar-menu" class="td-sidebar__inner"> 0071 <form action="search.html" method="get" class="td-sidebar__search d-flex p-2 pt-0 align-items-center"> 0072 <input type="text" id="SearchBox" name="query" aria-label="Search input" class="form-control" placeholder="Search..."></input> 0073 <button class="btn btn-link td-sidebar__toggle d-md-none p-0 m-0 ml-3 icon icon_application-menu" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" style="font-size: 1.5rem; height: 40px; width: 40px; border-width: 0" aria-label="Toggle section navigation"></button> 0074 </form> 0075 <div id="td-section-nav" class="td-sidebar-nav p-2 collapse"> 0076 {% block sidebar %}{% endblock %} 0077 </div> 0078 </div> 0079 </div> 0080 0081 <!-- right sidebar --> 0082 {% if fwinfo %} 0083 <div class="d-xl-block col-xl-2 td-toc d-print-none"> 0084 {% include "libinfo.html" %} 0085 </div> 0086 {% endif %} 0087 0088 <!-- main content --> 0089 <main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main"> 0090 <nav aria-label="breadcrumb" class="d-md-block d-print-none"> 0091 <!-- breadcrumb --> 0092 <ol class="breadcrumb spb-1"> 0093 {% for entry in breadcrumbs.entries %} 0094 <li class="breadcrumb-item"><a href="{{ entry.href }}">{{ entry.text }}</a></li> 0095 {% endfor %} 0096 </ol> 0097 </nav> 0098 0099 <!-- content --> 0100 <div class="td-content"> 0101 <h1 class="mt-2">{% block title %}{% endblock %}</h1> 0102 {% block content %}{% endblock %} 0103 </div> 0104 </main> 0105 </div> 0106 </div> 0107 <footer class="bg-dark py-4 row d-print-none"> 0108 <div class="container-fluid mx-sm-5"> 0109 {% include 'footer.html' %} 0110 <div id="footer-text" class="col-md-5 center-block text-white"> 0111 <p>Generated by <a href="https://api.kde.org/frameworks/kapidox/html/index.html">KApiDox</a>, a <a href="https://www.kde.org">KDE</a> product.</p> 0112 </div> 0113 </div> 0114 </footer> 0115 </div> 0116 0117 <script src="https://cdn.kde.org/aether-devel/bootstrap.js"></script> 0118 <script src="{{resources}}/js/main.js"></script> 0119 <script src="dynsections.js"></script> 0120 <script> 0121 document.querySelectorAll('h1, .dynheader, .el').forEach(h => { 0122 h.innerHTML = h.innerHTML.replace('org::kde::kirigami::templates::', 'Kirigami.<wbr>Templates.<wbr>'); 0123 h.innerHTML = h.innerHTML.replace('org::kde::kirigami::', 'Kirigami.<wbr>'); 0124 h.innerHTML = h.innerHTML.replace('org::kde::plasma::components::', 'PlasmaComponents2.<wbr>'); 0125 h.innerHTML = h.innerHTML.replace('org::kde::plasma::extras::', 'PlasmaExtras.<wbr>'); 0126 }); 0127 document.querySelectorAll('.memname, #class-picker option').forEach(h => { 0128 h.innerText = h.innerText.replace('org::kde::kirigami::templates::', 'Templates.'); 0129 h.innerText = h.innerText.replace('org::kde::kirigami::', ''); 0130 h.innerHTML = h.innerHTML.replace('org::kde::plasma::components::', 'PlasmaComponents2.<wbr>'); 0131 h.innerHTML = h.innerHTML.replace('org::kde::plasma::extras::', 'PlasmaExtras.<wbr>'); 0132 h.innerHTML = h.innerHTML.replace('org::kde::plasma::calendar::MonthView', 'MonthView.<wbr>'); 0133 }); 0134 </script> 0135 0136 {% block footer %} 0137 {% endblock %} 0138 0139 <!-- 0140 WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL 0141 BE BLOCKED INSTANTLY AND PERMANENTLY! 0142 <a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a> 0143 WARNING END 0144 --> 0145 0146 </body> 0147 </html>