![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
#include <FXRuler.h>
The ruler widget is placed alongside a document to measure position and size of entities within the document, such as margins, paragraph indents, and tickmarks.
The ruler widget sends a SEL_CHANGED when the indentation or margins are interactively changed by the user. If the document size exceeds the available space, it is possible to scroll the document using setPosition(). When the document size is less than the available space, the alignment options can be used to center, left-adjust, or right-adjust the document. Finally, a special option exists to stretch the document to the available space, that is to say, the document will always be fitten with given left and right edges substracted from the available space.
See also:
FX::FXRuler::FXRuler | ( | FXComposite * | p, |
FXObject * | tgt = NULL , |
||
FXSelector | sel = 0 , |
||
FXuint | opts = RULER_NORMAL , |
||
FXint | x = 0 , |
||
FXint | y = 0 , |
||
FXint | w = 0 , |
||
FXint | h = 0 , |
||
FXint | pl = DEFAULT_PAD , |
||
FXint | pr = DEFAULT_PAD , |
||
FXint | pt = DEFAULT_PAD , |
||
FXint | pb = DEFAULT_PAD |
||
) |
Construct label with given text and icon.
virtual FX::FXRuler::~FXRuler | ( | ) | [virtual] |
Destructor.
virtual void FX::FXRuler::layout | ( | ) | [virtual] |
Perform layout.
Reimplemented from FX::FXWindow.
virtual void FX::FXRuler::create | ( | ) | [virtual] |
Create server-side resources.
Reimplemented from FX::FXWindow.
virtual void FX::FXRuler::detach | ( | ) | [virtual] |
Detach server-side resources.
Reimplemented from FX::FXWindow.
virtual FXint FX::FXRuler::getDefaultWidth | ( | ) | [virtual] |
Return default width.
Reimplemented from FX::FXFrame.
virtual FXint FX::FXRuler::getDefaultHeight | ( | ) | [virtual] |
Return default height.
Reimplemented from FX::FXFrame.
void FX::FXRuler::setPosition | ( | FXint | pos, |
FXbool | notify = FALSE |
||
) |
Set the current position.
FXint FX::FXRuler::getPosition | ( | ) | const [inline] |
Return the current position.
void FX::FXRuler::setContentSize | ( | FXint | size, |
FXbool | notify = FALSE |
||
) |
Change/return content size.
FXint FX::FXRuler::getContentSize | ( | ) | const |
FXint FX::FXRuler::getDocumentLower | ( | ) | const |
Get lower edge of document.
FXint FX::FXRuler::getDocumentUpper | ( | ) | const |
Get upper edge of document.
void FX::FXRuler::setDocumentSize | ( | FXint | size, |
FXbool | notify = FALSE |
||
) |
Change/return document size.
FXint FX::FXRuler::getDocumentSize | ( | ) | const [inline] |
void FX::FXRuler::setEdgeSpacing | ( | FXint | space, |
FXbool | notify = FALSE |
||
) |
Change/return document edge spacing.
FXint FX::FXRuler::getEdgeSpacing | ( | ) | const [inline] |
void FX::FXRuler::setMarginLower | ( | FXint | mgn, |
FXbool | notify = FALSE |
||
) |
Change/return lower document margin.
FXint FX::FXRuler::getMarginLower | ( | ) | const [inline] |
void FX::FXRuler::setMarginUpper | ( | FXint | mgn, |
FXbool | notify = FALSE |
||
) |
Change/return upper document margin.
FXint FX::FXRuler::getMarginUpper | ( | ) | const [inline] |
void FX::FXRuler::setIndentFirst | ( | FXint | ind, |
FXbool | notify = FALSE |
||
) |
Change/return first line indent.
FXint FX::FXRuler::getIndentFirst | ( | ) | const [inline] |
void FX::FXRuler::setIndentLower | ( | FXint | ind, |
FXbool | notify = FALSE |
||
) |
Change/return lower indent.
FXint FX::FXRuler::getIndentLower | ( | ) | const [inline] |
void FX::FXRuler::setIndentUpper | ( | FXint | ind, |
FXbool | notify = FALSE |
||
) |
Change/return upper indent.
FXint FX::FXRuler::getIndentUpper | ( | ) | const [inline] |
void FX::FXRuler::setNumberTicks | ( | FXint | ticks, |
FXbool | notify = FALSE |
||
) |
Change/return document number placement.
FXint FX::FXRuler::getNumberTicks | ( | ) | const [inline] |
void FX::FXRuler::setMajorTicks | ( | FXint | ticks, |
FXbool | notify = FALSE |
||
) |
Change/return document major ticks.
FXint FX::FXRuler::getMajorTicks | ( | ) | const [inline] |
void FX::FXRuler::setMediumTicks | ( | FXint | ticks, |
FXbool | notify = FALSE |
||
) |
Change/return document medium ticks.
FXint FX::FXRuler::getMediumTicks | ( | ) | const [inline] |
void FX::FXRuler::setTinyTicks | ( | FXint | ticks, |
FXbool | notify = FALSE |
||
) |
Change/return document tiny ticks.
FXint FX::FXRuler::getTinyTicks | ( | ) | const [inline] |
void FX::FXRuler::setPixelPerTick | ( | FXdouble | space, |
FXbool | notify = FALSE |
||
) |
Change/return pixel per tick spacing.
FXdouble FX::FXRuler::getPixelPerTick | ( | ) | const [inline] |
void FX::FXRuler::setFont | ( | FXFont * | fnt, |
FXbool | notify = FALSE |
||
) |
Set the text font.
FXFont* FX::FXRuler::getFont | ( | ) | const [inline] |
Get the text font.
void FX::FXRuler::setValue | ( | FXint | value | ) |
Change arrow value, relative to document position.
FXint FX::FXRuler::getValue | ( | ) | const [inline] |
Return arrow value in document.
void FX::FXRuler::setRulerStyle | ( | FXuint | style | ) |
Set ruler style.
FXuint FX::FXRuler::getRulerStyle | ( | ) | const |
Get ruler style.
void FX::FXRuler::setRulerAlignment | ( | FXuint | alignment, |
FXbool | notify = FALSE |
||
) |
Set ruler alignment.
FXuint FX::FXRuler::getRulerAlignment | ( | ) | const |
Get ruler alignment.
FXColor FX::FXRuler::getTextColor | ( | ) | const [inline] |
Get the current text color.
void FX::FXRuler::setTextColor | ( | FXColor | clr | ) |
Set the current text color.
void FX::FXRuler::setHelpText | ( | const FXString & | text | ) | [inline] |
Set the status line help text for the ruler.
const FXString& FX::FXRuler::getHelpText | ( | ) | const [inline] |
Get the status line help text for the ruler.
void FX::FXRuler::setTipText | ( | const FXString & | text | ) | [inline] |
Set the tool tip message for the ruler.
const FXString& FX::FXRuler::getTipText | ( | ) | const [inline] |
Get the tool tip message for the ruler.
virtual void FX::FXRuler::save | ( | FXStream & | store | ) | const [virtual] |
Save label to a stream.
Reimplemented from FX::FXFrame.
virtual void FX::FXRuler::load | ( | FXStream & | store | ) | [virtual] |
Load label from a stream.
Reimplemented from FX::FXFrame.
![]() |