summaryrefslogtreecommitdiff
path: root/doc/fl_browser_.html
diff options
context:
space:
mode:
authorJedidiah Barber <contact@jedbarber.id.au>2024-12-11 17:25:21 +1300
committerJedidiah Barber <contact@jedbarber.id.au>2024-12-11 17:25:21 +1300
commit86a0894a1c54e69ae56e147cc943893194664304 (patch)
tree42a91282fa5d48c1ad2d390691ae175aa761ce90 /doc/fl_browser_.html
parent24781de8bedb3bf4d12d7ec1d0307842e59a3f94 (diff)
Abstract_Browser now Browser, slight tweaks to Select and Sort subprograms
Diffstat (limited to 'doc/fl_browser_.html')
-rw-r--r--doc/fl_browser_.html140
1 files changed, 78 insertions, 62 deletions
diff --git a/doc/fl_browser_.html b/doc/fl_browser_.html
index 8c98c56..0f8c5fa 100644
--- a/doc/fl_browser_.html
+++ b/doc/fl_browser_.html
@@ -27,8 +27,9 @@
</table>
<p><b>Note:</b><br /><br />
-As the name suggests, you will likely never actually touch Abstract_Browser directly.
-Only through using or creating types derived from it.</p>
+This Browser type should really be abstract but cannot be for technical binding reasons.
+If you try to use it directly you will get exceptions. Either extend it or use types
+already extended from it.</p>
@@ -37,12 +38,12 @@ Only through using or creating types derived from it.</p>
<tr>
<td>Fl_Browser_</td>
- <td>Abstract_Browser</td>
+ <td>Browser</td>
</tr>
<tr>
<td>&nbsp;</td>
- <td>Abstract_Browser_Reference</td>
+ <td>Browser_Reference</td>
</tr>
<tr>
@@ -73,7 +74,7 @@ Fl_Scrollbar hscrollbar;
</pre></td>
<td><pre>
function H_Bar
- (This : in out Abstract_Browser)
+ (This : in out Browser)
return Valuators.Sliders.Scrollbars.Scrollbar_Reference;
</pre></td>
</tr>
@@ -84,7 +85,7 @@ Fl_Scrollbar scrollbar;
</pre></td>
<td><pre>
function V_Bar
- (This : in out Abstract_Browser)
+ (This : in out Browser)
return Valuators.Sliders.Scrollbars.Scrollbar_Reference;
</pre></td>
</tr>
@@ -104,7 +105,7 @@ Fl_Browser_(int X, int Y, int W, int H, const char *L=0);
function Create
(X, Y, W, H : in Integer;
Text : in String := "")
- return Abstract_Browser;
+ return Browser;
</pre></td>
</tr>
@@ -121,9 +122,13 @@ int deselect(int docallbacks=0);
</pre></td>
<td><pre>
function Deselect
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Do_Callbacks : in Boolean := False)
return Boolean;
+
+procedure Deselect
+ (This : in out Browser;
+ Do_Callbacks : in Boolean := False);
</pre></td>
</tr>
@@ -133,7 +138,7 @@ void display(void *item);
</pre></td>
<td><pre>
procedure Display
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Item : in Item_Cursor);
</pre></td>
</tr>
@@ -144,7 +149,7 @@ int handle(int event);
</pre></td>
<td><pre>
function Handle
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Event : in Event_Kind)
return Event_Outcome;
</pre></td>
@@ -156,7 +161,7 @@ uchar has_scrollbar() const;
</pre></td>
<td><pre>
function Get_Scrollbar_Mode
- (This : in Abstract_Browser)
+ (This : in Browser)
return Scrollbar_Mode;
</pre></td>
</tr>
@@ -167,7 +172,7 @@ void has_scrollbar(uchar mode);
</pre></td>
<td><pre>
procedure Set_Scrollbar_Mode
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Mode : in Scrollbar_Mode);
</pre></td>
</tr>
@@ -178,7 +183,7 @@ int hposition() const;
</pre></td>
<td><pre>
function Get_H_Position
- (This : in Abstract_Browser)
+ (This : in Browser)
return Integer;
</pre></td>
</tr>
@@ -189,7 +194,7 @@ void hposition(int);
</pre></td>
<td><pre>
procedure Set_H_Position
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Value : in Integer);
</pre></td>
</tr>
@@ -200,7 +205,7 @@ int position() const;
</pre></td>
<td><pre>
function Get_V_Position
- (This : in Abstract_Browser)
+ (This : in Browser)
return Integer;
</pre></td>
</tr>
@@ -211,7 +216,7 @@ void position(int pos);
</pre></td>
<td><pre>
procedure Set_V_Position
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Value : in Integer);
</pre></td>
</tr>
@@ -222,7 +227,7 @@ void resize(int X, int Y, int W, int H);
</pre></td>
<td><pre>
procedure Resize
- (This : in out Abstract_Browser;
+ (This : in out Browser;
X, Y, W, H : in Integer);
</pre></td>
</tr>
@@ -233,7 +238,7 @@ void scrollbar_left();
</pre></td>
<td><pre>
procedure Set_Vertical_Left
- (This : in out Abstract_Browser);
+ (This : in out Browser);
</pre></td>
</tr>
@@ -243,7 +248,7 @@ void scrollbar_right();
</pre></td>
<td><pre>
procedure Set_Vertical_Right
- (This : in out Abstract_Browser);
+ (This : in out Browser);
</pre></td>
</tr>
@@ -253,7 +258,7 @@ int scrollbar_size() const;
</pre></td>
<td><pre>
function Get_Scrollbar_Size
- (This : in Abstract_Browser)
+ (This : in Browser)
return Integer;
</pre></td>
</tr>
@@ -264,7 +269,7 @@ void scrollbar_size(int newSize);
</pre></td>
<td><pre>
procedure Set_Scrollbar_Size
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Value : in Integer);
</pre></td>
</tr>
@@ -273,14 +278,14 @@ procedure Set_Scrollbar_Size
<td><pre>
int scrollbar_width() const;
</pre></td>
-<td>Deprecated, see scrollbar_size</td>
+<td>Deprecated, see scrollbar_size();</td>
</tr>
<tr>
<td><pre>
void scrollbar_width(int width);
</pre></td>
-<td>Deprecated, see scrollbar_size</td>
+<td>Deprecated, see scrollbar_size(int width);</td>
</tr>
<tr>
@@ -289,11 +294,17 @@ int select(void *item, int val=1, int docallbacks=0);
</pre></td>
<td><pre>
function Set_Select
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Item : in Item_Cursor;
State : in Boolean := True;
Do_Callbacks : in Boolean := False)
return Boolean;
+
+procedure Set_Select
+ (This : in out Browser;
+ Item : in Item_Cursor;
+ State : in Boolean := True;
+ Do_Callbacks : in Boolean := False);
</pre></td>
</tr>
@@ -303,10 +314,15 @@ int select_only(void *item, int docallbacks=0);
</pre></td>
<td><pre>
function Select_Only
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Item : in Item_Cursor;
Do_Callbacks : in Boolean := False)
return Boolean;
+
+procedure Select_Only
+ (This : in out Browser;
+ Item : in Item_Cursor;
+ Do_Callbacks : in Boolean := False);
</pre></td>
</tr>
@@ -316,7 +332,7 @@ void sort(int flags=0);
</pre></td>
<td><pre>
procedure Sort
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Order : in Sort_Order);
</pre></td>
</tr>
@@ -327,7 +343,7 @@ Fl_Color textcolor() const;
</pre></td>
<td><pre>
function Get_Text_Color
- (This : in Abstract_Browser)
+ (This : in Browser)
return Color;
</pre></td>
</tr>
@@ -338,7 +354,7 @@ void textcolor(Fl_Color col);
</pre></td>
<td><pre>
procedure Set_Text_Color
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Value : in Color);
</pre></td>
</tr>
@@ -349,7 +365,7 @@ Fl_Font textfont() const;
</pre></td>
<td><pre>
function Get_Text_Font
- (This : in Abstract_Browser)
+ (This : in Browser)
return Font_Kind;
</pre></td>
</tr>
@@ -360,7 +376,7 @@ void textfont(Fl_Font font);
</pre></td>
<td><pre>
procedure Set_Text_Font
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Font : in Font_Kind);
</pre></td>
</tr>
@@ -371,7 +387,7 @@ Fl_Fontsize textsize() const;
</pre></td>
<td><pre>
function Get_Text_Size
- (This : in Abstract_Browser)
+ (This : in Browser)
return Font_Size;
</pre></td>
</tr>
@@ -382,7 +398,7 @@ void textsize(Fl_Fontsize newSize);
</pre></td>
<td><pre>
procedure Set_Text_Size
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Size : in Font_Size);
</pre></td>
</tr>
@@ -400,7 +416,7 @@ void bbox(int &X, int &Y, int &W, int &H) const;
</pre></td>
<td><pre>
procedure Bounding_Box
- (This : in Abstract_Browser;
+ (This : in Browser;
X, Y, W, H : out Integer);
</pre></td>
</tr>
@@ -411,7 +427,7 @@ void deleting(void *item);
</pre></td>
<td><pre>
procedure Deleting
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Item : in Item_Cursor);
</pre></td>
</tr>
@@ -422,7 +438,7 @@ int displayed(void *item) const;
</pre></td>
<td><pre>
function Is_Displayed
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return Boolean;
</pre></td>
@@ -434,7 +450,7 @@ void draw();
</pre></td>
<td><pre>
procedure Draw
- (This : in out Abstract_Browser);
+ (This : in out Browser);
</pre></td>
</tr>
@@ -444,7 +460,7 @@ void * find_item(int ypos);
</pre></td>
<td><pre>
function Find_Item
- (This : in Abstract_Browser;
+ (This : in Browser;
Y_Pos : in Integer)
return Item_Cursor;
</pre></td>
@@ -456,7 +472,7 @@ virtual int full_height() const;
</pre></td>
<td><pre>
function Full_List_Height
- (This : in Abstract_Browser)
+ (This : in Browser)
return Integer;
</pre></td>
</tr>
@@ -467,7 +483,7 @@ virtual int full_width() const;
</pre></td>
<td><pre>
function Full_List_Width
- (This : in Abstract_Browser)
+ (This : in Browser)
return Integer;
</pre></td>
</tr>
@@ -478,7 +494,7 @@ virtual int incr_height() const;
</pre></td>
<td><pre>
function Average_Item_Height
- (This : in Abstract_Browser)
+ (This : in Browser)
return Integer;
</pre></td>
</tr>
@@ -489,7 +505,7 @@ void inserting(void *a, void *b);
</pre></td>
<td><pre>
procedure Inserting
- (This : in out Abstract_Browser;
+ (This : in out Browser;
A, B : in Item_Cursor);
</pre></td>
</tr>
@@ -500,7 +516,7 @@ virtual void * item_at(int index) const;
</pre></td>
<td><pre>
function Item_At
- (This : in Abstract_Browser;
+ (This : in Browser;
Index : in Positive)
return Item_Cursor;
</pre></td>
@@ -513,7 +529,7 @@ virtual void item_draw(void *item,
</pre></td>
<td><pre>
procedure Item_Draw
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor;
X, Y, W, H : in Integer);
</pre></td>
@@ -525,7 +541,7 @@ virtual void * item_first() const =0;
</pre></td>
<td><pre>
function Item_First
- (This : in Abstract_Browser)
+ (This : in Browser)
return Item_Cursor;
</pre></td>
</tr>
@@ -536,7 +552,7 @@ virtual int item_height(void *item) const =0;
</pre></td>
<td><pre>
function Item_Height
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return Integer;
</pre></td>
@@ -548,7 +564,7 @@ virtual void * item_last() const;
</pre></td>
<td><pre>
function Item_Last
- (This : in Abstract_Browser)
+ (This : in Browser)
return Item_Cursor;
</pre></td>
</tr>
@@ -559,7 +575,7 @@ virtual void * item_next(void *item) const =0;
</pre></td>
<td><pre>
function Item_Next
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return Item_Cursor;
</pre></td>
@@ -571,7 +587,7 @@ virtual void * item_prev(void *item) const =0;
</pre></td>
<td><pre>
function Item_Previous
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return Item_Cursor;
</pre></td>
@@ -583,7 +599,7 @@ virtual int item_quick_height(void *item) const;
</pre></td>
<td><pre>
function Item_Quick_Height
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return Integer;
</pre></td>
@@ -595,7 +611,7 @@ virtual void item_select(void *item, int val=1);
</pre></td>
<td><pre>
procedure Item_Select
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Item : in Item_Cursor;
State : in Boolean := True);
</pre></td>
@@ -607,7 +623,7 @@ virtual int item_selected(void *item) const;
</pre></td>
<td><pre>
function Item_Selected
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return Boolean;
</pre></td>
@@ -619,7 +635,7 @@ virtual void item_swap(void *a, void *b);
</pre></td>
<td><pre>
procedure Item_Swap
- (This : in out Abstract_Browser;
+ (This : in out Browser;
A, B : in Item_Cursor);
</pre></td>
</tr>
@@ -630,7 +646,7 @@ virtual const char * item_text(void *item) const;
</pre></td>
<td><pre>
function Item_Text
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return String;
</pre></td>
@@ -642,7 +658,7 @@ virtual int item_width(void *item) const =0;
</pre></td>
<td><pre>
function Item_Width
- (This : in Abstract_Browser;
+ (This : in Browser;
Item : in Item_Cursor)
return Integer;
</pre></td>
@@ -654,7 +670,7 @@ int leftedge() const;
</pre></td>
<td><pre>
function Left_Edge
- (This : in Abstract_Browser)
+ (This : in Browser)
return Integer;
</pre></td>
</tr>
@@ -665,7 +681,7 @@ void new_list();
</pre></td>
<td><pre>
procedure New_List
- (This : in out Abstract_Browser);
+ (This : in out Browser);
</pre></td>
</tr>
@@ -675,7 +691,7 @@ void redraw_line(void *item);
</pre></td>
<td><pre>
procedure Redraw_Line
- (This : in out Abstract_Browser;
+ (This : in out Browser;
Item : in Item_Cursor);
</pre></td>
</tr>
@@ -686,7 +702,7 @@ void redraw_lines();
</pre></td>
<td><pre>
procedure Redraw_List
- (This : in out Abstract_Browser);
+ (This : in out Browser);
</pre></td>
</tr>
@@ -696,7 +712,7 @@ void replacing(void *a, void *b);
</pre></td>
<td><pre>
procedure Replacing
- (This : in out Abstract_Browser;
+ (This : in out Browser;
A, B : in Item_Cursor);
</pre></td>
</tr>
@@ -707,7 +723,7 @@ void * selection() const;
</pre></td>
<td><pre>
function Current_Selection
- (This : in Abstract_Browser)
+ (This : in Browser)
return Item_Cursor;
</pre></td>
</tr>
@@ -718,7 +734,7 @@ void swapping(void *a, void *b);
</pre></td>
<td><pre>
procedure Swapping
- (This : in out Abstract_Browser;
+ (This : in out Browser;
A, B : in Item_Cursor);
</pre></td>
</tr>
@@ -729,7 +745,7 @@ void * top() const;
</pre></td>
<td><pre>
function Top_Item
- (This : in Abstract_Browser)
+ (This : in Browser)
return Item_Cursor;
</pre></td>
</tr>