diff options
Diffstat (limited to 'doc/man/man3/tqscrollview.3qt')
| -rw-r--r-- | doc/man/man3/tqscrollview.3qt | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/doc/man/man3/tqscrollview.3qt b/doc/man/man3/tqscrollview.3qt index 0c4c24fc4..d35c61ebf 100644 --- a/doc/man/man3/tqscrollview.3qt +++ b/doc/man/man3/tqscrollview.3qt @@ -51,7 +51,7 @@ Inherited by TQCanvasView, TQTable, TQGridView, TQIconView, TQListBox, TQListVie .BI "bool childIsVisible ( TQWidget * child ) \fI(obsolete)\fR" .br .ti -1c -.BI "void showChild ( TQWidget * child, bool y = TRUE ) \fI(obsolete)\fR" +.BI "void showChild ( TQWidget * child, bool y = true ) \fI(obsolete)\fR" .br .ti -1c .BI "enum \fBScrollBarMode\fR { Auto, AlwaysOff, AlwaysOn }" @@ -114,13 +114,13 @@ Inherited by TQCanvasView, TQTable, TQGridView, TQIconView, TQListBox, TQListVie .BI "void \fBupdateContents\fR ()" .br .ti -1c -.BI "void \fBrepaintContents\fR ( int x, int y, int w, int h, bool erase = TRUE )" +.BI "void \fBrepaintContents\fR ( int x, int y, int w, int h, bool erase = true )" .br .ti -1c -.BI "void \fBrepaintContents\fR ( const TQRect & r, bool erase = TRUE )" +.BI "void \fBrepaintContents\fR ( const TQRect & r, bool erase = true )" .br .ti -1c -.BI "void \fBrepaintContents\fR ( bool erase = TRUE )" +.BI "void \fBrepaintContents\fR ( bool erase = true )" .br .ti -1c .BI "void \fBcontentsToViewport\fR ( int x, int y, int & vx, int & vy ) const" @@ -381,13 +381,13 @@ Here, the TQScrollView has the same four children: the viewport(), the verticalS .PP </center> .PP -The final usage of TQScrollView (depicted above) is appropriate when many widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You then call enableClipper(TRUE) and add widgets, again by making them children of the viewport(), and adding them with addChild(): +The final usage of TQScrollView (depicted above) is appropriate when many widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You then call enableClipper(true) and add widgets, again by making them children of the viewport(), and adding them with addChild(): .PP .nf .br TQScrollView* sv = new TQScrollView(...); .br - sv->enableClipper(TRUE); + sv->enableClipper(true); .br TQLabel* child1 = new TQLabel("CHILD", sv->viewport()); .br @@ -407,9 +407,9 @@ Here, the TQScrollView has four children: the clipper() (not the viewport() this .SH "Details Relevant for All Views" Normally you will use the first or third method if you want any child widgets in the view. .PP -Note that the widget you see in the scrolled area is the viewport() widget, not the TQScrollView itself. So to turn mouse tracking on, for example, use viewport()->setMouseTracking(TRUE). +Note that the widget you see in the scrolled area is the viewport() widget, not the TQScrollView itself. So to turn mouse tracking on, for example, use viewport()->setMouseTracking(true). .PP -To enable drag-and-drop, you would setAcceptDrops(TRUE) on the TQScrollView (because drag-and-drop events propagate to the parent). But to work out the logical position in the view, you would need to map the drop co-ordinate from being relative to the TQScrollView to being relative to the contents; use the function viewportToContents() for this. +To enable drag-and-drop, you would setAcceptDrops(true) on the TQScrollView (because drag-and-drop events propagate to the parent). But to work out the logical position in the view, you would need to map the drop co-ordinate from being relative to the TQScrollView to being relative to the contents; use the function viewportToContents() for this. .PP To handle mouse events on the scrolling area, subclass scrollview as you would subclass other widgets, but rather than reimplementing mousePressEvent(), reimplement contentsMousePressEvent() instead. The contents specific event handlers provide translated events in the coordinate system of the scrollview. If you reimplement mousePressEvent(), you'll get called only when part of the TQScrollView is clicked: and the only such part is the "corner" (if you don't set a cornerWidget()) and the frame; everything else is covered up by the viewport, clipper or scroll bars. .PP @@ -476,7 +476,7 @@ Destroys the TQScrollView. Any children added with addChild() will be deleted. .SH "void TQScrollView::addChild ( TQWidget * child, int x = 0, int y = 0 )\fC [virtual]\fR" Inserts the widget, \fIchild\fR, into the scrolled area positioned at (\fIx\fR, \fIy\fR). The position defaults to (0, 0). If the child is already in the view, it is just moved. .PP -You may want to call enableClipper(TRUE) if you add a large number of widgets. +You may want to call enableClipper(true) if you add a large number of widgets. .PP Example: scrollview/scrollview.cpp. .SH "int TQScrollView::bottomMargin () const\fC [protected]\fR" @@ -502,7 +502,7 @@ Margin 1.0 ensures that (x, y) is in the center of the the visible area. .SH "bool TQScrollView::childIsVisible ( TQWidget * child )" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP -Returns TRUE if \fIchild\fR is visible. This is equivalent to child->isVisible(). +Returns true if \fIchild\fR is visible. This is equivalent to child->isVisible(). .SH "int TQScrollView::childX ( TQWidget * child )" Returns the X position of the given \fIchild\fR widget. Use this rather than TQWidget::x() for widgets added to the view. .PP @@ -588,7 +588,7 @@ By default, no corner widget is present. .PP Example: scrollview/scrollview.cpp. .SH "bool TQScrollView::dragAutoScroll () const" -Returns TRUE if autoscrolling in drag move events is enabled; otherwise returns FALSE. See the "dragAutoScroll" property for details. +Returns true if autoscrolling in drag move events is enabled; otherwise returns false. See the "dragAutoScroll" property for details. .SH "void TQScrollView::drawContents ( TQPainter * p, int clipx, int clipy, int clipw, int cliph )\fC [virtual protected]\fR" Reimplement this function if you are viewing a drawing area rather than a widget. .PP @@ -643,7 +643,7 @@ The default implementation translates the painter appropriately and calls drawCo .PP Reimplemented in TQListView. .SH "void TQScrollView::enableClipper ( bool y )" -When a large numbers of child widgets are in a scrollview, especially if they are close together, the scrolling performance can suffer greatly. If \fIy\fR is TRUE the scrollview will use an extra widget to group child widgets. +When a large numbers of child widgets are in a scrollview, especially if they are close together, the scrolling performance can suffer greatly. If \fIy\fR is true the scrollview will use an extra widget to group child widgets. .PP Note that you may only call enableClipper() prior to adding widgets. .PP @@ -665,7 +665,7 @@ Reimplemented in TQListView. .SH "ScrollBarMode TQScrollView::hScrollBarMode () const" Returns the mode for the horizontal scroll bar. See the "hScrollBarMode" property for details. .SH "bool TQScrollView::hasStaticBackground () const" -Returns TRUE if TQScrollView uses a static background; otherwise returns FALSE. +Returns true if TQScrollView uses a static background; otherwise returns false. .PP See also setStaticBackground(). .SH "TQScrollBar * TQScrollView::horizontalScrollBar () const" @@ -679,9 +679,9 @@ This signal is emitted whenever the user presses the horizontal slider. .SH "void TQScrollView::horizontalSliderReleased ()\fC [signal]\fR" This signal is emitted whenever the user releases the horizontal slider. .SH "bool TQScrollView::isHorizontalSliderPressed ()" -Returns TRUE if horizontal slider is pressed by user; otherwise returns FALSE. +Returns true if horizontal slider is pressed by user; otherwise returns false. .SH "bool TQScrollView::isVerticalSliderPressed ()" -Returns TRUE if vertical slider is pressed by user; otherwise returns FALSE. +Returns true if vertical slider is pressed by user; otherwise returns false. .SH "int TQScrollView::leftMargin () const\fC [protected]\fR" Returns the left margin. .PP @@ -690,18 +690,18 @@ See also setMargins(). Repositions the \fIchild\fR widget to (\fIx\fR, \fIy\fR). This function is the same as addChild(). .SH "void TQScrollView::removeChild ( TQWidget * child )" Removes the \fIchild\fR widget from the scrolled area. Note that this happens automatically if the \fIchild\fR is deleted. -.SH "void TQScrollView::repaintContents ( int x, int y, int w, int h, bool erase = TRUE )" -Calls repaint() on a rectangle defined by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, translated appropriately. If the rectangle is not visible, nothing is repainted. If \fIerase\fR is TRUE the background is cleared using the background color. +.SH "void TQScrollView::repaintContents ( int x, int y, int w, int h, bool erase = true )" +Calls repaint() on a rectangle defined by \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, translated appropriately. If the rectangle is not visible, nothing is repainted. If \fIerase\fR is true the background is cleared using the background color. .PP See also updateContents(). -.SH "void TQScrollView::repaintContents ( const TQRect & r, bool erase = TRUE )" +.SH "void TQScrollView::repaintContents ( const TQRect & r, bool erase = true )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Repaints the contents of rectangle \fIr\fR. If \fIerase\fR is TRUE the background is cleared using the background color. -.SH "void TQScrollView::repaintContents ( bool erase = TRUE )" +Repaints the contents of rectangle \fIr\fR. If \fIerase\fR is true the background is cleared using the background color. +.SH "void TQScrollView::repaintContents ( bool erase = true )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Repaints the contents. If \fIerase\fR is TRUE the background is cleared using the background color. +Repaints the contents. If \fIerase\fR is true the background is cleared using the background color. .SH "void TQScrollView::resizeContents ( int w, int h )\fC [virtual slot]\fR" Sets the size of the contents area to \fIw\fR pixels wide and \fIh\fR pixels high and updates the viewport accordingly. .SH "ResizePolicy TQScrollView::resizePolicy () const" @@ -755,7 +755,7 @@ See also frameChanged(). .SH "void TQScrollView::setResizePolicy ( ResizePolicy )\fC [virtual]\fR" Sets the resize policy. See the "resizePolicy" property for details. .SH "void TQScrollView::setStaticBackground ( bool y )" -Sets the scrollview to have a static background if \fIy\fR is TRUE, or a scrolling background if \fIy\fR is FALSE. By default, the background is scrolling. +Sets the scrollview to have a static background if \fIy\fR is true, or a scrolling background if \fIy\fR is false. By default, the background is scrolling. .PP Be aware that this mode is quite slow, as a full repaint of the visible area has to be triggered on every contents move. .PP @@ -768,7 +768,7 @@ The default implementation simply gives all the space to \fIvbar\fR. The new geo See also setHBarGeometry(). .SH "void TQScrollView::setVScrollBarMode ( ScrollBarMode )\fC [virtual]\fR" Sets the mode for the vertical scroll bar. See the "vScrollBarMode" property for details. -.SH "void TQScrollView::showChild ( TQWidget * child, bool y = TRUE )" +.SH "void TQScrollView::showChild ( TQWidget * child, bool y = true )" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Sets the visibility of \fIchild\fR. Equivalent to TQWidget::show() or TQWidget::hide(). @@ -849,7 +849,7 @@ Get this property's value with contentsY(). .SH "bool dragAutoScroll" This property holds whether autoscrolling in drag move events is enabled. .PP -If this property is set to TRUE (the default), the TQScrollView automatically scrolls the contents in drag move events if the user moves the cursor close to a border of the view. Of course this works only if the viewport accepts drops. Specifying FALSE disables this autoscroll feature. +If this property is set to true (the default), the TQScrollView automatically scrolls the contents in drag move events if the user moves the cursor close to a border of the view. Of course this works only if the viewport accepts drops. Specifying false disables this autoscroll feature. .PP \fBWarning:\fR Enabling this property might not be enough to effectively turn on autoscrolling. If you put a custom widget in the TQScrollView, you might need to call TQDragEvent::ignore() on the event in the dragEnterEvent() and dragMoveEvent() reimplementations. .PP |