Auto-updated documentation based on tag v2.10.11

shotgunsoftware · Jan 22, 2024 · bf190ee · bf190ee
1 parent 0345ab7
commit bf190ee
Show file tree

Hide file tree

Showing 111 changed files with 261 additions and 261 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7c435e2ed251f1842cbe6ab8f3896d6c
+config: 35422e7af9792aea55f9ad199a395557
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/activity_stream.doctree b/.doctrees/activity_stream.doctree
diff --git a/.doctrees/context_widget.doctree b/.doctrees/context_widget.doctree
diff --git a/.doctrees/delegates.doctree b/.doctrees/delegates.doctree
diff --git a/.doctrees/elided_label.doctree b/.doctrees/elided_label.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/filtering.doctree b/.doctrees/filtering.doctree
diff --git a/.doctrees/help_screen.doctree b/.doctrees/help_screen.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/models.doctree b/.doctrees/models.doctree
diff --git a/.doctrees/navigation.doctree b/.doctrees/navigation.doctree
diff --git a/.doctrees/note_input_widget.doctree b/.doctrees/note_input_widget.doctree
diff --git a/.doctrees/overlay_widget.doctree b/.doctrees/overlay_widget.doctree
diff --git a/.doctrees/playback_label.doctree b/.doctrees/playback_label.doctree
diff --git a/.doctrees/screen_grab.doctree b/.doctrees/screen_grab.doctree
diff --git a/.doctrees/search_completer.doctree b/.doctrees/search_completer.doctree
diff --git a/.doctrees/shotgun_fields.doctree b/.doctrees/shotgun_fields.doctree
diff --git a/.doctrees/shotgun_menus.doctree b/.doctrees/shotgun_menus.doctree
diff --git a/.doctrees/shotgun_search_widget.doctree b/.doctrees/shotgun_search_widget.doctree
diff --git a/.doctrees/shotgun_widget.doctree b/.doctrees/shotgun_widget.doctree
diff --git a/.doctrees/spinner_widget.doctree b/.doctrees/spinner_widget.doctree
diff --git a/.doctrees/version_details.doctree b/.doctrees/version_details.doctree
diff --git a/.doctrees/views.doctree b/.doctrees/views.doctree
diff --git a/_modules/activity_stream/activity_stream.html b/_modules/activity_stream/activity_stream.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>activity_stream.activity_stream &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>activity_stream.activity_stream &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -1341,7 +1341,7 @@ <h1>Source code for activity_stream.activity_stream</h1><div class="highlight"><
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/activity_stream/reply_list.html b/_modules/activity_stream/reply_list.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>activity_stream.reply_list &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>activity_stream.reply_list &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -624,7 +624,7 @@ <h1>Source code for activity_stream.reply_list</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/context_selector/context_widget.html b/_modules/context_selector/context_widget.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>context_selector.context_widget &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>context_selector.context_widget &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -1175,7 +1175,7 @@ <h1>Source code for context_selector.context_widget</h1><div class="highlight"><
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/delegates/thumbnail_view_item_delegate.html b/_modules/delegates/thumbnail_view_item_delegate.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>delegates.thumbnail_view_item_delegate &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>delegates.thumbnail_view_item_delegate &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -361,7 +361,7 @@ <h1>Source code for delegates.thumbnail_view_item_delegate</h1><div class="highl
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/delegates/view_item_delegate.html b/_modules/delegates/view_item_delegate.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>delegates.view_item_delegate &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>delegates.view_item_delegate &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -3887,7 +3887,7 @@ <h1>Source code for delegates.view_item_delegate</h1><div class="highlight"><pre
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/elided_label/elided_label.html b/_modules/elided_label/elided_label.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>elided_label.elided_label &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>elided_label.elided_label &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -371,7 +371,7 @@ <h1>Source code for elided_label.elided_label</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/filtering/filter_item.html b/_modules/filtering/filter_item.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>filtering.filter_item &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>filtering.filter_item &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -1170,7 +1170,7 @@ <h1>Source code for filtering.filter_item</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/filtering/filter_item_proxy_model.html b/_modules/filtering/filter_item_proxy_model.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>filtering.filter_item_proxy_model &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>filtering.filter_item_proxy_model &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -245,7 +245,7 @@ <h1>Source code for filtering.filter_item_proxy_model</h1><div class="highlight"
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/filtering/filter_item_tree_proxy_model.html b/_modules/filtering/filter_item_tree_proxy_model.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>filtering.filter_item_tree_proxy_model &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>filtering.filter_item_tree_proxy_model &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -250,7 +250,7 @@ <h1>Source code for filtering.filter_item_tree_proxy_model</h1><div class="highl
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/filtering/filter_menu.html b/_modules/filtering/filter_menu.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>filtering.filter_menu &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>filtering.filter_menu &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -1284,7 +1284,7 @@ <h1>Source code for filtering.filter_menu</h1><div class="highlight"><pre>
 <span class="sd">        :return: The field id that the search filter item widget refers to.</span>
 <span class="sd">        :rtype: str</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;</span><span class="si">{}</span><span class="s2">$&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">SearchFilterItemWidget</span><span class="p">)),</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">filter_id</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;.</span><span class="si">{}</span><span class="s2">$&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">SearchFilterItemWidget</span><span class="p">)),</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">filter_id</span><span class="p">)</span>
 
     <span class="k">def</span> <span class="nf">_get_filter_group_items</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_id</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
@@ -1614,7 +1614,7 @@ <h1>Source code for filtering.filter_menu</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/filtering/filter_menu_button.html b/_modules/filtering/filter_menu_button.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>filtering.filter_menu_button &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>filtering.filter_menu_button &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -295,7 +295,7 @@ <h1>Source code for filtering.filter_menu_button</h1><div class="highlight"><pre
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/help_screen/dialog.html b/_modules/help_screen/dialog.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>help_screen.dialog &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>help_screen.dialog &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -376,7 +376,7 @@ <h1>Source code for help_screen.dialog</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/index.html b/_modules/index.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>Overview: module code &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -211,7 +211,7 @@ <h1>All modules for which code is available</h1>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>
 
 

diff --git a/_modules/models/hierarchical_filtering_proxy_model.html b/_modules/models/hierarchical_filtering_proxy_model.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>models.hierarchical_filtering_proxy_model &mdash; tk-framework-qtwidgets v2.10.10 documentation</title>
+  <title>models.hierarchical_filtering_proxy_model &mdash; tk-framework-qtwidgets v2.10.11 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -97,7 +97,7 @@
                              text-decoration: underline; }
     </style>
 
-    <b>tk-framework-qtwidgets</b> v2.10.10.<br>
+    <b>tk-framework-qtwidgets</b> v2.10.11.<br>
 
         This documentation is part of the ShotGrid Pipeline Toolkit.
 
@@ -656,7 +656,7 @@ <h1>Source code for models.hierarchical_filtering_proxy_model</h1><div class="hi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, Autodesk.</p>
+    <p>&#169; Copyright 2024, Autodesk.</p>
   </div>